Diligent::SwapChainDesc struct

#include <Graphics/GraphicsEngine/interface/GraphicsTypes.h>

Constructors, destructors, conversion operators

SwapChainDesc(Uint32 _Width, Uint32 _Height, TEXTURE_FORMAT _ColorBufferFormat, TEXTURE_FORMAT _DepthBufferFormat, Uint32 _BufferCount = SwapChainDesc{}.BufferCount, Float32 _DefaultDepthValue = SwapChainDesc{}.DefaultDepthValue, Uint8 _DefaultStencilValue = SwapChainDesc{}.DefaultStencilValue, bool _IsPrimary = SwapChainDesc{}.IsPrimary)

Constructor intializes the structure members with default values.

Public variables

Uint32 Width

The swap chain width. Default value is 0.

Uint32 Height

The swap chain height. Default value is 0.

TEXTURE_FORMAT ColorBufferFormat

Back buffer format. Default value is Diligent::TEX_FORMAT_RGBA8_UNORM_SRGB.

TEXTURE_FORMAT DepthBufferFormat

Depth buffer format. Default value is Diligent::TEX_FORMAT_D32_FLOAT. Use Diligent::TEX_FORMAT_UNKNOWN to create the swap chain without depth buffer.

SWAP_CHAIN_USAGE_FLAGS Usage

Swap chain usage flags. Default value is Diligent::SWAP_CHAIN_USAGE_RENDER_TARGET.

SURFACE_TRANSFORM PreTransform

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

Uint32 BufferCount

The number of buffers in the swap chain.

Float32 DefaultDepthValue

Default depth value, which is used as optimized depth clear value in D3D12.

Uint8 DefaultStencilValue

Default stencil value, which is used as optimized stencil clear value in D3D12.

bool IsPrimary

Indicates if this is a primary swap chain. When Present() is called for the primary swap chain, the engine releases stale resources.

Variable documentation