widget/nsIGfxInfo.idl

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