DepthStencilAttachment

struct

csharp

public readonly record struct DepthStencilAttachment

The depth-stencil attachment in a render pass.

No guide page documents this yet — the page shows what the code says about itself.

Fields and properties (10)

public TextureViewHandle View
What to render into.
public LoadAction DepthLoad
What to do with depth at the start of the pass.
public StoreAction DepthStore
What to do with depth at the end.
public float ClearDepth
What to clear depth to. Defaults to 0, which is far under the engine's reversed-Z convention — clearing to 1 here is the classic mistake and produces a scene that depth-tests away entirely.
public LoadAction StencilLoad
What to do with stencil at the start of the pass.
public StoreAction StencilStore
What to do with stencil at the end.
public byte ClearStencil
What to clear stencil to.
public bool IsReadOnly
Whether the pass only tests depth, which lets a backend keep it readable by a shader at the same time.
public TextureViewHandle ResolveView
Where to resolve a multisampled depth attachment, when resolves.
public DepthResolveMode ResolveMode
Which sample the resolve keeps. ⚠ Unlike colour there is no average here — see DepthResolveMode — and under reversed-Z the default Max is the sample nearest the camera.

public DepthStencilAttachment(TextureViewHandle View, LoadAction DepthLoad = Clear, StoreAction DepthStore = Store, float ClearDepth = 0, LoadAction StencilLoad = DontCare, StoreAction StencilStore = DontCare, byte ClearStencil = 0, bool IsReadOnly = false, TextureViewHandle ResolveView = default(TextureViewHandle), DepthResolveMode ResolveMode = Max)
The depth-stencil attachment in a render pass.