Kanzi 4.1.0
kanzi::gfx::DepthAttachmentDescription Struct Reference

Describes the depth attachment behavior for a render pass. More...

#include <kanzi/gfx/create_info.hpp>

Public Attributes

float depthClearValue
 The default clear value when the attachment is cleared on load.
 
AttachmentLoadOperation depthLoadOperation
 The load operation for the depth attachment at the beginning of the render pass.
 
AttachmentStoreOperation depthStoreOperation
 The store operation for the depth attachment at the end of the render pass.
 
Format format
 The pixel format.
 
bool isDepthReadOnly
 When true, declares that the render pass does not modify the depth aspect of the attachment.
 
bool isStencilReadOnly
 When true, declares that the render pass does not modify the stencil aspect of the attachment.
 
MultisampleCount multisampleCount
 The number of samples for multisample anti-aliasing.
 
bool resolveMultisample
 Indicates whether this color attachment resolves the multisamples automatically when the render pass is complete.
 
uint32_t stencilClearValue
 The default clear value when the attachment is cleared on load.
 
AttachmentLoadOperation stencilLoadOperation
 The load operation for the stencil attachment at the beginning of the render pass.
 
AttachmentStoreOperation stencilStoreOperation
 The store operation for the stencil attachment at the end of the render pass.
 

Detailed Description

Describes the depth attachment behavior for a render pass.

Since
Kanzi 4.0.0

Member Data Documentation

◆ format

Format kanzi::gfx::DepthAttachmentDescription::format

The pixel format.

◆ depthLoadOperation

AttachmentLoadOperation kanzi::gfx::DepthAttachmentDescription::depthLoadOperation

The load operation for the depth attachment at the beginning of the render pass.

◆ depthStoreOperation

AttachmentStoreOperation kanzi::gfx::DepthAttachmentDescription::depthStoreOperation

The store operation for the depth attachment at the end of the render pass.

◆ depthClearValue

float kanzi::gfx::DepthAttachmentDescription::depthClearValue

The default clear value when the attachment is cleared on load.

◆ stencilLoadOperation

AttachmentLoadOperation kanzi::gfx::DepthAttachmentDescription::stencilLoadOperation

The load operation for the stencil attachment at the beginning of the render pass.

◆ stencilStoreOperation

AttachmentStoreOperation kanzi::gfx::DepthAttachmentDescription::stencilStoreOperation

The store operation for the stencil attachment at the end of the render pass.

◆ stencilClearValue

uint32_t kanzi::gfx::DepthAttachmentDescription::stencilClearValue

The default clear value when the attachment is cleared on load.

◆ multisampleCount

MultisampleCount kanzi::gfx::DepthAttachmentDescription::multisampleCount

The number of samples for multisample anti-aliasing.

◆ resolveMultisample

bool kanzi::gfx::DepthAttachmentDescription::resolveMultisample

Indicates whether this color attachment resolves the multisamples automatically when the render pass is complete.

◆ isDepthReadOnly

bool kanzi::gfx::DepthAttachmentDescription::isDepthReadOnly

When true, declares that the render pass does not modify the depth aspect of the attachment.

This permits the same depth texture to be sampled as an input within the pass while still bound as the framebuffer's depth attachment for depth testing. Render pipelines used inside such a pass must disable depth writes (DepthStencilStateCreateInfo::depthWriteEnabled). Defaults to false.

When the format has both a depth and a stencil aspect and this flag differs from isStencilReadOnly, the FeatureId::SeparateDepthStencilLayouts feature is required.

Since
Kanzi 4.1.0

◆ isStencilReadOnly

bool kanzi::gfx::DepthAttachmentDescription::isStencilReadOnly

When true, declares that the render pass does not modify the stencil aspect of the attachment.

Counterpart to isDepthReadOnly; see there for behaviour and the FeatureId::SeparateDepthStencilLayouts requirement on mixed configurations with packed depth/stencil formats. Defaults to false.

Since
Kanzi 4.1.0

The documentation for this struct was generated from the following file: