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 usingGPUProcess
;
19 readonly attribute AString DWriteVersion
;
20 readonly attribute AString cleartypeParameters
;
23 * These are non-Android linux-specific
25 readonly attribute AString windowProtocol
;
28 * These are valid across all platforms.
30 readonly attribute AString ContentBackend
;
31 readonly attribute
boolean WebRenderEnabled
;
32 readonly attribute
boolean isHeadless
;
33 readonly attribute
boolean UsesTiling
;
34 readonly attribute
boolean ContentUsesTiling
;
35 readonly attribute
boolean OffMainThreadPaintEnabled
;
36 readonly attribute
long OffMainThreadPaintWorkerCount
;
37 readonly attribute
unsigned long TargetFrameRate
;
39 // XXX: Switch to a list of devices, rather than explicitly numbering them.
42 * The name of the display adapter.
44 readonly attribute AString adapterDescription
;
45 readonly attribute AString adapterDescription2
;
47 readonly attribute AString adapterDriver
;
48 readonly attribute AString adapterDriver2
;
50 /* These types are inspired by DXGI_ADAPTER_DESC */
51 readonly attribute AString adapterVendorID
;
52 readonly attribute AString adapterVendorID2
;
54 readonly attribute AString adapterDeviceID
;
55 readonly attribute AString adapterDeviceID2
;
57 readonly attribute AString adapterSubsysID
;
58 readonly attribute AString adapterSubsysID2
;
61 * The amount of RAM in MB in the display adapter.
63 readonly attribute
unsigned long adapterRAM
;
64 readonly attribute
unsigned long adapterRAM2
;
66 readonly attribute AString adapterDriverVendor
;
67 readonly attribute AString adapterDriverVendor2
;
69 readonly attribute AString adapterDriverVersion
;
70 readonly attribute AString adapterDriverVersion2
;
72 readonly attribute AString adapterDriverDate
;
73 readonly attribute AString adapterDriverDate2
;
75 readonly attribute
boolean isGPU2Active
;
78 * Information about display devices
80 readonly attribute Array
<AString
> displayInfo
;
81 readonly attribute Array
<unsigned long> displayWidth
;
82 readonly attribute Array
<unsigned long> displayHeight
;
85 * Returns an array of objects describing each monitor. Guaranteed properties
86 * are "screenWidth" and "screenHeight". This is only implemented on Desktop.
88 * Windows additionally supplies "refreshRate" and "pseudoDisplay".
90 * OS X additionally supplies "scale".
95 Array
<ACString
> getFailures
(out Array
<long> indices
);
97 [noscript
, notxpcom
] void logFailure
(in ACString failure
);
99 * A set of constants for features that we can ask this GfxInfo object
100 * about via GetFeatureStatus
102 /* Don't assign any value <= 0 */
103 /* Whether Direct2D is supported for content rendering. */
104 const long FEATURE_DIRECT2D
= 1;
105 /* Whether Direct3D 9 is supported for layers. */
106 const long FEATURE_DIRECT3D_9_LAYERS
= 2;
107 /* Whether Direct3D 10.0 is supported for layers. */
108 const long FEATURE_DIRECT3D_10_LAYERS
= 3;
109 /* Whether Direct3D 10.1 is supported for layers. */
110 const long FEATURE_DIRECT3D_10_1_LAYERS
= 4;
111 /* Whether OpenGL is supported for layers */
112 const long FEATURE_OPENGL_LAYERS
= 5;
113 /* Whether WebGL is supported via OpenGL. */
114 const long FEATURE_WEBGL_OPENGL
= 6;
115 /* Whether WebGL is supported via ANGLE (D3D9 -- does not check for the presence of ANGLE libs). */
116 const long FEATURE_WEBGL_ANGLE
= 7;
117 /* Whether WebGL antialiasing is supported. */
118 const long FEATURE_WEBGL_MSAA
= 8;
119 /* Whether Stagefright is supported, starting in 17. */
120 const long FEATURE_STAGEFRIGHT
= 9;
121 /* Whether Webrtc Hardware H.264 acceleration is supported, starting in 71. */
122 const long FEATURE_WEBRTC_HW_ACCELERATION_H264
= 10;
123 /* Whether Direct3D 11 is supported for layers, starting in 32. */
124 const long FEATURE_DIRECT3D_11_LAYERS
= 11;
125 /* Whether hardware accelerated video decoding is supported, starting in 36. */
126 const long FEATURE_HARDWARE_VIDEO_DECODING
= 12;
127 /* Whether Direct3D 11 is supported for ANGLE, starting in 38. */
128 const long FEATURE_DIRECT3D_11_ANGLE
= 13;
129 /* Whether Webrtc Hardware acceleration is supported, starting in 42. */
130 const long FEATURE_WEBRTC_HW_ACCELERATION_ENCODE
= 14;
131 /* Whether Webrtc Hardware acceleration is supported, starting in 42. */
132 const long FEATURE_WEBRTC_HW_ACCELERATION_DECODE
= 15;
133 /* Whether Canvas acceleration is supported, starting in 45 */
134 const long FEATURE_CANVAS2D_ACCELERATION
= 16;
135 /* Whether hardware VP8 decoding is supported, starting in 48; not for downloadable blocking. */
136 const long FEATURE_VP8_HW_DECODE
= 17;
137 /* Whether hardware VP9 decoding is supported, starting in 48; not for downloadable blocking. */
138 const long FEATURE_VP9_HW_DECODE
= 18;
139 /* Whether NV_dx_interop2 is supported, starting in 50; downloadable blocking in 58. */
140 const long FEATURE_DX_INTEROP2
= 19;
141 /* Whether the GPU process is supported, starting in 52; downloadable blocking in 58. */
142 const long FEATURE_GPU_PROCESS
= 20;
143 /* Whether the WebGL2 is supported, starting in 54 */
144 const long FEATURE_WEBGL2
= 21;
145 /* Whether Advanced Layers is supported, starting in 56 */
146 const long FEATURE_ADVANCED_LAYERS
= 22;
147 /* Whether D3D11 keyed mutex is supported, starting in 56 */
148 const long FEATURE_D3D11_KEYED_MUTEX
= 23;
149 /* Whether WebRender is supported, starting in 62 */
150 const long FEATURE_WEBRENDER
= 24;
151 /* Whether WebRender is supported, starting in 62 */
152 const long FEATURE_DX_NV12
= 25;
153 const long FEATURE_DX_P010
= 26;
154 const long FEATURE_DX_P016
= 27;
155 /* Whether OpenGL swizzle configuration of texture units is supported, starting in 70 */
156 const long FEATURE_GL_SWIZZLE
= 28;
157 /* Whether WebRender native compositor is supported, starting in 73 */
158 const long FEATURE_WEBRENDER_COMPOSITOR
= 29;
159 /* the maximum feature value. */
160 const long FEATURE_MAX_VALUE
= FEATURE_WEBRENDER_COMPOSITOR
;
163 * A set of return values from GetFeatureStatus
166 /* The driver is safe to the best of our knowledge */
167 const long FEATURE_STATUS_OK
= 1;
168 /* We don't know the status of the feature yet. The analysis probably hasn't finished yet. */
169 const long FEATURE_STATUS_UNKNOWN
= 2;
170 /* This feature is blocked on this driver version. Updating driver will typically unblock it. */
171 const long FEATURE_BLOCKED_DRIVER_VERSION
= 3;
172 /* This feature is blocked on this device, regardless of driver version.
173 * Typically means we hit too many driver crashes without a good reason to hope for them to
175 const long FEATURE_BLOCKED_DEVICE
= 4;
176 /* This feature is available and can be used, but is not suggested (e.g. shouldn't be used by default */
177 const long FEATURE_DISCOURAGED
= 5;
178 /* This feature is blocked on this OS version. */
179 const long FEATURE_BLOCKED_OS_VERSION
= 6;
180 /* This feature is blocked because of mismatched driver versions. */
181 const long FEATURE_BLOCKED_MISMATCHED_VERSION
= 7;
184 * Ask about a feature, and return the status of that feature.
185 * If the feature is not ok then aFailureId will give a unique failure Id
186 * otherwise it will be empty.
188 long getFeatureStatus
(in long aFeature
, [optional] out ACString aFailureId
);
191 * Ask about a feature, return the minimum driver version required for it if its status is
192 * FEATURE_BLOCKED_DRIVER_VERSION, otherwise return an empty string.
194 AString getFeatureSuggestedDriverVersion
(in long aFeature
);
196 // only useful on X11
197 [noscript
, notxpcom
] void GetData
();
202 // Return an object describing all features that have been configured:
205 // // For each feature:
208 // "description": <string>,
209 // "status": <string>,
211 // // One or more log entries, the first denotes the default value.
213 // "type": <string>, // "base", "user", "env", or "runtime"
214 // "status": <string>,
215 // "message": <string> // Set unless type is "base" and status is "available".
221 // // For each workaround:
224 // "description": <string>,
225 // "message": <string>
229 // When a message is prefixed with a '#', it is a special status code. Status
230 // codes are unique identifiers that can be searched in the codebase to find
231 // which line of code caused the message. Some codes are standardized to
232 // improve about:support messaging:
234 // "[CONTEXT_]FEATURE_FAILURE_BUG_<number>"
235 // CONTEXT is optional and can currently only be "BLOCKLIST".
236 // <number> refers to a bug number in Bugzilla.
239 jsval getFeatureLog
();
241 // Returns an object containing information about graphics features. It is
242 // intended to be directly included into the Telemetry environment.
246 // "compositor": "d3d9", "d3d11", "opengl", "basic", or "none"
247 // // ("none" indicates no compositors have been created)
248 // // Feature is one of "d3d9", "d3d11", "opengl", "basic", or "d2d".
250 // // Each backend can have one of the following statuses:
251 // // "unused" - This feature has not been requested.
252 // // "unavailable" - OS version or restriction prevents use.
253 // // "blocked" - An internal condition (such as safe mode) prevents use.
254 // // "blacklisted" - Blocked due to a blacklist restriction.
255 // // "disabled" - User explicitly disabled this default feature.
256 // // "failed" - Feature failed to initialize.
257 // // "available" - User has this feature available by default.
258 // "status": "<status>",
259 // "version": "<version>",
260 // "warp": true|false, // D3D11 only.
261 // "textureSharing": true|false, // D3D11 only.
267 // Returns an array listing any active crash guards.
271 // // Type is one of "d3d11layers", "d3d9video", "glcontext",
272 // // or "d3d11video".
273 // "type": "<identifier>",
275 // // Preference that must be deleted/reset to retrigger the guard.
276 // "prefName": "<preference>",
280 jsval getActiveCrashGuards
();
282 // Forces the GPU process to start or shutdown. This is intended only for
284 boolean controlGPUProcessForXPCShell
(in boolean aEnable
);