kanzi::CompositionTargetRenderPass::CompositionFormatSettings Struct Reference

Format settings for composition target render pass. More...

#include <kanzi/core.ui/graphics3d/composition_target_render_pass.hpp>

Public Member Functions
	CompositionFormatSettings ()=default
	Default constructor. More...
	CompositionFormatSettings (unsigned int compositionWidth, unsigned int compositionHeight, GraphicsFormat cFormat, GraphicsFormat dFormat, GraphicsCompareFunction depthFunc, Sampler::AddressingMode addressing, Sampler::Filter filter, Sampler::MipmapMode mipmaps, unsigned int reqSamples)
	Constructor. More...
bool	sizeMatches (const CompositionFormatSettings &otherFormat) const
	Checks whether a given size matches with another composition format. More...
void	updateSampleCount (unsigned int maxSamples)
	Updates the correct sample count based on maximum. More...

Public Attributes
Sampler::AddressingMode	addressingMode
	Addressing mode. More...
GraphicsFormat	colorFormat
	Requested color format. More...
GraphicsCompareFunction	depthCompareFunction
	Depth compare function. More...
GraphicsFormat	depthFormat
	Requested depth format. More...
Sampler::Filter	filterMode
	Sampling mode. More...
unsigned int	height
	Composition height. More...
Sampler::MipmapMode	mipmapMode
	Mipmap mode. More...
unsigned int	requestedSamples
	Requested multisampling level. More...
unsigned int	samples
	Actual samples to be requested. More...
unsigned int	width
	Composition width. More...

Detailed Description

Format settings for composition target render pass.

Kanzi uses these as parameters when creating a composition target.

Constructor & Destructor Documentation

CompositionFormatSettings() [1/2]

kanzi::CompositionTargetRenderPass::CompositionFormatSettings::CompositionFormatSettings ( )

explicitdefault

Default constructor.

CompositionFormatSettings() [2/2]

kanzi::CompositionTargetRenderPass::CompositionFormatSettings::CompositionFormatSettings ( unsigned int  compositionWidth, unsigned int  compositionHeight, GraphicsFormat  cFormat, GraphicsFormat  dFormat, GraphicsCompareFunction  depthFunc, Sampler::AddressingMode  addressing, Sampler::Filter  filter, Sampler::MipmapMode  mipmaps, unsigned int  reqSamples  )

inline

Constructor.

Parameters

compositionWidth	Desired composition width.
compositionHeight	Desired composition height.
cFormat	Color format.
dFormat	Depth format.
depthFunc	Depth function.
addressing	Addressing mode.
filter	Filter mode.
mipmaps	Mipmap mode.
reqSamples	Requested multisample samples.

Member Function Documentation

sizeMatches()

bool kanzi::CompositionTargetRenderPass::CompositionFormatSettings::sizeMatches ( const CompositionFormatSettings &  otherFormat ) const

inline

Checks whether a given size matches with another composition format.

Parameters

otherFormat

Another composition format.

Returns

If sizes match, true, otherwise false.

updateSampleCount()

void kanzi::CompositionTargetRenderPass::CompositionFormatSettings::updateSampleCount ( unsigned int  maxSamples )

inline

Updates the correct sample count based on maximum.

Parameters

maxSamples

Maximum level of multisampling supported.

Member Data Documentation

width

unsigned int kanzi::CompositionTargetRenderPass::CompositionFormatSettings::width

Composition width.

height

unsigned int kanzi::CompositionTargetRenderPass::CompositionFormatSettings::height

Composition height.

colorFormat

GraphicsFormat kanzi::CompositionTargetRenderPass::CompositionFormatSettings::colorFormat

Requested color format.

depthFormat

GraphicsFormat kanzi::CompositionTargetRenderPass::CompositionFormatSettings::depthFormat

Requested depth format.

depthCompareFunction

GraphicsCompareFunction kanzi::CompositionTargetRenderPass::CompositionFormatSettings::depthCompareFunction

Depth compare function.

addressingMode

Sampler::AddressingMode kanzi::CompositionTargetRenderPass::CompositionFormatSettings::addressingMode

Addressing mode.

filterMode

Sampler::Filter kanzi::CompositionTargetRenderPass::CompositionFormatSettings::filterMode

Sampling mode.

mipmapMode

Sampler::MipmapMode kanzi::CompositionTargetRenderPass::CompositionFormatSettings::mipmapMode

Mipmap mode.

requestedSamples

unsigned int kanzi::CompositionTargetRenderPass::CompositionFormatSettings::requestedSamples

Requested multisampling level.

samples

unsigned int kanzi::CompositionTargetRenderPass::CompositionFormatSettings::samples

Actual samples to be requested.

---

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

• kanzi/core.ui/graphics3d/composition_target_render_pass.hpp