DepthStencilAttachment

Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:95

Properties

depthClearValue?

optional depthClearValue: number

Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:110

Indicates the value to clear GPURenderPassDepthStencilAttachment#view’s depth component to prior to executing the render pass. Ignored if GPURenderPassDepthStencilAttachment#depthLoadOp is not GPULoadOp#“clear”. Must be between 0.0 and 1.0, inclusive (unless unrestricted depth is enabled).

depthLoadOp?

optional depthLoadOp: GPULoadOp

Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:116

Indicates the load operation to perform on GPURenderPassDepthStencilAttachment#view’s depth component prior to executing the render pass. Note: It is recommended to prefer clearing; see GPULoadOp#“clear” for details.

depthReadOnly?

optional depthReadOnly: boolean

Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:126

Indicates that the depth component of GPURenderPassDepthStencilAttachment#view is read only.

depthStoreOp?

optional depthStoreOp: GPUStoreOp

Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:121

The store operation to perform on GPURenderPassDepthStencilAttachment#view’s depth component after executing the render pass.

stencilClearValue?

optional stencilClearValue: number

Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:134

Indicates the value to clear GPURenderPassDepthStencilAttachment#view’s stencil component to prior to executing the render pass. Ignored if GPURenderPassDepthStencilAttachment#stencilLoadOp is not GPULoadOp#“clear”. The value will be converted to the type of the stencil aspect of view by taking the same number of LSBs as the number of bits in the stencil aspect of one texel of view.

stencilLoadOp?

optional stencilLoadOp: GPULoadOp

Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:140

Indicates the load operation to perform on GPURenderPassDepthStencilAttachment#view’s stencil component prior to executing the render pass. Note: It is recommended to prefer clearing; see GPULoadOp#“clear” for details.

stencilReadOnly?

optional stencilReadOnly: boolean

Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:150

Indicates that the stencil component of GPURenderPassDepthStencilAttachment#view is read only.

stencilStoreOp?

optional stencilStoreOp: GPUStoreOp

Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:145

The store operation to perform on GPURenderPassDepthStencilAttachment#view’s stencil component after executing the render pass.

view

view: GPUTextureView | TgpuTextureRenderView | DepthStencilTextureConstraint & RenderFlag | TgpuTextureView<WgslTextureDepth2d | WgslTextureDepthMultisampled2d>

Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:100

The texture subresource that will be output to and read from for this depth/stencil attachment.