Represents IVI layer. More...

#include <kanzi/core.ui/platform/windowing_ng/wayland_ivi_egl/wayland_ivi_layer.hpp>

Public Member Functions
void	bindSurface (uint32_t surfaceId) const noexcept
	Assigns surface to this layer. More...

void	clear () const noexcept
	Requests the compositor to remove all surfaces from this layer. More...

void	configure (const IVILayerProps &layerProps) const noexcept
	Helper function that requests the compositor to change surface state to match the provided properties. More...

KZ_NO_DISCARD uint32_t	getLayerId () const noexcept
	Gets the layer ID. More...

KZ_NO_DISCARD const IVILayerProps &	getProps () const noexcept
	Gets the internal layer state. More...

KZ_NO_DISCARD bool	isCreated () const noexcept
	Gets the `m_isCreated` value. More...

	IVILayer (IVIWM &iviWM, const IVILayerProps &iviLayerProps) noexcept
	Constructor. More...

	IVILayer (const IVILayer &)=delete
	Copy constructor. More...

	IVILayer (IVILayer &&) noexcept=delete
	Move constructor. More...

IVILayer &	operator= (const IVILayer &)=delete
	Copy assignment operator. More...

IVILayer &	operator= (IVILayer &&) noexcept=delete
	Move assignment operator. More...

void	releaseSurface (uint32_t surfaceId) const noexcept
	Removes surface from this layer. More...

void	setCreated (bool value) noexcept
	Sets the `m_isCreated` value. More...

void	setDestination (int32_t x, int32_t y, int32_t width, int32_t height) const noexcept
	Requests compositor to change destination rectangle. More...

void	setOpacity (double opacity) const noexcept
	Requests compositor to change opacity. More...

void	setProps (const IVILayerProps &props) noexcept
	Sets the internal layer state. More...

void	setSource (int32_t x, int32_t y, int32_t width, int32_t height) const noexcept
	Requests compositor to change source rectangle. More...

void	setVisibility (uint32_t visibility) const noexcept
	Requests compositor to change visibility. More...

void	syncStart () const noexcept
	Requests the compositor to start sending the event about the layer changes. More...

void	syncStop () const noexcept
	Requests the compositor to stop sending the event about the layer changes. More...

	~IVILayer ()
	Destructor. More...

Detailed Description

Represents IVI layer.

Since: Kanzi 3.9.8

Constructor & Destructor Documentation

kanzi::wayland::IVILayer::IVILayer	(	IVIWM &	iviWM,
		const IVILayerProps &	iviLayerProps
	)

explicitnoexcept

Constructor.

Parameters

iviWM	IVIWM object.
iviLayerProps	Layer properties to use for this layer.

kanzi::wayland::IVILayer::~IVILayer ( )

Destructor.

kanzi::wayland::IVILayer::IVILayer ( const IVILayer & )

delete

Copy constructor.

kanzi::wayland::IVILayer::IVILayer ( IVILayer && )

deletenoexcept

Move constructor.

Member Function Documentation

IVILayer& kanzi::wayland::IVILayer::operator= ( const IVILayer & )

delete

Copy assignment operator.

IVILayer& kanzi::wayland::IVILayer::operator= ( IVILayer && )

deletenoexcept

Move assignment operator.

void kanzi::wayland::IVILayer::bindSurface ( uint32_t surfaceId ) const

noexcept

Assigns surface to this layer.

Parameters

surfaceId Surface ID.

void kanzi::wayland::IVILayer::releaseSurface ( uint32_t surfaceId ) const

noexcept

Removes surface from this layer.

Parameters

surfaceId Surface ID.

void kanzi::wayland::IVILayer::setSource	(	int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height
	)		const

noexcept

Requests compositor to change source rectangle.

Parameters

x	X coordinate.
y	Y coordinate.
width	Width.
height	Height.

void kanzi::wayland::IVILayer::setDestination	(	int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height
	)		const

noexcept

Requests compositor to change destination rectangle.

Parameters

x	X coordinate.
y	Y coordinate.
width	Width.
height	Height.

void kanzi::wayland::IVILayer::setVisibility ( uint32_t visibility ) const

noexcept

Requests compositor to change visibility.

Parameters

visibility Visibility to set.

void kanzi::wayland::IVILayer::setOpacity ( double opacity ) const

noexcept

Requests compositor to change opacity.

Parameters

opacity Opacity value.

void kanzi::wayland::IVILayer::configure ( const IVILayerProps & layerProps ) const

noexcept

Helper function that requests the compositor to change surface state to match the provided properties.

Parameters

layerProps Properties to use.

void kanzi::wayland::IVILayer::syncStart ( ) const

noexcept

Requests the compositor to start sending the event about the layer changes.

See also: syncStop()

void kanzi::wayland::IVILayer::syncStop ( ) const

noexcept

Requests the compositor to stop sending the event about the layer changes.

See also: syncStart()

void kanzi::wayland::IVILayer::clear ( ) const

noexcept

Requests the compositor to remove all surfaces from this layer.

KZ_NO_DISCARD bool kanzi::wayland::IVILayer::isCreated ( ) const

noexcept

Gets the m_isCreated value.

Return values

true	Layer was created.
false	Layer was not created.

void kanzi::wayland::IVILayer::setCreated ( bool value )

noexcept

Sets the m_isCreated value.

Parameters

value Value to set.

KZ_NO_DISCARD uint32_t kanzi::wayland::IVILayer::getLayerId ( ) const

noexcept

Gets the layer ID.

Returns: layer ID.

KZ_NO_DISCARD const IVILayerProps& kanzi::wayland::IVILayer::getProps ( ) const

noexcept

Gets the internal layer state.

Returns: Internal layer state.

void kanzi::wayland::IVILayer::setProps ( const IVILayerProps & props )

noexcept

Sets the internal layer state.

Parameters

props Properties to use.

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

kanzi/core.ui/platform/windowing_ng/wayland_ivi_egl/wayland_ivi_layer.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation