XII Release 0.1.0
Loading...
Searching...
No Matches
xiiGALRenderPassAttachmentDescription Struct Reference

This describes the render pass attachment creation description. More...

#include <RenderPass.h>

Inheritance diagram for xiiGALRenderPassAttachmentDescription:
[legend]

Public Member Functions

 XII_DECLARE_POD_TYPE ()
 
- Public Member Functions inherited from xiiHashableStruct< xiiGALRenderPassAttachmentDescription >
constexpr xiiHashableStruct () noexcept
 Default constructor. Initializes all bytes to zero.
 
 xiiHashableStruct (const xiiHashableStruct &other) noexcept
 Bitwise copy constructor.
 
xiiHashableStructoperator= (const xiiHashableStruct &other) noexcept
 Bitwise assignment operator.
 
bool operator== (const xiiHashableStruct &other) const noexcept
 Compares equality via raw byte comparison.
 
std::strong_ordering operator<=> (const xiiHashableStruct &other) const noexcept
 Compares ordering via raw byte comparison.
 
xiiUInt32 CalculateHash () const noexcept
 Calculates a 32-bit hash from raw bytes of the struct.
 
void Clear () noexcept
 Fills all bytes with zero.
 
bool IsZero () const noexcept
 Returns true if all bytes are zero.
 

Public Attributes

xiiEnum< xiiGALResourceFormatm_Format = xiiGALResourceFormat::Unknown
 The format of the texture view that will be used for the attachment. The default is xiiGALResourceFormat::Unknown.
 
xiiUInt8 m_uiSampleCount = 0U
 The number of samples in the texture. The default is 0.
 
xiiEnum< xiiGALAttachmentLoadOperationm_LoadOperation = xiiGALAttachmentLoadOperation::Load
 The load operation that specifies how the contents of color and depth components of the attachment are treated at the beginning of the sub pass where it is first used. The default is xiiGALAttachmentLoadOperation::Load.
 
xiiEnum< xiiGALAttachmentStoreOperationm_StoreOperation = xiiGALAttachmentStoreOperation::Store
 The store operation how the contents of color and depth components of the attachment are treated at the end of the sub pass where it is last used. The default is xiiGALAttachmentStoreOperation::Store.
 
xiiEnum< xiiGALAttachmentLoadOperationm_StencilLoadOperation = xiiGALAttachmentLoadOperation::Load
 The load operation that specifies how the contents of the stencil component of the attachment is treated at the beginning of the sub pass where it is first used. This value is ignored when the format does not have stencil component. The default is xiiGALAttachmentLoadOperation::Load.
 
xiiEnum< xiiGALAttachmentStoreOperationm_StencilStoreOperation = xiiGALAttachmentStoreOperation::Store
 The store operation how the contents of the stencil component of the attachment is treated at the end of the sub pass where it is last used. This value is ignored when the format does not have stencil component. The default is xiiGALAttachmentStoreOperation::Store.
 
xiiBitflags< xiiGALResourceStateFlagsm_InitialStateFlags = xiiGALResourceStateFlags::Unknown
 The state the attachment texture sub-resource will be in when a render pass instance begins. The default is xiiGALResourceStateFlags::Unknown.
 
xiiBitflags< xiiGALResourceStateFlagsm_FinalStateFlags = xiiGALResourceStateFlags::Unknown
 The state the attachment texture sub-resource will be transitioned to when a render pass instance ends. The default is xiiGALResourceStateFlags::Unknown.
 

Detailed Description

This describes the render pass attachment creation description.


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