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