Interface GPURequestAdapterOptions

Hierarchy

  • GPURequestAdapterOptions

Properties

featureLevel?: string

Requests an adapter that supports at least a particular set of capabilities. This influences the adapter#[[default feature level]] of devices created from this adapter. The capabilities for each level are defined below, and the exact steps are defined in requestAdapter and "a new device". If the implementation or system does not support all of the capabilities in the requested feature level, requestAdapter will return null. Note: Applications should typically make a single requestAdapter call with the lowest feature level they support, then inspect the adapter for additional capabilities they can use optionally, and request those in requestDevice. The allowed feature level string values are:

: "core" The following set of capabilities: - The limit/Default limits. - GPUFeatureName `"core-features-and-limits"`. Note: Adapters with this adapter#[[default feature level]] may conventionally be referred to as "Core-defaulting". : "compatibility" The following set of capabilities: - The limit/Compatibility Mode Default limits. - No features. (It excludes the GPUFeatureName `"core-features-and-limits"` feature.) If the implementation cannot enforce the stricter "Compatibility Mode" validation rules, requestAdapter will ignore this request and treat it as a request for feature level string/"core". Note: Adapters with this adapter#[[default feature level]] may conventionally be referred to as "Compatibility-defaulting".
forceFallbackAdapter?: boolean

When set to true indicates that only a fallback adapter may be returned. If the user agent does not support a fallback adapter, will cause requestAdapter to resolve to null. Note: requestAdapter may still return a fallback adapter if forceFallbackAdapter is set to false and either no other appropriate adapter is available or the user agent chooses to return a fallback adapter. Developers that wish to prevent their applications from running on fallback adapters should check the info.isFallbackAdapter attribute prior to requesting a GPUDevice.

powerPreference?: GPUPowerPreference

Optionally provides a hint indicating what class of adapter should be selected from the system's available adapters. The value of this hint may influence which adapter is chosen, but it must not influence whether an adapter is returned or not. Note: The primary utility of this hint is to influence which GPU is used in a multi-GPU system. For instance, some laptops have a low-power integrated GPU and a high-performance discrete GPU. This hint may also affect the power configuration of the selected GPU to match the requested power preference. Note: Depending on the exact hardware configuration, such as battery status and attached displays or removable GPUs, the user agent may select different adapters given the same power preference. Typically, given the same hardware configuration and state and powerPreference, the user agent is likely to select the same adapter.

xrCompatible?: boolean

Generated using TypeDoc