Bug 1472338: part 1) Add Chrome tests for the async Clipboard API. r=NeilDeakin
[gecko.git] / widget / nsIGfxInfo.idl
bloba6e47005fce5fcd8f883f19c78bb346f01353d6b
1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
3 * This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
7 #include "nsISupports.idl"
9 /* NOTE: this interface is completely undesigned, not stable and likely to change */
10 [scriptable, builtinclass, uuid(1accd618-4c80-4703-9d29-ecf257d397c8)]
11 interface nsIGfxInfo : nsISupports
14 * These are win32-specific
16 readonly attribute boolean D2DEnabled;
17 readonly attribute boolean DWriteEnabled;
18 readonly attribute boolean EmbeddedInFirefoxReality;
19 readonly attribute AString AzureCanvasBackend;
20 readonly attribute AString AzureContentBackend;
21 readonly attribute boolean usingGPUProcess;
22 readonly attribute boolean hasBattery;
23 readonly attribute AString DWriteVersion;
24 readonly attribute AString cleartypeParameters;
27 * These are non-Android linux-specific
29 readonly attribute AString windowProtocol;
30 readonly attribute AString desktopEnvironment;
31 readonly attribute AString testType;
34 * These are valid across all platforms.
36 readonly attribute AString ContentBackend;
37 readonly attribute boolean WebRenderEnabled;
38 readonly attribute boolean isHeadless;
39 readonly attribute unsigned long TargetFrameRate;
41 // XXX: Switch to a list of devices, rather than explicitly numbering them.
43 /**
44 * The name of the display adapter.
46 readonly attribute AString adapterDescription;
47 readonly attribute AString adapterDescription2;
49 readonly attribute AString adapterDriver;
50 readonly attribute AString adapterDriver2;
52 /* These types are inspired by DXGI_ADAPTER_DESC */
53 readonly attribute AString adapterVendorID;
54 readonly attribute AString adapterVendorID2;
56 readonly attribute AString adapterDeviceID;
57 readonly attribute AString adapterDeviceID2;
59 readonly attribute AString adapterSubsysID;
60 readonly attribute AString adapterSubsysID2;
62 /**
63 * The amount of RAM in MB in the display adapter.
65 readonly attribute unsigned long adapterRAM;
66 readonly attribute unsigned long adapterRAM2;
68 readonly attribute AString adapterDriverVendor;
69 readonly attribute AString adapterDriverVendor2;
71 readonly attribute AString adapterDriverVersion;
72 readonly attribute AString adapterDriverVersion2;
74 readonly attribute AString adapterDriverDate;
75 readonly attribute AString adapterDriverDate2;
77 readonly attribute boolean isGPU2Active;
79 readonly attribute ACString drmRenderDevice;
81 /**
82 * Information about display devices
84 readonly attribute Array<AString> displayInfo;
85 readonly attribute Array<unsigned long> displayWidth;
86 readonly attribute Array<unsigned long> displayHeight;
88 /**
89 * Returns an array of objects describing each monitor. Guaranteed properties
90 * are "screenWidth" and "screenHeight". This is only implemented on Desktop.
92 * Windows additionally supplies "refreshRate" and "pseudoDisplay".
94 * OS X additionally supplies "scale".
96 [implicit_jscontext]
97 jsval getMonitors();
99 void refreshMonitors();
101 Array<ACString> getFailures(out Array<long> indices);
103 [noscript, notxpcom] void logFailure(in ACString failure);
105 * A set of constants for features that we can ask this GfxInfo object
106 * about via GetFeatureStatus
108 /* Don't assign any value <= 0 */
109 /* Values must be contiguous */
110 /* Whether Direct2D is supported for content rendering. */
111 const long FEATURE_DIRECT2D = 1;
112 /* Whether Direct3D 9 is supported for layers. */
113 const long FEATURE_DIRECT3D_9_LAYERS = 2;
114 /* Whether Direct3D 10.0 is supported for layers. */
115 const long FEATURE_DIRECT3D_10_LAYERS = 3;
116 /* Whether Direct3D 10.1 is supported for layers. */
117 const long FEATURE_DIRECT3D_10_1_LAYERS = 4;
118 /* Whether OpenGL is supported for layers */
119 const long FEATURE_OPENGL_LAYERS = 5;
120 /* Whether WebGL is supported via OpenGL. */
121 const long FEATURE_WEBGL_OPENGL = 6;
122 /* Whether WebGL is supported via ANGLE (D3D9 -- does not check for the presence of ANGLE libs). */
123 const long FEATURE_WEBGL_ANGLE = 7;
124 /* (Unused) Whether WebGL antialiasing is supported. */
125 const long UNUSED_FEATURE_WEBGL_MSAA = 8;
126 /* Whether Stagefright is supported, starting in 17. */
127 const long FEATURE_STAGEFRIGHT = 9;
128 /* Whether Webrtc Hardware H.264 acceleration is supported, starting in 71. */
129 const long FEATURE_WEBRTC_HW_ACCELERATION_H264 = 10;
130 /* Whether Direct3D 11 is supported for layers, starting in 32. */
131 const long FEATURE_DIRECT3D_11_LAYERS = 11;
132 /* Whether hardware accelerated video decoding is supported, starting in 36. */
133 const long FEATURE_HARDWARE_VIDEO_DECODING = 12;
134 /* Whether Direct3D 11 is supported for ANGLE, starting in 38. */
135 const long FEATURE_DIRECT3D_11_ANGLE = 13;
136 /* Whether Webrtc Hardware acceleration is supported, starting in 42. */
137 const long FEATURE_WEBRTC_HW_ACCELERATION_ENCODE = 14;
138 /* Whether Webrtc Hardware acceleration is supported, starting in 42. */
139 const long FEATURE_WEBRTC_HW_ACCELERATION_DECODE = 15;
140 /* Whether Canvas acceleration is supported, starting in 45 */
141 const long FEATURE_CANVAS2D_ACCELERATION = 16;
142 /* Whether hardware VP8 decoding is supported, starting in 48; not for downloadable blocking. */
143 const long FEATURE_VP8_HW_DECODE = 17;
144 /* Whether hardware VP9 decoding is supported, starting in 48; not for downloadable blocking. */
145 const long FEATURE_VP9_HW_DECODE = 18;
146 /* Whether NV_dx_interop2 is supported, starting in 50; downloadable blocking in 58. */
147 const long FEATURE_DX_INTEROP2 = 19;
148 /* Whether the GPU process is supported, starting in 52; downloadable blocking in 58. */
149 const long FEATURE_GPU_PROCESS = 20;
150 /* Whether the WebGL2 is supported, starting in 54 */
151 const long FEATURE_WEBGL2 = 21;
152 /* Whether D3D11 keyed mutex is supported, starting in 56 */
153 const long FEATURE_D3D11_KEYED_MUTEX = 22;
154 /* Whether WebRender is supported, starting in 62 */
155 const long FEATURE_WEBRENDER = 23;
156 /* Whether WebRender is supported, starting in 62 */
157 const long FEATURE_DX_NV12 = 24;
158 const long FEATURE_DX_P010 = 25;
159 const long FEATURE_DX_P016 = 26;
160 /* Whether OpenGL swizzle configuration of texture units is supported, starting in 70 */
161 const long FEATURE_GL_SWIZZLE = 27;
162 /* Whether WebRender native compositor is supported, starting in 73 */
163 const long FEATURE_WEBRENDER_COMPOSITOR = 28;
164 /* Whether WebRender can use scissored clears for cached surfaces, staring in 79 */
165 const long FEATURE_WEBRENDER_SCISSORED_CACHE_CLEARS = 29;
166 /* Support webgl.out-of-process: true (starting in 83) */
167 const long FEATURE_ALLOW_WEBGL_OUT_OF_PROCESS = 30;
168 /* Is OpenGL threadsafe (starting in 83) */
169 const long FEATURE_THREADSAFE_GL = 31;
170 /* Whether webrender uses pre-optimized shaders, starting in 87. */
171 const long FEATURE_WEBRENDER_OPTIMIZED_SHADERS = 32;
172 /* Whether we prefer EGL over GLX with X11, starting in 88. */
173 const long FEATURE_X11_EGL = 33;
174 /* Whether DMABUF is supported, starting in 88. */
175 const long FEATURE_DMABUF = 34;
176 /* Whether webrender caches shader program binaries to disk, starting in 89. */
177 const long FEATURE_WEBRENDER_SHADER_CACHE = 35;
178 /* Whether partial present is allowed with WebRender, starting in 98. */
179 const long FEATURE_WEBRENDER_PARTIAL_PRESENT = 36;
180 /* Whether VA-API is supported, starting in 96. */
181 const long FEATURE_VAAPI = 37;
182 /* the maximum feature value. */
183 const long FEATURE_MAX_VALUE = FEATURE_VAAPI;
186 * A set of return values from GetFeatureStatus
189 /* The driver is safe to the best of our knowledge */
190 const long FEATURE_STATUS_OK = 1;
191 /* We don't know the status of the feature yet. The analysis probably hasn't finished yet. */
192 const long FEATURE_STATUS_UNKNOWN = 2;
193 /* This feature is blocked on this driver version. Updating driver will typically unblock it. */
194 const long FEATURE_BLOCKED_DRIVER_VERSION = 3;
195 /* This feature is blocked on this device, regardless of driver version.
196 * Typically means we hit too many driver crashes without a good reason to hope for them to
197 * get fixed soon. */
198 const long FEATURE_BLOCKED_DEVICE = 4;
199 /* This feature is available and can be used, but is not suggested (e.g. shouldn't be used by default */
200 const long FEATURE_DISCOURAGED = 5;
201 /* This feature is blocked on this OS version. */
202 const long FEATURE_BLOCKED_OS_VERSION = 6;
203 /* This feature is blocked because of mismatched driver versions. */
204 const long FEATURE_BLOCKED_MISMATCHED_VERSION = 7;
205 /* This feature is blocked due to not being on the allowlist. */
206 const long FEATURE_DENIED = 8;
207 /* This feature is safe to be on this device due to the allowlist. */
208 const long FEATURE_ALLOW_ALWAYS = 9;
209 /* This feature is safe to be on this device due to the allowlist, depending on qualified/experiment status. */
210 const long FEATURE_ALLOW_QUALIFIED = 10;
213 * Ask about a feature, and return the status of that feature.
214 * If the feature is not ok then aFailureId will give a unique failure Id
215 * otherwise it will be empty.
217 long getFeatureStatus(in long aFeature, [optional] out ACString aFailureId);
220 * Ask about a feature, return the minimum driver version required for it if its status is
221 * FEATURE_BLOCKED_DRIVER_VERSION, otherwise return an empty string.
223 AString getFeatureSuggestedDriverVersion(in long aFeature);
225 // only useful on X11
226 [noscript, notxpcom] void GetData();
229 * Maximum refresh rate among detected monitors. -1 if unknown. aMixed is set
230 * to true if we know there are multiple displays and they have different
231 * refresh rates, else false.
233 [noscript, notxpcom] long GetMaxRefreshRate(out boolean aMixed);
235 [implicit_jscontext]
236 jsval getInfo();
238 // Return an object describing all features that have been configured:
240 // "features": [
241 // // For each feature:
242 // {
243 // "name": <string>,
244 // "description": <string>,
245 // "status": <string>,
246 // "log": [
247 // // One or more log entries, the first denotes the default value.
248 // {
249 // "type": <string>, // "base", "user", "env", or "runtime"
250 // "status": <string>,
251 // "message": <string> // Set unless type is "base" and status is "available".
252 // }
253 // ]
254 // }
255 // ]
256 // "fallbacks": [
257 // // For each workaround:
258 // {
259 // "name:" <string>,
260 // "description": <string>,
261 // "message": <string>
262 // ]
263 // }
265 // When a message is prefixed with a '#', it is a special status code. Status
266 // codes are unique identifiers that can be searched in the codebase to find
267 // which line of code caused the message. Some codes are standardized to
268 // improve about:support messaging:
270 // "[CONTEXT_]FEATURE_FAILURE_BUG_<number>"
271 // CONTEXT is optional and can currently only be "BLOCKLIST".
272 // <number> refers to a bug number in Bugzilla.
274 [implicit_jscontext]
275 jsval getFeatureLog();
277 // Returns an object containing information about graphics features. It is
278 // intended to be directly included into the Telemetry environment.
280 // "layers":
281 // {
282 // "compositor": "d3d9", "d3d11", "opengl", "basic", or "none"
283 // // ("none" indicates no compositors have been created)
284 // // Feature is one of "d3d9", "d3d11", "opengl", "basic", or "d2d".
285 // "<feature>": {
286 // // Each backend can have one of the following statuses:
287 // // "unused" - This feature has not been requested.
288 // // "unavailable" - OS version or restriction prevents use.
289 // // "blocked" - An internal condition (such as safe mode) prevents use.
290 // // "blocklisted" - Blocked due to a blocklist restriction.
291 // // "denied" - Blocked due to allowlist restrictions.
292 // // "disabled" - User explicitly disabled this default feature.
293 // // "failed" - Feature failed to initialize.
294 // // "available" - User has this feature available by default.
295 // "status": "<status>",
296 // "version": "<version>",
297 // "warp": true|false, // D3D11 only.
298 // "textureSharing": true|false, // D3D11 only.
299 // }
300 // }
301 [implicit_jscontext]
302 jsval getFeatures();
304 // Returns an array listing any active crash guards.
306 // [
307 // {
308 // // Type is one of "d3d11layers", or "glcontext".
309 // "type": "<identifier>",
311 // // Preference that must be deleted/reset to retrigger the guard.
312 // "prefName": "<preference>",
313 // }
314 // ]
315 [implicit_jscontext]
316 jsval getActiveCrashGuards();
318 // Forces the GPU process to start or shutdown. This is intended only for
319 // xpcshell-tests.
320 boolean controlGPUProcessForXPCShell(in boolean aEnable);
322 // Kills the GPU process cleanly, without generating a crash dump.
323 // This is intended only for use by tests.
324 void killGPUProcessForTests();
326 // Causes the GPU process to crash. This is intended only for use by tests.
327 void crashGPUProcessForTests();