Composition request class. More...

#include <kanzi/core.ui/graphics2d/composition_manager.hpp>

Public Member Functions
Sampler::AddressingMode	getAddressingMode () const
	Gets required addressing mode.

GraphicsCompareFunction	getDepthCompareFunction () const
	Gets the depth comparison function.

GraphicsFormat	getDepthStencilFormat () const
	Gets required depth/stencil renderbuffer format.

Sampler::Filter	getFilterMode () const
	Gets the required filter mode.

GraphicsFormat	getFormat () const
	Gets required format.

size_t	getHeight () const
	Gets required height.

Sampler::MipmapMode	getMipmapMode () const
	Gets required mipmap mode.

size_t	getSamples () const
	Gets required samples.

size_t	getWidth () const
	Gets required width.

bool	isTransient () const
	Gets the transient status.

	Request ()=default
	Default constructor.

	Request (size_t width, size_t height, GraphicsFormat format, GraphicsFormat depthStencilFormat)
	Constructor.

	Request (size_t width, size_t height, GraphicsFormat format, GraphicsFormat depthStencilFormat, Sampler::MipmapMode mipmapMode, size_t samples)
	Constructor.

	Request (size_t width, size_t height, GraphicsFormat format, GraphicsFormat depthStencilFormat, size_t samples)
	Constructor.

	Request (size_t width, size_t height, GraphicsFormat format, GraphicsFormat depthStencilFormat, size_t samples, Sampler::AddressingMode addressingMode, Sampler::Filter filterMode, Sampler::MipmapMode mipmapMode, GraphicsCompareFunction depthCompareFunction, bool transient)
	Constructor.

	Request (size_t width, size_t height, GraphicsFormat format, size_t samples)
	Constructor.

void	setAddressingMode (Sampler::AddressingMode addressingMode)
	Sets required addressing mode.

void	setDepthCompareFunction (GraphicsCompareFunction function)
	Sets the depth comparison function.

void	setDepthStencilFormat (GraphicsFormat depthStencilFormat)
	Sets required depth/stencil renderbuffer format.

void	setFilterMode (Sampler::Filter filterMode)
	Sets the required filter mode.

void	setFormat (GraphicsFormat format)
	Gets required format.

void	setHeight (size_t height)
	Sets required height.

void	setMipmapMode (Sampler::MipmapMode mipmapMode)
	Sets the required mipmap mode.

void	setSamples (size_t samples)
	Sets required samples.

void	setTransient (bool transient)
	Sets the transient status flag.

void	setWidth (size_t width)
	Sets required width.

bool	sizeAndSamplesMatch (const Request &otherRequest) const
	Checks whether a given request matches with this request.

bool	sizeAndSamplesMatch (size_t width, size_t height, size_t samples) const
	Checks whether a given size and samples match with this request.

Protected Member Functions
void	assertFormat ()
	Ensures the format settings are correct.

Detailed Description

Composition request class.

Packs all attributes of a composition request.

Since: Kanzi 4.0.0 removed GraphicsFormatFeature fields.; Kanzi 4.0.0 removed isColorTextureRequired, isColorRenderbufferRequired, isDepthTextureRequired, isDepthRenderbufferRequired, getDepthStencilRenderbufferFormat and setDepthStencilRenderbufferFormat functions.; Kanzi 4.0.0 removed constructors using GraphisFormatFeature parameters among other superfluous constructors.

Constructor & Destructor Documentation

◆ Request() [1/6]

kanzi::CompositionManager::Request::Request ( )

explicitdefault

Default constructor.

◆ Request() [2/6]

kanzi::CompositionManager::Request::Request	(	size_t	width,
		size_t	height,
		GraphicsFormat	format,
		GraphicsFormat	depthStencilFormat,
		Sampler::MipmapMode	mipmapMode,
		size_t	samples )

inlineexplicit

Constructor.

Parameters

width	Requested width.
height	Requested height.
format	Texture format.
depthStencilFormat	Format of the additional depth or stencil renderbuffer or both, if needed.
mipmapMode	Mipmap mode.
samples	Requested multisample level.

Since: Kanzi 4.0.0

◆ Request() [3/6]

kanzi::CompositionManager::Request::Request	(	size_t	width,
		size_t	height,
		GraphicsFormat	format,
		GraphicsFormat	depthStencilFormat,
		size_t	samples )

inlineexplicit

Constructor.

Parameters

width	Requested width.
height	Requested height.
format	Texture format.
depthStencilFormat	Format of the additional depth or stencil renderbuffer or both, if needed.
samples	Requested multisample level.

Since: Kanzi 4.0.0 changed the type of the width, height, and samples parameters to size_t.

◆ Request() [4/6]

kanzi::CompositionManager::Request::Request	(	size_t	width,
		size_t	height,
		GraphicsFormat	format,
		size_t	samples )

inlineexplicit

Constructor.

Parameters

width	Requested width.
height	Requested height.
format	Texture format.
samples	Requested multisample level.

Since: Kanzi 4.0.0 changed the type of the width, height, and samples parameters to size_t.

◆ Request() [5/6]

kanzi::CompositionManager::Request::Request	(	size_t	width,
		size_t	height,
		GraphicsFormat	format,
		GraphicsFormat	depthStencilFormat )

inlineexplicit

Constructor.

Parameters

width	Requested width.
height	Requested height.
format	Texture format.
depthStencilFormat	Format of the additional depth or stencil renderbuffer or both, if needed.

Since: Kanzi 4.0.0 changed the type of the width and height parameters to size_t.

◆ Request() [6/6]

kanzi::CompositionManager::Request::Request	(	size_t	width,
		size_t	height,
		GraphicsFormat	format,
		GraphicsFormat	depthStencilFormat,
		size_t	samples,
		Sampler::AddressingMode	addressingMode,
		Sampler::Filter	filterMode,
		Sampler::MipmapMode	mipmapMode,
		GraphicsCompareFunction	depthCompareFunction,
		bool	transient )

inlineexplicit

Constructor.

Parameters

width	Requested width.
height	Requested height.
format	Texture format.
depthStencilFormat	Format of the additional depth or stencil renderbuffer or both, if needed.
samples	Requested multisample level.
addressingMode	Addressing mode used.
filterMode	Filter node used.
mipmapMode	Mipmap mode used.
depthCompareFunction	Depth Compare function.
transient	Transient state for renderbuffers.

Since

Kanzi 4.0.0

Changed the type of the width, height, and samples parameters to size_t.
Added the transient parameter.

Member Function Documentation

◆ getWidth()

size_t kanzi::CompositionManager::Request::getWidth ( ) const

inline

Gets required width.

Returns: Width.

Since: Kanzi 4.0.0 changed the type of the return value to size_t.

◆ setWidth()

void kanzi::CompositionManager::Request::setWidth ( size_t width )

inline

Sets required width.

Parameters

width Width to set.

◆ getHeight()

size_t kanzi::CompositionManager::Request::getHeight ( ) const

inline

Gets required height.

Returns: Height.

Since: Kanzi 4.0.0 changed the type of the return value to size_t.

◆ setHeight()

void kanzi::CompositionManager::Request::setHeight ( size_t height )

inline

Sets required height.

Parameters

height height to set.

◆ getSamples()

size_t kanzi::CompositionManager::Request::getSamples ( ) const

inline

Gets required samples.

Returns: Samples.

Since: Kanzi 4.0.0 changed the type of the return value to size_t.

◆ setSamples()

void kanzi::CompositionManager::Request::setSamples ( size_t samples )

inline

Sets required samples.

Parameters

samples Sample count.

Since: Kanzi 4.0.0 changed the type of the samples parameter to size_t.

◆ getFormat()

GraphicsFormat kanzi::CompositionManager::Request::getFormat ( ) const

inline

Gets required format.

Returns: Texture format.

Since: Kanzi 4.0.0 renamed from getColorFormat.

◆ setFormat()

void kanzi::CompositionManager::Request::setFormat ( GraphicsFormat format )

inline

Gets required format.

Parameters

format Texture format.

Since: Kanzi 4.0.0 renamed from setColorTextureFormat.

◆ getDepthStencilFormat()

GraphicsFormat kanzi::CompositionManager::Request::getDepthStencilFormat ( ) const

inline

Gets required depth/stencil renderbuffer format.

Returns: Depth/stencil format.

◆ setDepthStencilFormat()

void kanzi::CompositionManager::Request::setDepthStencilFormat ( GraphicsFormat depthStencilFormat )

inline

Sets required depth/stencil renderbuffer format.

Parameters

depthStencilFormat Depth/stencil format.

◆ getAddressingMode()

Sampler::AddressingMode kanzi::CompositionManager::Request::getAddressingMode ( ) const

inline

Gets required addressing mode.

Returns: Addressing mode.

◆ setAddressingMode()

void kanzi::CompositionManager::Request::setAddressingMode ( Sampler::AddressingMode addressingMode )

inline

Sets required addressing mode.

Parameters

addressingMode Adddressing mode.

◆ getFilterMode()

Sampler::Filter kanzi::CompositionManager::Request::getFilterMode ( ) const

inline

Gets the required filter mode.

Returns: Filter mode.

◆ setFilterMode()

void kanzi::CompositionManager::Request::setFilterMode ( Sampler::Filter filterMode )

inline

Sets the required filter mode.

Parameters

filterMode Filter mode.

Since: Kanzi 3.9.6

◆ getMipmapMode()

Sampler::MipmapMode kanzi::CompositionManager::Request::getMipmapMode ( ) const

inline

Gets required mipmap mode.

Returns: Mipmap mode.

◆ setMipmapMode()

void kanzi::CompositionManager::Request::setMipmapMode ( Sampler::MipmapMode mipmapMode )

inline

Sets the required mipmap mode.

Parameters

mipmapMode Mipmap mode.

Since: Kanzi 4.0.0

◆ getDepthCompareFunction()

GraphicsCompareFunction kanzi::CompositionManager::Request::getDepthCompareFunction ( ) const

inline

Gets the depth comparison function.

Returns: The function to be used in depth comparisons.

◆ setDepthCompareFunction()

void kanzi::CompositionManager::Request::setDepthCompareFunction ( GraphicsCompareFunction function )

inline

Sets the depth comparison function.

Parameters

function The function to be used for depth comparisons.

◆ isTransient()

bool kanzi::CompositionManager::Request::isTransient ( ) const

inline

Gets the transient status.

Returns: If the renderbuffers should be transient true, false otherise.

◆ setTransient()

void kanzi::CompositionManager::Request::setTransient ( bool transient )

inline

Sets the transient status flag.

Parameters

transient Transient status flag.

◆ sizeAndSamplesMatch() [1/2]

bool kanzi::CompositionManager::Request::sizeAndSamplesMatch	(	size_t	width,
		size_t	height,
		size_t	samples ) const

inline

Checks whether a given size and samples match with this request.

Parameters

width	Width to compare against.
height	Height to compare against.
samples	Sample count to compare against.

Returns: If the request is matching, true, false otherwise.

◆ sizeAndSamplesMatch() [2/2]

bool kanzi::CompositionManager::Request::sizeAndSamplesMatch ( const Request & otherRequest ) const

inline

Checks whether a given request matches with this request.

Parameters

otherRequest Request to compare against.

Returns: If the request is amtching, true, false otherwise.

◆ assertFormat()

void kanzi::CompositionManager::Request::assertFormat ( )

inlineprotected

Ensures the format settings are correct.

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

kanzi/core.ui/graphics2d/composition_manager.hpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Request() [1/6]

◆ Request() [2/6]

◆ Request() [3/6]

◆ Request() [4/6]

◆ Request() [5/6]

◆ Request() [6/6]

Member Function Documentation

◆ getWidth()

◆ setWidth()

◆ getHeight()

◆ setHeight()

◆ getSamples()

◆ setSamples()

◆ getFormat()

◆ setFormat()

◆ getDepthStencilFormat()

◆ setDepthStencilFormat()

◆ getAddressingMode()

◆ setAddressingMode()

◆ getFilterMode()

◆ setFilterMode()

◆ getMipmapMode()

◆ setMipmapMode()

◆ getDepthCompareFunction()

◆ setDepthCompareFunction()

◆ isTransient()

◆ setTransient()

◆ sizeAndSamplesMatch() [1/2]

◆ sizeAndSamplesMatch() [2/2]

◆ assertFormat()