Class CommandBufferMaker<T>

See GPUTest.createEncoder().

Type Parameters

T extends EncoderType

Hierarchy

CommandBufferMaker

Index

Constructors

Properties

encoder finish validateFinish validateFinishAndSubmit validateFinishAndSubmitGivenState

Constructors

constructor

new CommandBufferMaker<T>(t, encoder, finish): CommandBufferMaker<T>
Type Parameters
- T extends "render pass" | "render bundle" | "compute pass" | "non-pass"
Parameters
- t: GPUTestBase
- encoder: EncoderByEncoderType<"render pass" | "render bundle" | "compute pass" | "non-pass">
- finish: (() => GPUCommandBuffer)
  - - (): GPUCommandBuffer
    - Returns GPUCommandBuffer
Returns CommandBufferMaker<T>
- Defined in src/webgpu/util/command_buffer_maker.ts:53

Properties

`Readonly` encoder

encoder: EncoderByEncoderType<T>

GPU___Encoder for recording commands into.

`Readonly` finish

finish: (() => GPUCommandBuffer)

Type declaration

- (): GPUCommandBuffer
- Finish any passes, finish and record any bundles, and finish/return the command buffer. Any errors are ignored and the GPUCommandBuffer (which may be an error buffer) is returned.
  
  Returns GPUCommandBuffer

`Readonly` validateFinish

validateFinish: ((shouldSucceed) => GPUCommandBuffer)

Type declaration

- (shouldSucceed): GPUCommandBuffer
- Finish any passes, finish and record any bundles, and finish/return the command buffer. Checks for validation errors in (only) the appropriate finish call.
  Parameters
  - shouldSucceed: boolean
  Returns GPUCommandBuffer

`Readonly` validateFinishAndSubmit

validateFinishAndSubmit: ((shouldBeValid, submitShouldSucceedIfValid) => void)

Type declaration

- (shouldBeValid, submitShouldSucceedIfValid): void
- Finish the command buffer and submit it. Checks for validation errors in either the submit or the appropriate finish call, depending on the state of a resource used in the encoding.
  Parameters
  - shouldBeValid: boolean
  - submitShouldSucceedIfValid: boolean
  Returns void

`Readonly` validateFinishAndSubmitGivenState

validateFinishAndSubmitGivenState: ((resourceState) => void)

Type declaration

- (resourceState): void
- validateFinishAndSubmit() based on the state of a resource in the command encoder.
  - finish() should fail if the resource is 'invalid'.
  - Only submit() should fail if the resource is 'destroyed'.
  Parameters
  - resourceState: "invalid" | "valid" | "destroyed"
  Returns void

Generated using TypeDoc