Composition manager. More...

#include <kanzi/core.ui/platform/graphics_backend/gl/composition_manager.hpp>

Classes
class	Request
	Composition request class. More...

class	Target
	Composition target. More...

Public Member Functions
	CompositionManager (ResourceManager *resourceManager)
	Constructor. More...

virtual	~CompositionManager ()
	Destructor. More...

void	initialize (Renderer &renderer)
	Initialize composition manager. More...

void	clear ()
	Remove all allocated temporary composition targets. More...

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

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

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

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

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

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

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

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

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

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

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

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

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. More...

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. More...

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. More...

bool	colorTextureMatches (const Texture &texture, const Request &compositionReq) const
	Tell if given color texture matches composition requirements. More...

bool	colorRenderbufferMatches (const Renderbuffer &renderbuffer, const Request &compositionReq) const
	Tell if given color render buffer matches composition requirements. More...

bool	depthTextureMatches (const Texture &texture, const Request &compositionReq) const
	Tell if given depth texture matches composition requirements. More...

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

GraphicsFormat	getDepthTextureFormat () const
	Gets format for depth textures. More...

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

GraphicsFormat	getDepthRenderbufferFormat () const
	Gets depth renderbuffer format. More...

GraphicsFormat	getDepthStencilRenderbufferFormat () const
	Gets depth + stencil format. More...

GraphicsFormat	getStencilRenderbufferFormat () const
	Gets stencil renderbuffer format. More...

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

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

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

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

TextureSharedPtr	findClosestTexture (const CompositionManager::Request &compositionReq)
	Finds the color texture most closely matching given composition requirement. More...

RenderbufferSharedPtr	findClosestColorRenderbuffer (const CompositionManager::Request &compositionReq)
	Finds the renderbuffer most closely matching given composition requirement. More...

TextureSharedPtr	findClosestDepthTexture (const CompositionManager::Request &compositionReq)
	Finds the depth texture most closely matching given composition requirement. More...

void	markTextureUsed (TextureSharedPtr texture)
	Mark given color texture as used. More...

void	markColorRenderbufferUsed (RenderbufferSharedPtr colorRenderbuffer)
	Mark given color renderbuffer as used. More...

void	markDepthTextureUsed (TextureSharedPtr depthTexture)
	Mark given depth texture as used. More...

void	markTextureUnused (TextureSharedPtr texture)
	Mark given color texture as available. More...

void	markColorRenderbufferUnused (RenderbufferSharedPtr colorRenderbuffer)
	Mark given color renderbuffer as available. More...

void	markDepthTextureUnused (TextureSharedPtr depthTexture)
	Mark given depth texture as available. More...

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.

Constructor & Destructor Documentation

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

explicit

Constructor.

Parameters

resourceManager	Resource manager owning this composition manager.
renderer	Renderer to query capabilities from.

virtual kanzi::CompositionManager::~CompositionManager ( )

inlinevirtual

Destructor.

Member Function Documentation

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

Initialize composition manager.

Should be run after Renderer is initialized.

Parameters

renderer Renderer to retrieve information about supported composition types from.

void kanzi::CompositionManager::clear ( )

Remove all allocated temporary composition targets.

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

virtual

Request a composition target.

Parameters

compositionReq Request details.

Returns: Composition target that fulfills the requirements.

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

Request a composition target.

Only the color texture element is returned.

Parameters

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

Returns: Framebuffer that fulfills the requirements.

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

inline

Request a composition target.

Only the color texture element is returned.

Parameters

width	Requested width.
height	Requested height.
alpha	Is alpha channel requested?
depth	Is depth buffer requested?
stencil	Is stencil buffer requested?

Returns: Framebuffer that fulfills the requirements.

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

virtual

Release an earlier composition target.

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

Parameters

target Target to release.

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

virtual

Create 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.

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

Create a persistent composition target.

Only the color texture element is returned. Caller has ownership of this composition target, it is not stored within the composition manager.

Parameters

width	Requested width.
height	Requested height.
colorFormat	Color buffer format.
depthStencilFormat	Depth/stencil buffer format.
addressingMode	Addressing mode (wrap/clamp/etc.).
mipmapMode	Mipmap mode (base/nearest/etc.).

Returns: Composition target that fulfills the requirements.

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

inline

Create a persistent composition target.

Only the color texture element is returned. Caller has ownership of this composition target, it is not stored within the composition manager. Determines color, depth and stencil formats from on/off boolean values.

Parameters

width	Requested width.
height	Requested height.
alpha	Alpha channel requirement.
depth	Depth buffer requirement.
stencil	Stencil buffer requirement.

Returns: Composition target that fulfills the requirements.

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

Create 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.

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

Create a persistent color renderbuffer.

Parameters

compositionReq Request details.

Returns: New color renderbuffer according to requirements.

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

Create a persistent depth texture.

Parameters

compositionReq Request details.

Returns: New depth texture according to requirements.

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.

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.
downScaleLimit	Limit for matching against smaller composition targets.

Returns: True if acceptable, false if not.

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.

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.

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

target	Composition target 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.

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

inline

Tell if given color texture matches composition requirements.

Parameters

texture	Texture to test.
compositionReq	Request details.

Returns: True if match, false otherwise.

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

inline

Tell if given color render buffer matches composition requirements.

Parameters

renderbuffer	Renderbuffer to test.
compositionReq	Request details.

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

inline

Tell if given depth texture matches composition requirements.

Parameters

texture	Texture to test.
compositionReq	Request details.

Returns: True if match, false otherwise.

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

inline

Gets color texture format format depending on alpha requirement.

Parameters

alpha Is alpha required?

Returns: Color texture format.

GraphicsFormat kanzi::CompositionManager::getDepthTextureFormat ( ) const

inline

Gets format for depth textures.

Returns: Depth texture format.

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

inline

Gets depth/stencil renderbuffer format depending on requirements.

Parameters

depth	Is depth required?
stencil	Is stencil required?

Returns: Depth/stencil renderbuffer format.

GraphicsFormat kanzi::CompositionManager::getDepthRenderbufferFormat ( ) const

inline

Gets depth renderbuffer format.

Returns: Depth renderbuffer format.

GraphicsFormat kanzi::CompositionManager::getDepthStencilRenderbufferFormat ( ) const

inline

Gets depth + stencil format.

Returns: Depth + stencil renderbuffer format.

GraphicsFormat kanzi::CompositionManager::getStencilRenderbufferFormat ( ) const

inline

Gets stencil renderbuffer format.

Returns: Stencil renderbuffer format.

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

protected

Create 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.

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

protected

Get 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.

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

protected

Get 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.

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

protected

Get 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.

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

protected

Finds the color texture most closely matching given composition requirement.

Parameters

compositionReq Request details.

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

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

protected

Finds the renderbuffer most closely matching given composition requirement.

Parameters

compositionReq Request details.

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

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

protected

Finds the depth texture most closely matching given composition requirement.

Parameters

compositionReq Request details.

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

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

protected

Mark given color texture as used.

The texture must exist in available color textures.

Parameters

texture Texture to mark as used.

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

protected

Mark given color renderbuffer as used.

The renderbuffer must exist in available color renderbuffers.

Parameters

colorRenderbuffer Renderbuffer to mark as used.

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

protected

Mark given depth texture as used.

The texture must exist in available depth textures.

Parameters

depthTexture Texture to mark as used.

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

protected

Mark given color texture as available.

The texture must exist in used color textures.

Parameters

texture Texture to mark as used.

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

protected

Mark given color renderbuffer as available.

The renderbuffer must exist in used color renderbuffers.

Parameters

colorRenderbuffer Renderbuffer to mark as used.

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

protected

Mark 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/platform/graphics_backend/gl/composition_manager.hpp

Classes

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation