Swapchain descriptor structure. More...

#include <CeresEngine/RenderAPI/GPUSwapchain.hpp>

Static Public Member Functions
template<typename Processor >
static constexpr void	reflect (Processor &&RTTI)
	Executes the given processor for every field of the struct.

Public Attributes
PlatformWindow *	window = nullptr
	The platform window to be used when creating the swapchain.

TExtent2< UInt32 >	resolution
	Screen resolution (in pixels).

UInt8	colorBits = 32
	Number of bits for each pixel in the color buffer.

UInt8	depthBits = 0
	Number of bits for each pixel in the depth buffer.

UInt8	stencilBits = 0
	Number of bits for each pixel in the stencil buffer.

bool	fullscreen = false
	Specifies whether to enable fullscreen mode or windowed mode.

UInt32	size = 2
	Number of swap-chain buffers.

GPUVsyncDescriptor	vsync
	Vertical-synchronization (Vsync) descriptor.

GPUMultiSamplingDescriptor	multiSampling
	Multi-sampling descriptor.

Detailed Description

Swapchain descriptor structure.

Member Function Documentation

◆ reflect()

template<typename Processor >

static constexpr void CeresEngine::GPUSwapchainDescriptor::reflect ( Processor && RTTI )

inlinestaticconstexpr

Executes the given processor for every field of the struct.

Parameters

RTTI	The processor to be ran for every field.

Member Data Documentation

◆ colorBits

UInt8 CeresEngine::GPUSwapchainDescriptor::colorBits = 32

Number of bits for each pixel in the color buffer.

Should be 24 or

By default 32.
Remarks
This is only a hint to the renderer and there is no guarantee which hardware format is finally used for the color buffer.

◆ depthBits

UInt8 CeresEngine::GPUSwapchainDescriptor::depthBits = 0

Number of bits for each pixel in the depth buffer.

Should be 24, 32, or zero to disable depth buffer. By default 24.

Remarks: This is only a hint to the renderer and there is no guarantee which hardware format is finally used for the depth buffer.

◆ fullscreen

bool CeresEngine::GPUSwapchainDescriptor::fullscreen = false

Specifies whether to enable fullscreen mode or windowed mode.

By default windowed mode.

◆ multiSampling

GPUMultiSamplingDescriptor CeresEngine::GPUSwapchainDescriptor::multiSampling

Multi-sampling descriptor.

◆ resolution

TExtent2<UInt32> CeresEngine::GPUSwapchainDescriptor::resolution

Screen resolution (in pixels).

Remarks: If the resolution contains a member with a value of 0, the mode is invalid.

◆ size

UInt32 CeresEngine::GPUSwapchainDescriptor::size = 2

Number of swap-chain buffers.

By default 2 (for double-buffering).

Remarks: This is only a hint to the renderer and there is no guarantee how many buffers are finally used for the swap chain. Especially OpenGL does not support custom swap chain sizes. If this value is 0, the mode is invalid.

◆ stencilBits

UInt8 CeresEngine::GPUSwapchainDescriptor::stencilBits = 0

Number of bits for each pixel in the stencil buffer.

Should be 8, or zero to disable stencil buffer. By default 8.

Remarks: This is only a hint to the renderer and there is no guarantee which hardware format is finally used for the stencil buffer.

◆ vsync

GPUVsyncDescriptor CeresEngine::GPUSwapchainDescriptor::vsync

Vertical-synchronization (Vsync) descriptor.

◆ window

PlatformWindow* CeresEngine::GPUSwapchainDescriptor::window = nullptr

The platform window to be used when creating the swapchain.

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

/Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/RenderAPI/GPUSwapchain.hpp

Static Public Member Functions

Public Attributes