Class RenderAPICapabilities

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

Hierarchy

  • FrameworkObject
    • RenderAPICapabilities

Constructors

Accessors

  • get combinedLoadStoreBufferCount(): number
  • Total number of load-store (storage) buffers available.

    Returns number

  • set combinedLoadStoreBufferCount(value): void
  • Parameters

    • value: number

    Returns void

  • get combinedLoadStoreTextureUnitCount(): number
  • Total number of load-store texture units available.

    Returns number

  • set combinedLoadStoreTextureUnitCount(value): void
  • Parameters

    • value: number

    Returns void

  • get combinedParamBlockBufferCount(): number
  • Total number of parameter block buffers available.

    Returns number

  • set combinedParamBlockBufferCount(value): void
  • Parameters

    • value: number

    Returns void

  • get combinedSamplerCount(): number
  • Total number of samplers available.

    Returns number

  • set combinedSamplerCount(value): void
  • Parameters

    • value: number

    Returns void

  • get combinedTextureUnitCount(): number
  • Total number of texture units available.

    Returns number

  • set combinedTextureUnitCount(value): void
  • Parameters

    • value: number

    Returns void

  • get deviceName(): string
  • The name of the device (GPU) as reported by the render system.

    Returns string

  • set deviceName(value): void
  • Parameters

    • value: string

    Returns void

  • get driverVersionString(): string
  • Holds data about render system driver version.

    Returns string

  • get geometryProgramOutputVertexCount(): number
  • The number of vertices a geometry program can emit in a single run.

    Returns number

  • set geometryProgramOutputVertexCount(value): void
  • Parameters

    • value: number

    Returns void

  • get horizontalTexelOffset(): number
  • Horizontal texel offset used for mapping texels to pixels.

    Returns number

  • set horizontalTexelOffset(value): void
  • Parameters

    • value: number

    Returns void

  • get isMeetingMinimumRequirements(): boolean
  • The capabilities meet the minimum requirements.

    Returns boolean

  • set isMeetingMinimumRequirements(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isMeetingRecommendedRequirements(): boolean
  • The capabilities meet the recommended requirements.

    Returns boolean

  • set isMeetingRecommendedRequirements(value): void
  • Parameters

    • value: boolean

    Returns void

  • get maximumBindGroups(): number
  • The maximum number of bind groups allowed in a pipeline layout.

    Returns number

  • set maximumBindGroups(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumBindingsPerBindGroup(): number
  • The maximum number of binding indices available in a bind group layout.

    Returns number

  • set maximumBindingsPerBindGroup(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumBoundVertexBuffers(): number
  • Maximum number of vertex buffers we can bind at once.

    Returns number

  • set maximumBoundVertexBuffers(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumBufferSize(): number
  • The maximum supported size for GPU buffers in bytes.

    Returns number

  • set maximumBufferSize(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumBytesPerRenderTargetSample(): number
  • The maximum supported number of bytes per sample accross all color surfaces of a rendertarget.

    Returns number

  • set maximumBytesPerRenderTargetSample(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumComputeInvocationsPerWorkgroup(): number
  • The maximum value of the product of the workgroup_size dimensions.

    Returns number

  • set maximumComputeInvocationsPerWorkgroup(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumComputeWorkgroupSizeX(): number
  • The maximum value of the workgroup_size X dimension.

    Returns number

  • set maximumComputeWorkgroupSizeX(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumComputeWorkgroupSizeY(): number
  • The maximum value of the workgroup_size Y dimension.

    Returns number

  • set maximumComputeWorkgroupSizeY(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumComputeWorkgroupSizeZ(): number
  • The maximum value of the workgroup_size Z dimension.

    Returns number

  • set maximumComputeWorkgroupSizeZ(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumComputeWorkgroupsPerDimension(): number
  • The maximum value of the workgroup count per dimension in a dispatch.

    Returns number

  • set maximumComputeWorkgroupsPerDimension(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumComputeWorkgroupStorageSize(): number
  • The maximum number of bytes of workgroup storage used for a compute stage.

    Returns number

  • set maximumComputeWorkgroupStorageSize(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumDepth(): number
  • Maximum (farthest) depth value used by this render backend.

    Returns number

  • set maximumDepth(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumDynamicStorageBuffersPerPipelineLayout(): number
  • The maximum number of dynamic storage buffer bindings across a pipeline layout.

    Returns number

  • set maximumDynamicStorageBuffersPerPipelineLayout(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumDynamicUniformBuffersPerPipelineLayout(): number
  • The maximum number of dynamic uniform buffer bindings across a pipeline layout.

    Returns number

  • set maximumDynamicUniformBuffersPerPipelineLayout(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumInterStageShaderVariables(): number
  • The maximum number of input or output variables for inter-stage communication.

    Returns number

  • set maximumInterStageShaderVariables(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumStorageBufferBindingSize(): number
  • Maximum size in bytes for a single storage buffer binding.

    Returns number

  • set maximumStorageBufferBindingSize(value): void
  • Parameters

    • value: number

    Returns void

  • 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): void
  • Parameters

    • value: number

    Returns void

  • get maximumTextureSampleCount(): number
  • The maximum supported per pixel samples supported by all operations

    Returns number

  • set maximumTextureSampleCount(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumTextureSize1D(): number
  • The maximum supported width for 1-dimensional textures.

    Returns number

  • set maximumTextureSize1D(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumTextureSize2D(): number
  • The maximum supported width and height for 2-dimensional textures.

    Returns number

  • set maximumTextureSize2D(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumTextureSize3D(): number
  • The maximum supported width, height and depth for 3-dimensional textures.

    Returns number

  • set maximumTextureSize3D(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumUniformBufferBindingSize(): number
  • Maximum size in bytes for a single uniform buffer binding.

    Returns number

  • set maximumUniformBufferBindingSize(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumVertexAttributes(): number
  • The maximum number of vertex attributes in total across all vertex buffers.

    Returns number

  • set maximumVertexAttributes(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumVertexBufferArrayStride(): number
  • The maximum allowed array stride in a vertex buffer.

    Returns number

  • set maximumVertexBufferArrayStride(value): void
  • Parameters

    • value: number

    Returns void

  • get minimumDepth(): number
  • Minimum (closest) depth value used by this render backend

    Returns number

  • set minimumDepth(value): void
  • Parameters

    • value: number

    Returns void

  • get minimumStorageBufferOffsetAlignment(): number
  • Minimum alignment required for storage buffers sub-allocated within a larger buffer.

    Returns number

  • set minimumStorageBufferOffsetAlignment(value): void
  • Parameters

    • value: number

    Returns void

  • get minimumUniformBufferOffsetAlignment(): number
  • Minimum alignment required for uniform buffers sub-allocated within a larger buffer.

    Returns number

  • set minimumUniformBufferOffsetAlignment(value): void
  • Parameters

    • value: number

    Returns void

  • get multiRenderTargetCount(): number
  • The number of simultaneous render targets supported.

    Returns number

  • set multiRenderTargetCount(value): void
  • Parameters

    • value: number

    Returns void

  • get renderAPIName(): string
  • Returns string

  • get verticalTexelOffset(): number
  • Vertical texel offset used for mapping texels to pixels.

    Returns number

  • set verticalTexelOffset(value): void
  • Parameters

    • value: number

    Returns void

Methods

  • Checks is the specified capability supported.

    Parameters

    Returns boolean

  • Returns true if the provided profile is supported.

    Parameters

    • profile: string

    Returns boolean

  • Parses a vendor string and returns an enum with the vendor if parsed succesfully.

    Parameters

    • vendorString: string

    Returns EnumValue<GPUVendor, number>

  • Converts a vendor enum to a string.

    Parameters

    Returns string