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