Class RenderAPICapabilities

Information about hardware (GPU) and driver capabilities, such as supported features, limits and conventions.

Index

Constructors

Accessors

combinedLoadStoreBufferCount combinedLoadStoreTextureUnitCount combinedParamBlockBufferCount combinedSamplerCount combinedTextureUnitCount conventions deviceName deviceVendor driverVersion driverVersionString geometryProgramOutputVertexCount horizontalTexelOffset isMeetingMinimumRequirements isMeetingRecommendedRequirements maximumBindGroups maximumBindingsPerBindGroup maximumBoundVertexBuffers maximumBufferSize maximumBytesPerRenderTargetSample maximumComputeInvocationsPerWorkgroup maximumComputeWorkgroupSizeX maximumComputeWorkgroupSizeY maximumComputeWorkgroupSizeZ maximumComputeWorkgroupsPerDimension maximumComputeWorkgroupStorageSize maximumDepth maximumDynamicStorageBuffersPerPipelineLayout maximumDynamicUniformBuffersPerPipelineLayout maximumInterStageShaderVariables maximumStorageBufferBindingSize maximumTextureArrayLayerCount maximumTextureSampleCount maximumTextureSize1D maximumTextureSize2D maximumTextureSize3D maximumUniformBufferBindingSize maximumVertexAttributes maximumVertexBufferArrayStride minimumDepth minimumStorageBufferOffsetAlignment minimumUniformBufferOffsetAlignment multiRenderTargetCount renderAPIName vertexColorType verticalTexelOffset

Methods

hasCapability isShaderProfileSupported vendorFromString vendorToString

Constructors

`Protected`constructor

new RenderAPICapabilities(
isInternalConstructor?: boolean,
): RenderAPICapabilities
Parameters
- OptionalisInternalConstructor: boolean
Returns RenderAPICapabilities

Overrides FrameworkObject.constructor

Accessors

combinedLoadStoreBufferCount

get combinedLoadStoreBufferCount(): number

Total number of load-store (storage) buffers available.

Returns number
set combinedLoadStoreBufferCount(value: number): void
Parameters
- value: number
Returns void

combinedLoadStoreTextureUnitCount

get combinedLoadStoreTextureUnitCount(): number

Total number of load-store texture units available.

Returns number
set combinedLoadStoreTextureUnitCount(value: number): void
Parameters
- value: number
Returns void

combinedParamBlockBufferCount

get combinedParamBlockBufferCount(): number

Total number of parameter block buffers available.

Returns number
set combinedParamBlockBufferCount(value: number): void
Parameters
- value: number
Returns void

combinedSamplerCount

get combinedSamplerCount(): number

Total number of samplers available.

Returns number
set combinedSamplerCount(value: number): void
Parameters
- value: number
Returns void

combinedTextureUnitCount

get combinedTextureUnitCount(): number

Total number of texture units available.

Returns number
set combinedTextureUnitCount(value: number): void
Parameters
- value: number
Returns void

conventions

get conventions(): Immutable<Conventions>

Returns various conventions expected by the render backend.

Returns Immutable<Conventions>
set conventions(value: Immutable<Conventions>): void
Parameters
- value: Immutable<Conventions>
Returns void

deviceName

get deviceName(): string

The name of the device (GPU) as reported by the render system.

Returns string
set deviceName(value: string): void
Parameters
- value: string
Returns void

deviceVendor

get deviceVendor(): EnumValue<GPUVendor>

Vendor of the device (GPU).

Returns EnumValue<GPUVendor>
set deviceVendor(value: EnumValue<GPUVendor>): void
Parameters
- value: EnumValue<GPUVendor>
Returns void

driverVersion

get driverVersion(): Immutable<DriverVersion>

Current version of the driver (render backend).

Returns Immutable<DriverVersion>
set driverVersion(value: Immutable<DriverVersion>): void
Parameters
- value: Immutable<DriverVersion>
Returns void

driverVersionString

get driverVersionString(): string

Holds data about render system driver version.

Returns string

geometryProgramOutputVertexCount

get geometryProgramOutputVertexCount(): number

The number of vertices a geometry program can emit in a single run.

Returns number
set geometryProgramOutputVertexCount(value: number): void
Parameters
- value: number
Returns void

horizontalTexelOffset

get horizontalTexelOffset(): number

Horizontal texel offset used for mapping texels to pixels.

Returns number
set horizontalTexelOffset(value: number): void
Parameters
- value: number
Returns void

isMeetingMinimumRequirements

get isMeetingMinimumRequirements(): boolean

The capabilities meet the minimum requirements.

Returns boolean
set isMeetingMinimumRequirements(value: boolean): void
Parameters
- value: boolean
Returns void

isMeetingRecommendedRequirements

get isMeetingRecommendedRequirements(): boolean

The capabilities meet the recommended requirements.

Returns boolean
set isMeetingRecommendedRequirements(value: boolean): void
Parameters
- value: boolean
Returns void

maximumBindGroups

get maximumBindGroups(): number

The maximum number of bind groups allowed in a pipeline layout.

Returns number
set maximumBindGroups(value: number): void
Parameters
- value: number
Returns void

maximumBindingsPerBindGroup

get maximumBindingsPerBindGroup(): number

The maximum number of binding indices available in a bind group layout.

Returns number
set maximumBindingsPerBindGroup(value: number): void
Parameters
- value: number
Returns void

maximumBoundVertexBuffers

get maximumBoundVertexBuffers(): number

Maximum number of vertex buffers we can bind at once.

Returns number
set maximumBoundVertexBuffers(value: number): void
Parameters
- value: number
Returns void

maximumBufferSize

get maximumBufferSize(): number

The maximum supported size for GPU buffers in bytes.

Returns number
set maximumBufferSize(value: number): void
Parameters
- value: number
Returns void

maximumBytesPerRenderTargetSample

get maximumBytesPerRenderTargetSample(): number

The maximum supported number of bytes per sample accross all color surfaces of a rendertarget.

Returns number
set maximumBytesPerRenderTargetSample(value: number): void
Parameters
- value: number
Returns void

maximumComputeInvocationsPerWorkgroup

get maximumComputeInvocationsPerWorkgroup(): number

The maximum value of the product of the workgroup_size dimensions.

Returns number
set maximumComputeInvocationsPerWorkgroup(value: number): void
Parameters
- value: number
Returns void

maximumComputeWorkgroupSizeX

get maximumComputeWorkgroupSizeX(): number

The maximum value of the workgroup_size X dimension.

Returns number
set maximumComputeWorkgroupSizeX(value: number): void
Parameters
- value: number
Returns void

maximumComputeWorkgroupSizeY

get maximumComputeWorkgroupSizeY(): number

The maximum value of the workgroup_size Y dimension.

Returns number
set maximumComputeWorkgroupSizeY(value: number): void
Parameters
- value: number
Returns void

maximumComputeWorkgroupSizeZ

get maximumComputeWorkgroupSizeZ(): number

The maximum value of the workgroup_size Z dimension.

Returns number
set maximumComputeWorkgroupSizeZ(value: number): void
Parameters
- value: number
Returns void

maximumComputeWorkgroupsPerDimension

get maximumComputeWorkgroupsPerDimension(): number

The maximum value of the workgroup count per dimension in a dispatch.

Returns number
set maximumComputeWorkgroupsPerDimension(value: number): void
Parameters
- value: number
Returns void

maximumComputeWorkgroupStorageSize

get maximumComputeWorkgroupStorageSize(): number

The maximum number of bytes of workgroup storage used for a compute stage.

Returns number
set maximumComputeWorkgroupStorageSize(value: number): void
Parameters
- value: number
Returns void

maximumDepth

get maximumDepth(): number

Maximum (farthest) depth value used by this render backend.

Returns number
set maximumDepth(value: number): void
Parameters
- value: number
Returns void

maximumDynamicStorageBuffersPerPipelineLayout

get maximumDynamicStorageBuffersPerPipelineLayout(): number

The maximum number of dynamic storage buffer bindings across a pipeline layout.

Returns number
set maximumDynamicStorageBuffersPerPipelineLayout(value: number): void
Parameters
- value: number
Returns void

maximumDynamicUniformBuffersPerPipelineLayout

get maximumDynamicUniformBuffersPerPipelineLayout(): number

The maximum number of dynamic uniform buffer bindings across a pipeline layout.

Returns number
set maximumDynamicUniformBuffersPerPipelineLayout(value: number): void
Parameters
- value: number
Returns void

maximumInterStageShaderVariables

get maximumInterStageShaderVariables(): number

The maximum number of input or output variables for inter-stage communication.

Returns number
set maximumInterStageShaderVariables(value: number): void
Parameters
- value: number
Returns void

maximumStorageBufferBindingSize

get maximumStorageBufferBindingSize(): number

Maximum size in bytes for a single storage buffer binding.

Returns number
set maximumStorageBufferBindingSize(value: number): void
Parameters
- value: number
Returns void

maximumTextureArrayLayerCount

get maximumTextureArrayLayerCount(): number

Maximum number of layers allowed when creating a texture array. Note for cubemaps each cubemap takes 6 layers.

Returns number
set maximumTextureArrayLayerCount(value: number): void
Parameters
- value: number
Returns void

maximumTextureSampleCount

get maximumTextureSampleCount(): number

The maximum supported per pixel samples supported by all operations

Returns number
set maximumTextureSampleCount(value: number): void
Parameters
- value: number
Returns void

maximumTextureSize1D

get maximumTextureSize1D(): number

The maximum supported width for 1-dimensional textures.

Returns number
set maximumTextureSize1D(value: number): void
Parameters
- value: number
Returns void

maximumTextureSize2D

get maximumTextureSize2D(): number

The maximum supported width and height for 2-dimensional textures.

Returns number
set maximumTextureSize2D(value: number): void
Parameters
- value: number
Returns void

maximumTextureSize3D

get maximumTextureSize3D(): number

The maximum supported width, height and depth for 3-dimensional textures.

Returns number
set maximumTextureSize3D(value: number): void
Parameters
- value: number
Returns void

maximumUniformBufferBindingSize

get maximumUniformBufferBindingSize(): number

Maximum size in bytes for a single uniform buffer binding.

Returns number
set maximumUniformBufferBindingSize(value: number): void
Parameters
- value: number
Returns void

maximumVertexAttributes

get maximumVertexAttributes(): number

The maximum number of vertex attributes in total across all vertex buffers.

Returns number
set maximumVertexAttributes(value: number): void
Parameters
- value: number
Returns void

maximumVertexBufferArrayStride

get maximumVertexBufferArrayStride(): number

The maximum allowed array stride in a vertex buffer.

Returns number
set maximumVertexBufferArrayStride(value: number): void
Parameters
- value: number
Returns void

minimumDepth

get minimumDepth(): number

Minimum (closest) depth value used by this render backend

Returns number
set minimumDepth(value: number): void
Parameters
- value: number
Returns void

minimumStorageBufferOffsetAlignment

get minimumStorageBufferOffsetAlignment(): number

Minimum alignment required for storage buffers sub-allocated within a larger buffer.

Returns number
set minimumStorageBufferOffsetAlignment(value: number): void
Parameters
- value: number
Returns void

minimumUniformBufferOffsetAlignment

get minimumUniformBufferOffsetAlignment(): number

Minimum alignment required for uniform buffers sub-allocated within a larger buffer.

Returns number
set minimumUniformBufferOffsetAlignment(value: number): void
Parameters
- value: number
Returns void

multiRenderTargetCount

get multiRenderTargetCount(): number

The number of simultaneous render targets supported.

Returns number
set multiRenderTargetCount(value: number): void
Parameters
- value: number
Returns void

renderAPIName

get renderAPIName(): string

Returns string

vertexColorType

get vertexColorType(): EnumValue<VertexElementType>

Native type used for vertex colors.

Returns EnumValue<VertexElementType>
set vertexColorType(value: EnumValue<VertexElementType>): void
Parameters
- value: EnumValue<VertexElementType>
Returns void

verticalTexelOffset

get verticalTexelOffset(): number

Vertical texel offset used for mapping texels to pixels.

Returns number
set verticalTexelOffset(value: number): void
Parameters
- value: number
Returns void

Methods

hasCapability

hasCapability(capabilities: EnumValue<Capabilities>): boolean
Checks is the specified capability supported.
Parameters
- capabilities: EnumValue<Capabilities>
Returns boolean

isShaderProfileSupported

isShaderProfileSupported(profile: string): boolean
Returns true if the provided profile is supported.
Parameters
- profile: string
Returns boolean

`Static`vendorFromString

vendorFromString(vendorString: string): EnumValue<GPUVendor>
Parses a vendor string and returns an enum with the vendor if parsed succesfully.
Parameters
- vendorString: string
Returns EnumValue<GPUVendor>

`Static`vendorToString

vendorToString(vendor: EnumValue<GPUVendor>): string
Converts a vendor enum to a string.
Parameters
- vendor: EnumValue<GPUVendor>
Returns string