Composition manager. More...

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

Classes
struct	LRUTracker
	Least Recently Used wrapper for different resource types. More...

class	Request
	Composition request class. More...

struct	ReuseParameters
	Reuse and pruning parameters for unused composition targets. More...

class	Target
	Composition target. More...

Public Types
using	AvailableRenderbufferContainer
	Storage type for available renderbuffers.

using	AvailableTextureContainer
	Storage type for available textures.

using	AvailableTextureSpan
	Span type for available textures.

using	UsedTextureSpan
	Span type for used textures.

Public Member Functions
TextureSharedPtr	acquireTemporaryCompositionTarget (const CompositionContentRequirements &requirements)
	Requests a composition target.

virtual Target	acquireTemporaryCompositionTarget (const Request &compositionReq)
	Requests a composition target.

TextureSharedPtr	acquireTemporaryCompositionTarget (unsigned int width, unsigned int height, bool alpha, bool depth, bool stencil)
	Requests a composition target.

TextureSharedPtr	acquireTemporaryCompositionTarget (unsigned int width, unsigned int height, bool alpha, bool depth, bool stencil, unsigned int numSamples)
	Requests a composition target.

TextureSharedPtr	acquireTemporaryCompositionTarget (unsigned int width, unsigned int height, GraphicsFormat colorFormat, GraphicsFormat depthStencilFormat)
	Requests a composition target.

TextureSharedPtr	acquireTemporaryCompositionTarget (unsigned int width, unsigned int height, GraphicsFormat colorFormat, GraphicsFormat depthStencilFormat, unsigned int numSamples)
	Requests a composition target.

void	clear ()
	Removes all allocated temporary composition targets.

bool	colorRenderbufferMatches (const Renderbuffer &renderbuffer, const Request &compositionReq) const
	Returns whether a given color render buffer matches composition requirements.

bool	colorTextureMatches (const Texture &texture, const Request &compositionReq) const
	Returns whether a given color texture matches composition requirements.

	CompositionManager (ResourceManager *resourceManager)
	Constructor.

bool	compositionTargetMatches (const Target &target, const Request &compositionReq) const
	Checks if a given composition target texture is an acceptable match for given requirements.

bool	compositionTargetMatches (const Target &target, const Request &compositionReq, float downScaleLimit) const
	Checks if a given composition target is an acceptable match for given requirements.

bool	compositionTargetMatches (TextureSharedPtr texture, unsigned int width, unsigned int height, bool alpha, bool depth, bool stencil) const
	Checks if a given composition target texture is an acceptable match for given requirements.

bool	compositionTargetMatches (TextureSharedPtr texture, unsigned int width, unsigned int height, bool alpha, bool depth, bool stencil, float downScaleLimit) const
	Checks if a given composition target texture is an acceptable match for given requirements.

bool	compositionTargetMatches (TextureSharedPtr texture, unsigned int width, unsigned int height, GraphicsFormat colorFormat, GraphicsFormat depthStencilFormat) const
	Checks if a given composition target texture is an acceptable match for given requirements.

RenderbufferSharedPtr	createPersistentColorRenderbuffer (const CompositionManager::Request &compositionReq)
	Creates a persistent color renderbuffer.

virtual Target	createPersistentCompositionTarget (const Request &compositionReq)
	Creates a persistent composition target.

TextureSharedPtr	createPersistentCompositionTarget (unsigned int width, unsigned int height, bool alpha, bool depth, bool stencil)
	Creates a persistent composition target.

TextureSharedPtr	createPersistentCompositionTarget (unsigned int width, unsigned int height, GraphicsFormat colorFormat, GraphicsFormat depthStencilFormat, Sampler::AddressingMode addressingMode)
	Creates a persistent composition target.

virtual RenderbufferSharedPtr	createPersistentDepthStencilRenderbuffer (const CompositionManager::Request &compositionReq)
	Creates a persistent depth and/or stencil renderbuffer.

RenderbufferSharedPtr	createPersistentDepthStencilRenderbuffer (unsigned int width, unsigned int height, bool depth, bool stencil, unsigned int samples)
	Creates a persistent depth and/or stencil renderbuffer.

RenderbufferSharedPtr	createPersistentDepthStencilRenderbuffer (unsigned int width, unsigned int height, GraphicsFormat depthStencilFormat, unsigned int samples)
	Creates a persistent depth and/or stencil renderbuffer.

TextureSharedPtr	createPersistentDepthTexture (const CompositionManager::Request &compositionReq)
	Creates a persistent depth texture.

TextureSharedPtr	createPersistentTexture (const CompositionManager::Request &compositionReq)
	Creates a persistent color texture.

bool	depthTextureMatches (const Texture &texture, const Request &compositionReq) const
	Returns whether a given depth texture matches composition requirements.

AvailableTextureSpan	getAvailableTextures () const
	Gets a span over the available textures.

GraphicsFormat	getColorFormat (bool alpha) const
	Gets color texture format format depending on alpha requirement.

GraphicsFormat	getDepthRenderbufferFormat () const
	Gets depth renderbuffer format.

GraphicsFormat	getDepthStencilFormat (bool depth, bool stencil) const
	Gets the depth or stencil renderbuffer format depending on requirements.

GraphicsFormat	getDepthStencilRenderbufferFormat () const
	Gets depth + stencil format.

GraphicsFormat	getDepthTextureFormat () const
	Gets format for depth textures.

ReuseParameters	getReuseParameters () const
	Gets the reuse and pruning parameters for unused composition targets.

GraphicsFormat	getStencilRenderbufferFormat () const
	Gets stencil renderbuffer format.

void	getUnusedTargetCounts (size_t &textures, size_t &renderBuffers, size_t &depthTextures)
	Gets the numbers of unused composition targets for statistics and test purposes.

UsedTextureSpan	getUsedTextures () const
	Gets a span over the textures that are in use.

void	initialize (Renderer &renderer)
	Initializes the composition manager.

void	pruneUnusedTargets ()
	Prunes unused composition targets from free lists.

virtual void	releaseTemporaryCompositionTarget (const Target &target)
	Releases an earlier composition target.

void	setReuseParameters (const ReuseParameters &reuseParameters)
	Sets the reuse and pruning parameters for unused composition targets.

virtual	~CompositionManager ()=default
	Destructor.

Protected Member Functions
Target	createTemporaryCompositionTarget (const CompositionManager::Request &compositionReq, TextureSharedPtr texture, RenderbufferSharedPtr colorRenderbuffer, TextureSharedPtr depthTexture)
	Creates a temporary composition target.

RenderbufferSharedPtr	findClosestColorRenderbuffer (const CompositionManager::Request &compositionReq)
	Finds the renderbuffer, which most closely matches a given composition requirement, and marks it used.

TextureSharedPtr	findClosestDepthTexture (const CompositionManager::Request &compositionReq)
	Finds the depth texture, which most closely matches a given composition requirement, and marks it used.

TextureSharedPtr	findClosestTexture (const CompositionManager::Request &compositionReq)
	Finds the color texture, which most closely matches a given composition requirement, and marks it used.

unsigned int	getColorRenderbufferMatchLevel (const Renderbuffer &renderbuffer, const Request &compositionReq) const
	Gets color renderbuffer match level for given requirements.

unsigned int	getDepthTextureMatchLevel (const Texture &texture, const Request &compositionReq) const
	Gets depth texture match level for given requirements.

unsigned int	getTextureMatchLevel (const Texture &texture, const Request &compositionReq) const
	Gets color texture match level for given requirements.

void	markColorRenderbufferUnused (RenderbufferSharedPtr colorRenderbuffer)
	Marks a given color renderbuffer as available.

void	markDepthTextureUnused (TextureSharedPtr depthTexture)
	Marks a given depth texture as available.

void	markTextureUnused (TextureSharedPtr texture)
	Marks a given color texture as available.

Detailed Description

Composition manager.

Used for storing and managing composition targets and keeping track of their use. The rationale is to minimize memory used by composition targets.

Member Typedef Documentation

◆ AvailableRenderbufferContainer

using kanzi::CompositionManager::AvailableRenderbufferContainer

Storage type for available renderbuffers.

Since: Kanzi 3.9.6

◆ AvailableTextureContainer

using kanzi::CompositionManager::AvailableTextureContainer

Storage type for available textures.

Since: Kanzi 3.9.6

◆ AvailableTextureSpan

using kanzi::CompositionManager::AvailableTextureSpan

Span type for available textures.

Since: Kanzi 3.9.6

◆ UsedTextureSpan

using kanzi::CompositionManager::UsedTextureSpan

Span type for used textures.

Since: Kanzi 3.9.6

Constructor & Destructor Documentation

◆ CompositionManager()

kanzi::CompositionManager::CompositionManager ( ResourceManager * resourceManager )

explicit

Constructor.

Parameters

resourceManager Resource manager owning this composition manager.

◆ ~CompositionManager()

virtual kanzi::CompositionManager::~CompositionManager ( )

virtualdefault

Destructor.

Member Function Documentation

◆ initialize()

void kanzi::CompositionManager::initialize ( Renderer & renderer )

Initializes the composition manager.

Should be run after Renderer is initialized.

Parameters

renderer Renderer to retrieve information about supported composition types from.

◆ clear()

void kanzi::CompositionManager::clear ( )

Removes all allocated temporary composition targets.

◆ pruneUnusedTargets()

void kanzi::CompositionManager::pruneUnusedTargets ( )

Prunes unused composition targets from free lists.

Since: Kanzi 3.9.5

◆ acquireTemporaryCompositionTarget() [1/6]

virtual Target kanzi::CompositionManager::acquireTemporaryCompositionTarget ( const Request & compositionReq )

virtual

Requests a composition target.

Parameters

compositionReq Request details.

Returns: Composition target that fulfills the requirements.

◆ acquireTemporaryCompositionTarget() [2/6]

TextureSharedPtr kanzi::CompositionManager::acquireTemporaryCompositionTarget ( const CompositionContentRequirements & requirements )

inline

Requests a composition target.

Parameters

requirements Content requirements details.

Returns: Framebuffer that fulfills the requirements.

Since: Kanzi 3.9.7

◆ acquireTemporaryCompositionTarget() [3/6]

TextureSharedPtr kanzi::CompositionManager::acquireTemporaryCompositionTarget	(	unsigned int	width,
		unsigned int	height,
		GraphicsFormat	colorFormat,
		GraphicsFormat	depthStencilFormat )

inline

Requests a composition target.

This function returns only the color texture element of the composition target.

Parameters

width	Requested width.
height	Requested height.
colorFormat	Color buffer format.
depthStencilFormat	Depth and/or stencil buffer format.

Returns: Framebuffer that fulfills the requirements.

◆ acquireTemporaryCompositionTarget() [4/6]

TextureSharedPtr kanzi::CompositionManager::acquireTemporaryCompositionTarget	(	unsigned int	width,
		unsigned int	height,
		GraphicsFormat	colorFormat,
		GraphicsFormat	depthStencilFormat,
		unsigned int	numSamples )

Requests a composition target.

This function returns only the color texture element of the composition target.

Parameters

width	Requested width.
height	Requested height.
colorFormat	Color buffer format.
depthStencilFormat	Depth and/or stencil buffer format.
numSamples	Requested number of samples.

Returns: Framebuffer that fulfills the requirements.

Since: Kanzi 3.9.7

◆ acquireTemporaryCompositionTarget() [5/6]

TextureSharedPtr kanzi::CompositionManager::acquireTemporaryCompositionTarget	(	unsigned int	width,
		unsigned int	height,
		bool	alpha,
		bool	depth,
		bool	stencil )

inline

Requests a composition target.

This function returns only the color texture element of the composition target.

Parameters

width	Requested width.
height	Requested height.
alpha	Whether to request the alpha channel.
depth	Whether to request the depth buffer.
stencil	Whether to request the stencil buffer.

Returns: Framebuffer that fulfills the requirements.

◆ acquireTemporaryCompositionTarget() [6/6]

TextureSharedPtr kanzi::CompositionManager::acquireTemporaryCompositionTarget	(	unsigned int	width,
		unsigned int	height,
		bool	alpha,
		bool	depth,
		bool	stencil,
		unsigned int	numSamples )

inline

Requests a composition target.

This function returns only the color texture element of the composition target.

Parameters

width	Requested width.
height	Requested height.
alpha	Whether to request the alpha channel.
depth	Whether to request the depth buffer.
stencil	Whether to request the stencil buffer.
numSamples	Requested number of samples.

Returns: Framebuffer that fulfills the requirements.

Since: Kanzi 3.9.7

◆ releaseTemporaryCompositionTarget()

virtual void kanzi::CompositionManager::releaseTemporaryCompositionTarget ( const Target & target )

virtual

Releases an earlier composition target.

This, released composition target may be re-used by successive requests.

Parameters

target Target to release.

◆ createPersistentCompositionTarget() [1/3]

virtual Target kanzi::CompositionManager::createPersistentCompositionTarget ( const Request & compositionReq )

virtual

Creates a persistent composition target.

Caller has ownership of all the components of this composition target, it is not stored within the composition manager.

Parameters

compositionReq Request details.

Returns: Composition target that fulfills the requirements.

◆ createPersistentCompositionTarget() [2/3]

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

Creates a persistent composition target.

This function returns only the color texture element of the composition target. The caller of this function has ownership of this composition target. Kanzi does not store the composition target within the composition manager.

Parameters

width	Requested width.
height	Requested height.
colorFormat	Color buffer format.
depthStencilFormat	Depth and/or stencil buffer format.
addressingMode	Addressing mode (wrap/clamp/etc.).

Returns: Composition target that fulfills the requirements.

◆ createPersistentCompositionTarget() [3/3]

TextureSharedPtr kanzi::CompositionManager::createPersistentCompositionTarget	(	unsigned int	width,
		unsigned int	height,
		bool	alpha,
		bool	depth,
		bool	stencil )

inline

Creates a persistent composition target.

This function returns only the color texture element of the composition target. The caller of this function has ownership of this composition target. Kanzi does not store the composition target within the composition manager.

Parameters

width	Requested width.
height	Requested height.
alpha	Whether to require the alpha channel.
depth	Whether to require the depth buffer.
stencil	Whether to require the stencil buffer.

Returns: Composition target that fulfills the requirements.

◆ createPersistentTexture()

TextureSharedPtr kanzi::CompositionManager::createPersistentTexture ( const CompositionManager::Request & compositionReq )

Creates a persistent color texture.

Note that the color format of this texture may be GraphicsFormatNone.

Parameters

compositionReq Request details.

Returns: New color texture according to requirements.

◆ createPersistentColorRenderbuffer()

RenderbufferSharedPtr kanzi::CompositionManager::createPersistentColorRenderbuffer ( const CompositionManager::Request & compositionReq )

Creates a persistent color renderbuffer.

Parameters

compositionReq Request details.

Returns: New color renderbuffer according to requirements.

◆ createPersistentDepthStencilRenderbuffer() [1/3]

virtual RenderbufferSharedPtr kanzi::CompositionManager::createPersistentDepthStencilRenderbuffer ( const CompositionManager::Request & compositionReq )

virtual

Creates a persistent depth and/or stencil renderbuffer.

Parameters

compositionReq Request details.

Returns: New depth and/or stencil renderbuffer according to requirements.

◆ createPersistentDepthStencilRenderbuffer() [2/3]

RenderbufferSharedPtr kanzi::CompositionManager::createPersistentDepthStencilRenderbuffer	(	unsigned int	width,
		unsigned int	height,
		GraphicsFormat	depthStencilFormat,
		unsigned int	samples )

Creates a persistent depth and/or stencil renderbuffer.

Parameters

width	The width of the renderbuffer.
height	The height of the renderbuffer.
depthStencilFormat	Depth or stencil format.
samples	Number of samples.

Returns: New depth and/or stencil renderbuffer according to requirements.

◆ createPersistentDepthStencilRenderbuffer() [3/3]

RenderbufferSharedPtr kanzi::CompositionManager::createPersistentDepthStencilRenderbuffer	(	unsigned int	width,
		unsigned int	height,
		bool	depth,
		bool	stencil,
		unsigned int	samples )

Creates a persistent depth and/or stencil renderbuffer.

Parameters

width	The width of the renderbuffer.
height	The height of the renderbuffer.
depth	If depth is required true, otherwise false.
stencil	If stencil is required true, otherwise false.
samples	Number of samples.

Returns: New depth and/or stencil renderbuffer according to requirements.

◆ createPersistentDepthTexture()

TextureSharedPtr kanzi::CompositionManager::createPersistentDepthTexture ( const CompositionManager::Request & compositionReq )

Creates a persistent depth texture.

Parameters

compositionReq Request details.

Returns: New depth texture according to requirements.

◆ compositionTargetMatches() [1/5]

bool kanzi::CompositionManager::compositionTargetMatches	(	const Target &	target,
		const Request &	compositionReq,
		float	downScaleLimit ) const

Checks if a given composition target is an acceptable match for given requirements.

Parameters

target	Composition target to test.
compositionReq	Request details.
downScaleLimit	Limit for matching against smaller composition targets.

Returns: True if acceptable, false if not.

◆ compositionTargetMatches() [2/5]

bool kanzi::CompositionManager::compositionTargetMatches	(	const Target &	target,
		const Request &	compositionReq ) const

inline

Checks if a given composition target texture is an acceptable match for given requirements.

Parameters

target	Composition target to test.
compositionReq	Request details.

Returns: True if acceptable, false if not.

◆ compositionTargetMatches() [3/5]

bool kanzi::CompositionManager::compositionTargetMatches	(	TextureSharedPtr	texture,
		unsigned int	width,
		unsigned int	height,
		GraphicsFormat	colorFormat,
		GraphicsFormat	depthStencilFormat ) const

inline

Checks if a given composition target texture is an acceptable match for given requirements.

Tolerance for how much smaller composition targets are accepted is determined automatically.

Parameters

texture	Composition target texture to test.
width	Requested width.
height	Requested height.
colorFormat	Color buffer format.
depthStencilFormat	Depth/stencil buffer format.

Returns: True if acceptable, false if not.

◆ compositionTargetMatches() [4/5]

bool kanzi::CompositionManager::compositionTargetMatches	(	TextureSharedPtr	texture,
		unsigned int	width,
		unsigned int	height,
		bool	alpha,
		bool	depth,
		bool	stencil,
		float	downScaleLimit ) const

inline

Checks if a given composition target texture is an acceptable match for given requirements.

Determines color, depth and stencil formats from on/off boolean values.

Parameters

texture	Composition target texture to test.
width	Requested width.
height	Requested height.
alpha	Alpha channel requirement.
depth	Depth buffer requirement.
stencil	Stencil buffer requirement.
downScaleLimit	Limit for matching against smaller composition targets.

Returns: True if acceptable, false if not.

◆ compositionTargetMatches() [5/5]

bool kanzi::CompositionManager::compositionTargetMatches	(	TextureSharedPtr	texture,
		unsigned int	width,
		unsigned int	height,
		bool	alpha,
		bool	depth,
		bool	stencil ) const

inline

Checks if a given composition target texture is an acceptable match for given requirements.

Determines color, depth and stencil formats from on/off boolean values. Tolerance for how much smaller composition targets are accepted is determined automatically.

Parameters

texture	Composition target texture to test.
width	Requested width.
height	Requested height.
alpha	Alpha channel requirement.
depth	Depth buffer requirement.
stencil	Stencil buffer requirement.

Returns: True if acceptable, false if not.

◆ colorTextureMatches()

bool kanzi::CompositionManager::colorTextureMatches	(	const Texture &	texture,
		const Request &	compositionReq ) const

inline

Returns whether a given color texture matches composition requirements.

Parameters

texture	Texture to test.
compositionReq	Request details.

Returns: True if match, false otherwise.

◆ colorRenderbufferMatches()

bool kanzi::CompositionManager::colorRenderbufferMatches	(	const Renderbuffer &	renderbuffer,
		const Request &	compositionReq ) const

inline

Returns whether a given color render buffer matches composition requirements.

Parameters

renderbuffer	Renderbuffer to test.
compositionReq	Request details.

◆ depthTextureMatches()

bool kanzi::CompositionManager::depthTextureMatches	(	const Texture &	texture,
		const Request &	compositionReq ) const

inline

Returns whether a given depth texture matches composition requirements.

Parameters

texture	Texture to test.
compositionReq	Request details.

Returns: If the texture matches the requirements, true, otherwise false.

◆ getColorFormat()

GraphicsFormat kanzi::CompositionManager::getColorFormat ( bool alpha ) const

inline

Gets color texture format format depending on alpha requirement.

Parameters

alpha Whether to require alpha.

Returns: Color texture format.

◆ getDepthTextureFormat()

GraphicsFormat kanzi::CompositionManager::getDepthTextureFormat ( ) const

inline

Gets format for depth textures.

Returns: Depth texture format.

◆ getDepthStencilFormat()

GraphicsFormat kanzi::CompositionManager::getDepthStencilFormat	(	bool	depth,
		bool	stencil ) const

inline

Gets the depth or stencil renderbuffer format depending on requirements.

Parameters

depth	Whether to require depth.
stencil	Whether to require stencil.

Returns: Depth or stencil renderbuffer format.

◆ getDepthRenderbufferFormat()

GraphicsFormat kanzi::CompositionManager::getDepthRenderbufferFormat ( ) const

inline

Gets depth renderbuffer format.

Returns: Depth renderbuffer format.

◆ getDepthStencilRenderbufferFormat()

GraphicsFormat kanzi::CompositionManager::getDepthStencilRenderbufferFormat ( ) const

inline

Gets depth + stencil format.

Returns: Depth + stencil renderbuffer format.

◆ getStencilRenderbufferFormat()

GraphicsFormat kanzi::CompositionManager::getStencilRenderbufferFormat ( ) const

inline

Gets stencil renderbuffer format.

Returns: Stencil renderbuffer format.

◆ getAvailableTextures()

AvailableTextureSpan kanzi::CompositionManager::getAvailableTextures ( ) const

inline

Gets a span over the available textures.

Do not call this function directly. Kanzi uses this function for internal verification.

Returns: Span over the available texture array.

Since: Kanzi 3.9.6

◆ getUsedTextures()

UsedTextureSpan kanzi::CompositionManager::getUsedTextures ( ) const

inline

Gets a span over the textures that are in use.

Do not call this function directly. Kanzi uses this function for internal verification.

Returns: Span over the used texture array.

Since: Kanzi 3.9.6

◆ getUnusedTargetCounts()

void kanzi::CompositionManager::getUnusedTargetCounts	(	size_t &	textures,
		size_t &	renderBuffers,
		size_t &	depthTextures )

inline

Gets the numbers of unused composition targets for statistics and test purposes.

Parameters

textures	Number of available color textures.
renderBuffers	Number of available color renderbuffers.
depthTextures	Number of available depth textures.

◆ getReuseParameters()

ReuseParameters kanzi::CompositionManager::getReuseParameters ( ) const

inline

Gets the reuse and pruning parameters for unused composition targets.

Returns: A struct that contains the reuse and pruning parameters.

See also: ReuseParameters

Since: Kanzi 3.9.5

◆ setReuseParameters()

void kanzi::CompositionManager::setReuseParameters ( const ReuseParameters & reuseParameters )

inline

Sets the reuse and pruning parameters for unused composition targets.

Parameters

reuseParameters The struct that contains the reuse and pruning parameters.

See also: ReuseParameters

Since: Kanzi 3.9.5

◆ createTemporaryCompositionTarget()

Target kanzi::CompositionManager::createTemporaryCompositionTarget	(	const CompositionManager::Request &	compositionReq,
		TextureSharedPtr	texture,
		RenderbufferSharedPtr	colorRenderbuffer,
		TextureSharedPtr	depthTexture )

protected

Creates a temporary composition target.

Called internally from within acquireTemporaryCompositionTarget() if suitable existing elements are not found. Adds the components of the temporary composition target to the arrays of resources in use.

Parameters

compositionReq	Request details.
texture	Existing main texture most closely matching the requirements.
colorRenderbuffer	Existing color renderbuffer most closely matching the requirements.
depthTexture	Existing depth texture most closely matching the requirements.

Returns: Composition target that fulfills the requirements.

◆ getTextureMatchLevel()

unsigned int kanzi::CompositionManager::getTextureMatchLevel	(	const Texture &	texture,
		const Request &	compositionReq ) const

protected

Gets color texture match level for given requirements.

Parameters

texture	Texture to test.
compositionReq	Request details.

Returns: 0 if no match, 1 if exact match, greater values if size of texture exceeds requested size.

◆ getColorRenderbufferMatchLevel()

unsigned int kanzi::CompositionManager::getColorRenderbufferMatchLevel	(	const Renderbuffer &	renderbuffer,
		const Request &	compositionReq ) const

protected

Gets color renderbuffer match level for given requirements.

Parameters

renderbuffer	Renderbuffer to test.
compositionReq	Request details.

Returns: 0 if no match, 1 if exact match, greater values if size of renderbuffer exceeds requested size.

◆ getDepthTextureMatchLevel()

unsigned int kanzi::CompositionManager::getDepthTextureMatchLevel	(	const Texture &	texture,
		const Request &	compositionReq ) const

protected

Gets depth texture match level for given requirements.

Parameters

texture	Texture to test.
compositionReq	Request details.

Returns: 0 if no match, 1 if exact match, greater values if size of texture exceeds requested size.

◆ findClosestTexture()

TextureSharedPtr kanzi::CompositionManager::findClosestTexture ( const CompositionManager::Request & compositionReq )

protected

Finds the color texture, which most closely matches a given composition requirement, and marks it used.

Parameters

compositionReq Request details.

Returns: Color texture most closely matching given requirements or an empty shared pointer.

◆ findClosestColorRenderbuffer()

RenderbufferSharedPtr kanzi::CompositionManager::findClosestColorRenderbuffer ( const CompositionManager::Request & compositionReq )

protected

Finds the renderbuffer, which most closely matches a given composition requirement, and marks it used.

Parameters

compositionReq Request details.

Returns: Color renderbuffer most closely matching given requirements or an empty shared pointer.

◆ findClosestDepthTexture()

TextureSharedPtr kanzi::CompositionManager::findClosestDepthTexture ( const CompositionManager::Request & compositionReq )

protected

Finds the depth texture, which most closely matches a given composition requirement, and marks it used.

Parameters

compositionReq Request details.

Returns: Depth texture most closely matching given requirements or an empty shared pointer.

◆ markTextureUnused()

void kanzi::CompositionManager::markTextureUnused ( TextureSharedPtr texture )

protected

Marks a given color texture as available.

The texture must exist in used color textures.

Parameters

texture Texture to mark as used.

◆ markColorRenderbufferUnused()

void kanzi::CompositionManager::markColorRenderbufferUnused ( RenderbufferSharedPtr colorRenderbuffer )

protected

Marks a given color renderbuffer as available.

The renderbuffer must exist in used color renderbuffers.

Parameters

colorRenderbuffer Renderbuffer to mark as used.

◆ markDepthTextureUnused()

void kanzi::CompositionManager::markDepthTextureUnused ( TextureSharedPtr depthTexture )

protected

Marks a given depth texture as available.

The texture must exist in used depth textures.

Parameters

depthTexture Texture to mark as used.

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

kanzi/core.ui/graphics2d/composition_manager.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ AvailableRenderbufferContainer

◆ AvailableTextureContainer

◆ AvailableTextureSpan

◆ UsedTextureSpan

Constructor & Destructor Documentation

◆ CompositionManager()

◆ ~CompositionManager()

Member Function Documentation

◆ initialize()

◆ clear()

◆ pruneUnusedTargets()

◆ acquireTemporaryCompositionTarget() [1/6]

◆ acquireTemporaryCompositionTarget() [2/6]

◆ acquireTemporaryCompositionTarget() [3/6]

◆ acquireTemporaryCompositionTarget() [4/6]

◆ acquireTemporaryCompositionTarget() [5/6]

◆ acquireTemporaryCompositionTarget() [6/6]

◆ releaseTemporaryCompositionTarget()

◆ createPersistentCompositionTarget() [1/3]

◆ createPersistentCompositionTarget() [2/3]

◆ createPersistentCompositionTarget() [3/3]

◆ createPersistentTexture()

◆ createPersistentColorRenderbuffer()

◆ createPersistentDepthStencilRenderbuffer() [1/3]

◆ createPersistentDepthStencilRenderbuffer() [2/3]

◆ createPersistentDepthStencilRenderbuffer() [3/3]

◆ createPersistentDepthTexture()

◆ compositionTargetMatches() [1/5]

◆ compositionTargetMatches() [2/5]

◆ compositionTargetMatches() [3/5]

◆ compositionTargetMatches() [4/5]

◆ compositionTargetMatches() [5/5]

◆ colorTextureMatches()

◆ colorRenderbufferMatches()

◆ depthTextureMatches()

◆ getColorFormat()

◆ getDepthTextureFormat()

◆ getDepthStencilFormat()

◆ getDepthRenderbufferFormat()

◆ getDepthStencilRenderbufferFormat()

◆ getStencilRenderbufferFormat()

◆ getAvailableTextures()

◆ getUsedTextures()

◆ getUnusedTargetCounts()

◆ getReuseParameters()

◆ setReuseParameters()

◆ createTemporaryCompositionTarget()

◆ getTextureMatchLevel()

◆ getColorRenderbufferMatchLevel()

◆ getDepthTextureMatchLevel()

◆ findClosestTexture()

◆ findClosestColorRenderbuffer()

◆ findClosestDepthTexture()

◆ markTextureUnused()

◆ markColorRenderbufferUnused()

◆ markDepthTextureUnused()