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
boolean UsesTiling
;
40 readonly attribute
boolean ContentUsesTiling
;
41 readonly attribute
boolean OffMainThreadPaintEnabled
;
42 readonly attribute
long OffMainThreadPaintWorkerCount
;
43 readonly attribute
unsigned long TargetFrameRate
;
45 // XXX: Switch to a list of devices, rather than explicitly numbering them.
48 * The name of the display adapter.
50 readonly attribute AString adapterDescription
;
51 readonly attribute AString adapterDescription2
;
53 readonly attribute AString adapterDriver
;
54 readonly attribute AString adapterDriver2
;
56 /* These types are inspired by DXGI_ADAPTER_DESC */
57 readonly attribute AString adapterVendorID
;
58 readonly attribute AString adapterVendorID2
;
60 readonly attribute AString adapterDeviceID
;
61 readonly attribute AString adapterDeviceID2
;
63 readonly attribute AString adapterSubsysID
;
64 readonly attribute AString adapterSubsysID2
;
67 * The amount of RAM in MB in the display adapter.
69 readonly attribute
unsigned long adapterRAM
;
70 readonly attribute
unsigned long adapterRAM2
;
72 readonly attribute AString adapterDriverVendor
;
73 readonly attribute AString adapterDriverVendor2
;
75 readonly attribute AString adapterDriverVersion
;
76 readonly attribute AString adapterDriverVersion2
;
78 readonly attribute AString adapterDriverDate
;
79 readonly attribute AString adapterDriverDate2
;
81 readonly attribute
boolean isGPU2Active
;
83 readonly attribute ACString drmRenderDevice
;
86 * Information about display devices
88 readonly attribute Array
<AString
> displayInfo
;
89 readonly attribute Array
<unsigned long> displayWidth
;
90 readonly attribute Array
<unsigned long> displayHeight
;
93 * Returns an array of objects describing each monitor. Guaranteed properties
94 * are "screenWidth" and "screenHeight". This is only implemented on Desktop.
96 * Windows additionally supplies "refreshRate" and "pseudoDisplay".
98 * OS X additionally supplies "scale".
103 void refreshMonitors
();
105 Array
<ACString
> getFailures
(out Array
<long> indices
);
107 [noscript
, notxpcom
] void logFailure
(in ACString failure
);
109 * A set of constants for features that we can ask this GfxInfo object
110 * about via GetFeatureStatus
112 /* Don't assign any value <= 0 */
113 /* Values must be contiguous */
114 /* Whether Direct2D is supported for content rendering. */
115 const long FEATURE_DIRECT2D
= 1;
116 /* Whether Direct3D 9 is supported for layers. */
117 const long FEATURE_DIRECT3D_9_LAYERS
= 2;
118 /* Whether Direct3D 10.0 is supported for layers. */
119 const long FEATURE_DIRECT3D_10_LAYERS
= 3;
120 /* Whether Direct3D 10.1 is supported for layers. */
121 const long FEATURE_DIRECT3D_10_1_LAYERS
= 4;
122 /* Whether OpenGL is supported for layers */
123 const long FEATURE_OPENGL_LAYERS
= 5;
124 /* Whether WebGL is supported via OpenGL. */
125 const long FEATURE_WEBGL_OPENGL
= 6;
126 /* Whether WebGL is supported via ANGLE (D3D9 -- does not check for the presence of ANGLE libs). */
127 const long FEATURE_WEBGL_ANGLE
= 7;
128 /* (Unused) Whether WebGL antialiasing is supported. */
129 const long UNUSED_FEATURE_WEBGL_MSAA
= 8;
130 /* Whether Stagefright is supported, starting in 17. */
131 const long FEATURE_STAGEFRIGHT
= 9;
132 /* Whether Webrtc Hardware H.264 acceleration is supported, starting in 71. */
133 const long FEATURE_WEBRTC_HW_ACCELERATION_H264
= 10;
134 /* Whether Direct3D 11 is supported for layers, starting in 32. */
135 const long FEATURE_DIRECT3D_11_LAYERS
= 11;
136 /* Whether hardware accelerated video decoding is supported, starting in 36. */
137 const long FEATURE_HARDWARE_VIDEO_DECODING
= 12;
138 /* Whether Direct3D 11 is supported for ANGLE, starting in 38. */
139 const long FEATURE_DIRECT3D_11_ANGLE
= 13;
140 /* Whether Webrtc Hardware acceleration is supported, starting in 42. */
141 const long FEATURE_WEBRTC_HW_ACCELERATION_ENCODE
= 14;
142 /* Whether Webrtc Hardware acceleration is supported, starting in 42. */
143 const long FEATURE_WEBRTC_HW_ACCELERATION_DECODE
= 15;
144 /* Whether Canvas acceleration is supported, starting in 45 */
145 const long FEATURE_CANVAS2D_ACCELERATION
= 16;
146 /* Whether hardware VP8 decoding is supported, starting in 48; not for downloadable blocking. */
147 const long FEATURE_VP8_HW_DECODE
= 17;
148 /* Whether hardware VP9 decoding is supported, starting in 48; not for downloadable blocking. */
149 const long FEATURE_VP9_HW_DECODE
= 18;
150 /* Whether NV_dx_interop2 is supported, starting in 50; downloadable blocking in 58. */
151 const long FEATURE_DX_INTEROP2
= 19;
152 /* Whether the GPU process is supported, starting in 52; downloadable blocking in 58. */
153 const long FEATURE_GPU_PROCESS
= 20;
154 /* Whether the WebGL2 is supported, starting in 54 */
155 const long FEATURE_WEBGL2
= 21;
156 /* Whether D3D11 keyed mutex is supported, starting in 56 */
157 const long FEATURE_D3D11_KEYED_MUTEX
= 22;
158 /* Whether WebRender is supported, starting in 62 */
159 const long FEATURE_WEBRENDER
= 23;
160 /* Whether WebRender is supported, starting in 62 */
161 const long FEATURE_DX_NV12
= 24;
162 const long FEATURE_DX_P010
= 25;
163 const long FEATURE_DX_P016
= 26;
164 /* Whether OpenGL swizzle configuration of texture units is supported, starting in 70 */
165 const long FEATURE_GL_SWIZZLE
= 27;
166 /* Whether WebRender native compositor is supported, starting in 73 */
167 const long FEATURE_WEBRENDER_COMPOSITOR
= 28;
168 /* Whether WebRender can use scissored clears for cached surfaces, staring in 79 */
169 const long FEATURE_WEBRENDER_SCISSORED_CACHE_CLEARS
= 29;
170 /* Support webgl.out-of-process: true (starting in 83) */
171 const long FEATURE_ALLOW_WEBGL_OUT_OF_PROCESS
= 30;
172 /* Is OpenGL threadsafe (starting in 83) */
173 const long FEATURE_THREADSAFE_GL
= 31;
174 /* Support running WebRender using the software backend, starting in 84. */
175 const long FEATURE_WEBRENDER_SOFTWARE
= 32;
176 /* Whether webrender uses pre-optimized shaders, starting in 87. */
177 const long FEATURE_WEBRENDER_OPTIMIZED_SHADERS
= 33;
178 /* Whether we prefer EGL over GLX with X11, starting in 88. */
179 const long FEATURE_X11_EGL
= 34;
180 /* Whether DMABUF is supported, starting in 88. */
181 const long FEATURE_DMABUF
= 35;
182 /* Whether webrender caches shader program binaries to disk, starting in 89. */
183 const long FEATURE_WEBRENDER_SHADER_CACHE
= 36;
184 /* the maximum feature value. */
185 const long FEATURE_MAX_VALUE
= FEATURE_WEBRENDER_SHADER_CACHE
;
188 * A set of return values from GetFeatureStatus
191 /* The driver is safe to the best of our knowledge */
192 const long FEATURE_STATUS_OK
= 1;
193 /* We don't know the status of the feature yet. The analysis probably hasn't finished yet. */
194 const long FEATURE_STATUS_UNKNOWN
= 2;
195 /* This feature is blocked on this driver version. Updating driver will typically unblock it. */
196 const long FEATURE_BLOCKED_DRIVER_VERSION
= 3;
197 /* This feature is blocked on this device, regardless of driver version.
198 * Typically means we hit too many driver crashes without a good reason to hope for them to
200 const long FEATURE_BLOCKED_DEVICE
= 4;
201 /* This feature is available and can be used, but is not suggested (e.g. shouldn't be used by default */
202 const long FEATURE_DISCOURAGED
= 5;
203 /* This feature is blocked on this OS version. */
204 const long FEATURE_BLOCKED_OS_VERSION
= 6;
205 /* This feature is blocked because of mismatched driver versions. */
206 const long FEATURE_BLOCKED_MISMATCHED_VERSION
= 7;
207 /* This feature is blocked due to not being on the allowlist. */
208 const long FEATURE_DENIED
= 8;
209 /* This feature is safe to be on this device due to the allowlist. */
210 const long FEATURE_ALLOW_ALWAYS
= 9;
211 /* This feature is safe to be on this device due to the allowlist, depending on qualified/experiment status. */
212 const long FEATURE_ALLOW_QUALIFIED
= 10;
215 * Ask about a feature, and return the status of that feature.
216 * If the feature is not ok then aFailureId will give a unique failure Id
217 * otherwise it will be empty.
219 long getFeatureStatus
(in long aFeature
, [optional] out ACString aFailureId
);
222 * Ask about a feature, return the minimum driver version required for it if its status is
223 * FEATURE_BLOCKED_DRIVER_VERSION, otherwise return an empty string.
225 AString getFeatureSuggestedDriverVersion
(in long aFeature
);
227 // only useful on X11
228 [noscript
, notxpcom
] void GetData
();
231 * Maximum refresh rate among detected monitors. -1 if unknown. aMixed is set
232 * to true if we know there are multiple displays and they have different
233 * refresh rates, else false.
235 [noscript
, notxpcom
] long GetMaxRefreshRate
(out boolean aMixed
);
240 // Return an object describing all features that have been configured:
243 // // For each feature:
246 // "description": <string>,
247 // "status": <string>,
249 // // One or more log entries, the first denotes the default value.
251 // "type": <string>, // "base", "user", "env", or "runtime"
252 // "status": <string>,
253 // "message": <string> // Set unless type is "base" and status is "available".
259 // // For each workaround:
262 // "description": <string>,
263 // "message": <string>
267 // When a message is prefixed with a '#', it is a special status code. Status
268 // codes are unique identifiers that can be searched in the codebase to find
269 // which line of code caused the message. Some codes are standardized to
270 // improve about:support messaging:
272 // "[CONTEXT_]FEATURE_FAILURE_BUG_<number>"
273 // CONTEXT is optional and can currently only be "BLOCKLIST".
274 // <number> refers to a bug number in Bugzilla.
277 jsval getFeatureLog
();
279 // Returns an object containing information about graphics features. It is
280 // intended to be directly included into the Telemetry environment.
284 // "compositor": "d3d9", "d3d11", "opengl", "basic", or "none"
285 // // ("none" indicates no compositors have been created)
286 // // Feature is one of "d3d9", "d3d11", "opengl", "basic", or "d2d".
288 // // Each backend can have one of the following statuses:
289 // // "unused" - This feature has not been requested.
290 // // "unavailable" - OS version or restriction prevents use.
291 // // "blocked" - An internal condition (such as safe mode) prevents use.
292 // // "blocklisted" - Blocked due to a blocklist restriction.
293 // // "denied" - Blocked due to allowlist restrictions.
294 // // "disabled" - User explicitly disabled this default feature.
295 // // "failed" - Feature failed to initialize.
296 // // "available" - User has this feature available by default.
297 // "status": "<status>",
298 // "version": "<version>",
299 // "warp": true|false, // D3D11 only.
300 // "textureSharing": true|false, // D3D11 only.
306 // Returns an array listing any active crash guards.
310 // // Type is one of "d3d11layers", or "glcontext".
311 // "type": "<identifier>",
313 // // Preference that must be deleted/reset to retrigger the guard.
314 // "prefName": "<preference>",
318 jsval getActiveCrashGuards
();
320 // Forces the GPU process to start or shutdown. This is intended only for
322 boolean controlGPUProcessForXPCShell
(in boolean aEnable
);