xiiGALSwapChainCreationDescription Struct Reference

This describes the swap chain creation description. More...

#include <Descriptors.h>

Inheritance diagram for xiiGALSwapChainCreationDescription:

Public Member Functions
	XII_DECLARE_POD_TYPE ()
Public Member Functions inherited from xiiHashableStruct< xiiGALSwapChainCreationDescription >
constexpr	xiiHashableStruct () noexcept
	Default constructor. Initializes all bytes to zero.
	xiiHashableStruct (const xiiHashableStruct &other) noexcept
	Bitwise copy constructor.
xiiHashableStruct &	operator= (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
xiiWindowBase *	m_pWindow = nullptr
	Pointer to the window class.
xiiEnum< xiiGALResourceFormat >	m_ColorBufferFormat = xiiGALResourceFormat::RGBA8UNormalizedSRGB
	Back buffer format.
xiiBitflags< xiiGALSwapChainUsageFlags >	m_UsageFlags = xiiGALSwapChainUsageFlags::RenderTarget
	Swap chain usage flags.
xiiEnum< xiiGALSurfaceTransform >	m_PreTransform = xiiGALSurfaceTransform::Optimal
xiiUInt32	m_uiBufferCount = 2U
	The number of buffers in the swap chain.
float	m_fDefaultDepthValue = 1.0f
	Default depth value, which is used as the optimized depth clear value in D3D12.
xiiUInt8	m_uiDefaultStencilValue = 0U
	Default stencil value, which is used as the optimized clear value in D3D12.

Detailed Description

This describes the swap chain creation description.

Member Data Documentation

m_PreTransform

xiiEnum<xiiGALSurfaceTransform> xiiGALSwapChainCreationDescription::m_PreTransform = xiiGALSurfaceTransform::Optimal

The transform, relative to the presentation engine's natural orientation which is applied to the image prior to presentation.

                                                     \note When xiiGALSurfaceTransform::Optimal is used, the engine will select the most optimal surface transformation. An application may request a specific transform and the engine will try to use that. If the transform is not available, the engine will select the most optimal transform. After the swap chain has been created, this member will contain the actual transform selected by the engine. 

---

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

• /home/runner/work/XII/XII/Source/Engine/GraphicsFoundation/Declarations/Descriptors.h