DepthStencilAttachment
Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:94
Properties
Section titled “Properties”depthClearValue?
Section titled “depthClearValue?”
optionaldepthClearValue:number
Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:109
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?
Section titled “depthLoadOp?”
optionaldepthLoadOp:GPULoadOp
Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:115
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?
Section titled “depthReadOnly?”
optionaldepthReadOnly:boolean
Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:125
Indicates that the depth component of GPURenderPassDepthStencilAttachment#view is read only.
depthStoreOp?
Section titled “depthStoreOp?”
optionaldepthStoreOp:GPUStoreOp
Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:120
The store operation to perform on GPURenderPassDepthStencilAttachment#view’s depth component after executing the render pass.
stencilClearValue?
Section titled “stencilClearValue?”
optionalstencilClearValue:number
Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:133
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?
Section titled “stencilLoadOp?”
optionalstencilLoadOp:GPULoadOp
Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:139
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?
Section titled “stencilReadOnly?”
optionalstencilReadOnly:boolean
Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:149
Indicates that the stencil component of GPURenderPassDepthStencilAttachment#view is read only.
stencilStoreOp?
Section titled “stencilStoreOp?”
optionalstencilStoreOp:GPUStoreOp
Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:144
The store operation to perform on GPURenderPassDepthStencilAttachment#view’s stencil component after executing the render pass.
view:
GPUTextureView|TgpuTextureRenderView|DepthStencilTextureConstraint&RenderFlag|TgpuTextureView<WgslTextureDepth2d|WgslTextureDepthMultisampled2d>
Defined in: packages/typegpu/src/core/commandEncoder/attachments.ts:99
The texture subresource that will be output to and read from for this depth/stencil attachment.