Kanzi 3.9.10
kanzi::CompositionManager::Request Class Reference

Composition request class. More...

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

Public Member Functions

Sampler::AddressingMode getAddressingMode () const
 Gets required addressing mode.
 
GraphicsFormat getColorFormat () const
 Gets required color format.
 
GraphicsCompareFunction getDepthCompareFunction () const
 Gets the depth comparison function.
 
GraphicsFormat getDepthStencilFormat () const
 Gets required depth/stencil format.
 
Sampler::Filter getFilterMode () const
 Gets the required filter mode.
 
unsigned int getHeight () const
 Gets required height.
 
Sampler::MipmapMode getMipmapMode () const
 Gets required mipmap mode.
 
unsigned int getSamples () const
 Gets required samples.
 
unsigned int getWidth () const
 Gets required width.
 
bool isColorRenderbufferRequired () const
 Tells if color render buffer is required.
 
bool isColorTextureRequired () const
 Tells if color texture is required.
 
bool isDepthRenderbufferRequired () const
 Tells if depth render buffer is required.
 
bool isDepthTextureRequired () const
 Tells if depth texture is required.
 
 Request (unsigned int width, unsigned int height, GraphicsFormat colorFormat, GraphicsFormat depthStencilFormat)
 Constructor.
 
 Request (unsigned int width, unsigned int height, GraphicsFormat colorFormat, GraphicsFormat depthStencilFormat, Sampler::AddressingMode addressingMode)
 Constructor.
 
 Request (unsigned int width, unsigned int height, GraphicsFormat colorFormat, GraphicsFormat depthStencilFormat, Sampler::AddressingMode addressingMode, Sampler::MipmapMode mipmapMode, unsigned int samples)
 Constructor.
 
 Request (unsigned int width, unsigned int height, GraphicsFormat colorFormat, GraphicsFormat depthStencilFormat, unsigned int samples)
 Constructor.
 
 Request (unsigned int width, unsigned int height, GraphicsFormat colorFormat, Sampler::AddressingMode addressingMode, Sampler::Filter filterMode, Sampler::MipmapMode mipmapMode)
 Constructor.
 
 Request (unsigned int width, unsigned int height, GraphicsFormat colorFormat, unsigned int samples)
 Constructor.
 
 Request (unsigned int width, unsigned int height, GraphicsFormatFeature colorFeatures, GraphicsFormat colorFormat, GraphicsFormatFeature depthFeatures, GraphicsFormat depthStencilFormat, unsigned int samples)
 Constructor.
 
void setColorRenderbufferFormat (GraphicsFormat colorFormat)
 Sets color renderbuffer format.
 
void setColorTextureFormat (GraphicsFormat colorFormat)
 Sets color texture format.
 
void setDepthCompareFunction (GraphicsCompareFunction function)
 Sets the depth comparison function.
 
void setDepthStencilRenderbufferFormat (GraphicsFormat depthStencilFormat)
 Sets depth/stencil renderbuffer format.
 
void setDepthStencilTextureFormat (GraphicsFormat depthStencilFormat)
 Sets depth/stencil texture format.
 
void setFilterMode (Sampler::Filter filterMode)
 Sets the required filter mode.
 
void setSamples (unsigned int samples)
 Sets required samples.
 

Detailed Description

Composition request class.

Packs all attributes of a composition request.

Constructor & Destructor Documentation

◆ Request() [1/7]

kanzi::CompositionManager::Request::Request ( unsigned int width,
unsigned int height,
GraphicsFormat colorFormat,
GraphicsFormat depthStencilFormat )
inlineexplicit

Constructor.

Parameters
widthRequested width.
heightRequested height.
colorFormatColor buffer format.
depthStencilFormatDepth/stencil buffer format.

◆ Request() [2/7]

kanzi::CompositionManager::Request::Request ( unsigned int width,
unsigned int height,
GraphicsFormat colorFormat,
unsigned int samples )
inlineexplicit

Constructor.

Parameters
widthRequested width.
heightRequested height.
colorFormatColor buffer format.
samplesRequested multisample level.

◆ Request() [3/7]

kanzi::CompositionManager::Request::Request ( unsigned int width,
unsigned int height,
GraphicsFormat colorFormat,
GraphicsFormat depthStencilFormat,
unsigned int samples )
inlineexplicit

Constructor.

Parameters
widthRequested width.
heightRequested height.
colorFormatColor buffer format.
depthStencilFormatDepth/stencil buffer format.
samplesRequested multisample level.

◆ Request() [4/7]

kanzi::CompositionManager::Request::Request ( unsigned int width,
unsigned int height,
GraphicsFormatFeature colorFeatures,
GraphicsFormat colorFormat,
GraphicsFormatFeature depthFeatures,
GraphicsFormat depthStencilFormat,
unsigned int samples )
inlineexplicit

Constructor.

Parameters
widthRequested width.
heightRequested height.
colorFeaturesRequested color features.
colorFormatColor buffer format.
depthFeaturesRequested depth features.
depthStencilFormatDepth/stencil buffer format.
samplesRequested multisample level.

◆ Request() [5/7]

kanzi::CompositionManager::Request::Request ( unsigned int width,
unsigned int height,
GraphicsFormat colorFormat,
Sampler::AddressingMode addressingMode,
Sampler::Filter filterMode,
Sampler::MipmapMode mipmapMode )
inlineexplicit

Constructor.

Parameters
widthRequested width.
heightRequested height.
colorFormatColor buffer format.
addressingModeAddressing mode used.
filterModeFilter node used.
mipmapModeMipmap mode used.

◆ Request() [6/7]

kanzi::CompositionManager::Request::Request ( unsigned int width,
unsigned int height,
GraphicsFormat colorFormat,
GraphicsFormat depthStencilFormat,
Sampler::AddressingMode addressingMode )
inlineexplicit

Constructor.

Parameters
widthRequested width.
heightRequested height.
colorFormatColor buffer format.
depthStencilFormatDepth/stencil buffer format.
addressingModeAddressing mode used.

◆ Request() [7/7]

kanzi::CompositionManager::Request::Request ( unsigned int width,
unsigned int height,
GraphicsFormat colorFormat,
GraphicsFormat depthStencilFormat,
Sampler::AddressingMode addressingMode,
Sampler::MipmapMode mipmapMode,
unsigned int samples )
inlineexplicit

Constructor.

Parameters
widthRequested width.
heightRequested height.
colorFormatColor buffer format.
depthStencilFormatDepth/stencil buffer format.
addressingModeAddressing mode used.
mipmapModeMipmap mode used.
samplesRequested multisample level.

Member Function Documentation

◆ getWidth()

unsigned int kanzi::CompositionManager::Request::getWidth ( ) const
inline

Gets required width.

Returns
Width.

◆ getHeight()

unsigned int kanzi::CompositionManager::Request::getHeight ( ) const
inline

Gets required height.

Returns
Height.

◆ getSamples()

unsigned int kanzi::CompositionManager::Request::getSamples ( ) const
inline

Gets required samples.

Returns
Samples.

◆ setSamples()

void kanzi::CompositionManager::Request::setSamples ( unsigned int samples)
inline

Sets required samples.

Parameters
samplesSample count.

◆ getColorFormat()

GraphicsFormat kanzi::CompositionManager::Request::getColorFormat ( ) const
inline

Gets required color format.

Returns
Color format.

◆ getDepthStencilFormat()

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

Gets required depth/stencil format.

Returns
Depth/stencil format.

◆ isColorTextureRequired()

bool kanzi::CompositionManager::Request::isColorTextureRequired ( ) const
inline

Tells if color texture is required.

Returns
True if yes, false if not.

◆ isColorRenderbufferRequired()

bool kanzi::CompositionManager::Request::isColorRenderbufferRequired ( ) const
inline

Tells if color render buffer is required.

Returns
True if yes, false if not.

◆ isDepthTextureRequired()

bool kanzi::CompositionManager::Request::isDepthTextureRequired ( ) const
inline

Tells if depth texture is required.

Returns
True if yes, false if not.

◆ isDepthRenderbufferRequired()

bool kanzi::CompositionManager::Request::isDepthRenderbufferRequired ( ) const
inline

Tells if depth render buffer is required.

Returns
True if yes, false if not.

◆ getAddressingMode()

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

Gets required addressing mode.

Returns
Addressing 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
filterModeFilter mode.
Since
Kanzi 3.9.6

◆ getMipmapMode()

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

Gets required mipmap mode.

Returns
Mipmap mode.

◆ 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
functionThe function to be used for depth comparisons.

◆ setColorRenderbufferFormat()

void kanzi::CompositionManager::Request::setColorRenderbufferFormat ( GraphicsFormat colorFormat)
inline

Sets color renderbuffer format.

Color features will be set to renderbuffer mask.

Parameters
colorFormatColor format.

◆ setColorTextureFormat()

void kanzi::CompositionManager::Request::setColorTextureFormat ( GraphicsFormat colorFormat)
inline

Sets color texture format.

Color features will be set to texture mask.

Parameters
colorFormatColor format.

◆ setDepthStencilRenderbufferFormat()

void kanzi::CompositionManager::Request::setDepthStencilRenderbufferFormat ( GraphicsFormat depthStencilFormat)
inline

Sets depth/stencil renderbuffer format.

Depth features will be set to renderbuffer mask.

Parameters
depthStencilFormatDepth/stencil format.

◆ setDepthStencilTextureFormat()

void kanzi::CompositionManager::Request::setDepthStencilTextureFormat ( GraphicsFormat depthStencilFormat)
inline

Sets depth/stencil texture format.

Depth features will be set to texture mask.

Parameters
depthStencilFormatDepth/stencil format.

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