CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::GPUMultiSamplingDescriptor Struct Referencefinal

Multi-sampling descriptor structure. More...

#include <CeresEngine/RenderAPI/GPUGraphicsPipeline.hpp>

Public Member Functions

UInt32 getSampleCount () const noexcept
 Returns the sample count for the state of this multi-sampling descriptor.
 

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

bool enabled = false
 Specifies whether multi-sampling is enabled or disabled.
 
UInt32 samples = 1
 Number of samples used for multi-sampling.
 
UInt32 sampleMask = ~0u
 Specifies the bitmask for sample coverage. By default 0xFFFFFFFF.
 

Detailed Description

Multi-sampling descriptor structure.

Member Function Documentation

◆ getSampleCount()

UInt32 CeresEngine::GPUMultiSamplingDescriptor::getSampleCount ( ) const
inlinenoexcept

Returns the sample count for the state of this multi-sampling descriptor.

Returns
max{1, samples} if multi-sampling is enabled, otherwise 1.

◆ reflect()

template<typename Processor >
static constexpr void CeresEngine::GPUMultiSamplingDescriptor::reflect ( Processor &&  RTTI)
inlinestaticconstexpr

Executes the given processor for every field of the struct.

Parameters
RTTIThe processor to be ran for every field.

Member Data Documentation

◆ enabled

bool CeresEngine::GPUMultiSamplingDescriptor::enabled = false

Specifies whether multi-sampling is enabled or disabled.

By default disabled.

◆ sampleMask

UInt32 CeresEngine::GPUMultiSamplingDescriptor::sampleMask = ~0u

Specifies the bitmask for sample coverage. By default 0xFFFFFFFF.

◆ samples

UInt32 CeresEngine::GPUMultiSamplingDescriptor::samples = 1

Number of samples used for multi-sampling.

By default 1.

Remarks
The equivalent member for multi-sampled images is ImageDescriptor::samples.

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