OpenGL render state. More...

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

Classes
class	RenderValueInfo
	Render value information. More...

union	RenderValueUnion
	Union containing one render value to be arranged into an array. More...

struct	TextureRenderValue
	Container for texture render value and the width/height uniforms. More...

Public Types
using	HandleType = int
	Type for handle identifiers into values in the render state. More...

Public Member Functions
void	attach (MaterialSharedPtr material)
	Attach to a certain material/node combination. More...

bool	bind (Renderer &renderer)
	Applies the render state the render state. More...

optional< int >	getBlendModeValue () const
	Get blend mode value. More...

template<typename T >
size_t	getElementCount (GlRenderState::HandleType handle) const
	Gets the number of elements for given handle. More...

template<>
size_t	getElementCount (GlRenderState::HandleType handle) const
	GlRenderState::getElementCount() specialization. More...

template<typename T >
HandleType	getHandle (string_view name)
	Access handle by type. More...

template<>
GlRenderState::HandleType	getHandle (string_view name)
	GlRenderState::getHandle() specialization. More...

MaterialSharedPtr	getMaterial () const
	Gets the attached material. More...

template<typename T >
T	getValue (HandleType handle, size_t index) const
	Accesses a value by handle. More...

template<typename T >
T	getValue (HandleType handle) const
	Accesses a value by handle. More...

template<>
TextureSharedPtr	getValue (GlRenderState::HandleType handle) const
	GlRenderState::getValue() specialization. More...

	GlRenderState ()
	Empty constructor. More...

template<typename T >
bool	handleMatches (HandleType handle, string_view name) const
	Checks whether given handle matches the current render state. More...

template<>
bool	handleMatches (GlRenderState::HandleType handle, string_view name) const
	GlRenderState::handleMatches() specialization. More...

bool	hasMaterial () const
	Returns whether the render state has a valid material. More...

void	reattach ()
	Reattach already-attached material. More...

void	setBlendModeValue (optional< int > value)
	Sets the blend mode value. More...

bool	setRange (HandleType handle, AbstractRange &range)
	Sets values of a render target array from a range. More...

bool	setRange (HandleType handle, AbstractRange *range)
	Sets values of a render target array from a range. More...

bool	setRange (HandleType handle, AbstractRangeSharedPtr range)
	Sets values of a render target array from a range. More...

template<typename T >
void	setValue (HandleType handle, const T &value, size_t elementIndex)
	Set a render value identified by handle. More...

template<typename T >
void	setValue (HandleType handle, const T &value)
	Wrapper for setting a render value by handle. More...

Protected Types
typedef vector< RenderValueInfo >	RenderValueInfoContainer
	Container for render value information. More...

typedef vector< RenderValueUnion >	RenderValueUnionContainer
	Container for render values. More...

typedef vector< TextureRenderValue >	TextureRenderValueContainer
	Container for texture render values. More...

Detailed Description

OpenGL render state.

Member Typedef Documentation

◆ HandleType

using kanzi::GlRenderState::HandleType = int

Type for handle identifiers into values in the render state.

◆ RenderValueInfoContainer

typedef vector<RenderValueInfo> kanzi::GlRenderState::RenderValueInfoContainer

protected

Container for render value information.

◆ RenderValueUnionContainer

typedef vector<RenderValueUnion> kanzi::GlRenderState::RenderValueUnionContainer

protected

Container for render values.

◆ TextureRenderValueContainer

typedef vector<TextureRenderValue> kanzi::GlRenderState::TextureRenderValueContainer

protected

Container for texture render values.

Constructor & Destructor Documentation

◆ GlRenderState()

kanzi::GlRenderState::GlRenderState ( )

inlineexplicit

Empty constructor.

Member Function Documentation

◆ bind()

bool kanzi::GlRenderState::bind ( Renderer & renderer )

Applies the render state the render state.

After calling this function, geometry can be rendered using the render state settings.

Parameters

renderer Renderer to use.

Returns: If the shader program was available and bound, true, otherwise false.

◆ attach()

void kanzi::GlRenderState::attach ( MaterialSharedPtr material )

Attach to a certain material/node combination.

Parameters

material Material to attach to.

◆ reattach()

void kanzi::GlRenderState::reattach ( )

Reattach already-attached material.

Does nothing if no material attached.

◆ getMaterial()

MaterialSharedPtr kanzi::GlRenderState::getMaterial ( ) const

inline

Gets the attached material.

Returns: Shared pointer to material.

◆ hasMaterial()

bool kanzi::GlRenderState::hasMaterial ( ) const

inline

Returns whether the render state has a valid material.

Returns: If a valid material is attached, true, otherwise false.

◆ setValue() [1/2]

template<typename T >

void kanzi::GlRenderState::setValue	(	HandleType	handle,
		const T &	value,
		size_t	elementIndex
	)

inline

Set a render value identified by handle.

The handle may be invalid (negative), in which case this function does nothing.

Parameters

handle	Identifying handle.
value	Value to set.
elementIndex	Index of the element in the value to set.

◆ setValue() [2/2]

template<typename T >

void kanzi::GlRenderState::setValue	(	HandleType	handle,
		const T &	value
	)

inline

Wrapper for setting a render value by handle.

Element index is zero.

Parameters

handle	Identifying handle.
value	Value to set.

◆ getBlendModeValue()

optional<int> kanzi::GlRenderState::getBlendModeValue ( ) const

inline

Get blend mode value.

Returns: Optional blend mode value.

Since: Kanzi 3.9.1 return data type changed from optional<GraphicsBlendMode> to optional<int>.

◆ setBlendModeValue()

void kanzi::GlRenderState::setBlendModeValue ( optional< int > value )

inline

Sets the blend mode value.

Parameters

value Optional blend mode value.

Since: Kanzi 3.9.1 data type of value parameter changed from GraphicsBlendMode to optional<int>.

◆ getHandle() [1/2]

template<typename T >

HandleType kanzi::GlRenderState::getHandle ( string_view name )

inline

Access handle by type.

Parameters

name	Value name.

Returns: Handle (index) to info array.

◆ getElementCount() [1/2]

template<typename T >

size_t kanzi::GlRenderState::getElementCount ( GlRenderState::HandleType handle ) const

inline

Gets the number of elements for given handle.

Parameters

handle Handle.

Returns: Number of elements for the handle.

◆ getValue() [1/3]

template<typename T >

T kanzi::GlRenderState::getValue	(	HandleType	handle,
		size_t	index
	)		const

inline

Accesses a value by handle.

Handle must be valid, access with invalid handle is undefined behavior.

Parameters

handle	Handle to value.
index	Index of the value to access.

Returns: Value previously stored with the handle.

◆ getValue() [2/3]

template<typename T >

T kanzi::GlRenderState::getValue ( HandleType handle ) const

inline

Accesses a value by handle.

Index of the accessed value is zero.

Parameters

handle Handle to value.

Returns: Value previously stored with the handle.

◆ handleMatches() [1/2]

template<typename T >

bool kanzi::GlRenderState::handleMatches	(	HandleType	handle,
		string_view	name
	)		const

inline

Checks whether given handle matches the current render state.

Parameters

handle	Handle to check.
name	Name to compare against.

Returns: True if given handle and name match in the render state, false otherwise.

◆ setRange() [1/3]

bool kanzi::GlRenderState::setRange	(	HandleType	handle,
		AbstractRange &	range
	)

Sets values of a render target array from a range.

If the array is larger than the range, writes default values to the remaining values in the end of the array.

Parameters

handle	Handle from the render state.
range	Range input.

Returns: If value was successfully set, true, otherwise false.

Since: Kanzi 3.9.0

◆ setRange() [2/3]

bool kanzi::GlRenderState::setRange	(	HandleType	handle,
		AbstractRange *	range
	)

Sets values of a render target array from a range.

If the array is larger than the range, writes default values to the remaining values in the end of the array. If the range is a nullptr, sets all the elements of the render target array to default values.

Parameters

handle	Handle from the render state.
range	Range input.

Returns: If value was successfully set, true, otherwise false.

Since: Kanzi 3.9.0

◆ setRange() [3/3]

bool kanzi::GlRenderState::setRange	(	HandleType	handle,
		AbstractRangeSharedPtr	range
	)

Sets values of a render target array from a range.

If the array is larger than the range, writes default values to the remaining values in the end of the array. If the range is a nullptr, sets all the elements of the render target array to default values.

Parameters

handle	Handle from the render state.
range	Range input.

Returns: If value was successfully set, true, otherwise false.

Since: Kanzi 3.9.0

◆ getHandle() [2/2]

template<>

GlRenderState::HandleType kanzi::GlRenderState::getHandle ( string_view name )

GlRenderState::getHandle() specialization.

◆ handleMatches() [2/2]

template<>

bool kanzi::GlRenderState::handleMatches	(	GlRenderState::HandleType	handle,
		string_view	name
	)		const

GlRenderState::handleMatches() specialization.

◆ getValue() [3/3]

template<>

TextureSharedPtr kanzi::GlRenderState::getValue ( GlRenderState::HandleType handle ) const

GlRenderState::getValue() specialization.

◆ getElementCount() [2/2]

template<>

size_t kanzi::GlRenderState::getElementCount ( GlRenderState::HandleType handle ) const

GlRenderState::getElementCount() specialization.

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

kanzi/core.ui/platform/graphics_backend/gl/gl_render_state.hpp

Classes

Public Types

Public Member Functions

Protected Types

Detailed Description

Member Typedef Documentation

◆ HandleType

◆ RenderValueInfoContainer

◆ RenderValueUnionContainer

◆ TextureRenderValueContainer

Constructor & Destructor Documentation

◆ GlRenderState()

Member Function Documentation

◆ bind()

◆ attach()

◆ reattach()

◆ getMaterial()

◆ hasMaterial()

◆ setValue() [1/2]

◆ setValue() [2/2]

◆ getBlendModeValue()

◆ setBlendModeValue()

◆ getHandle() [1/2]

◆ getElementCount() [1/2]

◆ getValue() [1/3]

◆ getValue() [2/3]

◆ handleMatches() [1/2]

◆ setRange() [1/3]

◆ setRange() [2/3]

◆ setRange() [3/3]

◆ getHandle() [2/2]

◆ handleMatches() [2/2]

◆ getValue() [3/3]

◆ getElementCount() [2/2]