kanzi::wayland::IviLayer Class Reference

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.
void	clear () const noexcept
	Requests the compositor to remove all surfaces from this layer.
void	configure (const IviLayerProps &layerProps) const noexcept
	Helper function that requests the compositor to change surface state to match the provided properties.
KZ_NO_DISCARD uint32_t	getLayerId () const noexcept
	Gets the layer ID.
KZ_NO_DISCARD const IviLayerProps &	getProps () const noexcept
	Gets the internal layer state.
KZ_NO_DISCARD bool	isCreated () const noexcept
	Gets the m_isCreated value.
	IviLayer (const IviLayer &)=delete
	Copy constructor.
	IviLayer (IviLayer &&) noexcept=delete
	Move constructor.
	IviLayer (IviWm &iviWm, const IviLayerProps &iviLayerProps) noexcept
	Constructor.
IviLayer &	operator= (const IviLayer &)=delete
	Copy assignment operator.
IviLayer &	operator= (IviLayer &&) noexcept=delete
	Move assignment operator.
void	releaseSurface (uint32_t surfaceId) const noexcept
	Removes surface from this layer.
void	setCreated (bool value) noexcept
	Sets the m_isCreated value.
void	setDestination (int32_t x, int32_t y, int32_t width, int32_t height) const noexcept
	Requests compositor to change destination rectangle.
void	setOpacity (double opacity) const noexcept
	Requests compositor to change opacity.
void	setProps (const IviLayerProps &props) noexcept
	Sets the internal layer state.
void	setSource (int32_t x, int32_t y, int32_t width, int32_t height) const noexcept
	Requests compositor to change source rectangle.
void	setVisibility (uint32_t visibility) const noexcept
	Requests compositor to change visibility.
void	syncStart () const noexcept
	Requests the compositor to start sending the event about the layer changes.
void	syncStop () const noexcept
	Requests the compositor to stop sending the event about the layer changes.
	~IviLayer ()
	Destructor.

Detailed Description

Represents IVI layer.

Since

Kanzi 3.9.8

Constructor & Destructor Documentation

IviLayer() [1/3]

kanzi::wayland::IviLayer::IviLayer ( IviWm & iviWm, const IviLayerProps & iviLayerProps )

explicitnoexcept

Constructor.

Parameters

iviWm	IviWm object.
iviLayerProps	Layer properties to use for this layer.

~IviLayer()

kanzi::wayland::IviLayer::~IviLayer

(

)

Destructor.

IviLayer() [2/3]

kanzi::wayland::IviLayer::IviLayer ( const IviLayer & )

delete

Copy constructor.

IviLayer() [3/3]

kanzi::wayland::IviLayer::IviLayer ( IviLayer && )

deletenoexcept

Move constructor.

Member Function Documentation

operator=() [1/2]

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

delete

Copy assignment operator.

operator=() [2/2]

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

deletenoexcept

Move assignment operator.

bindSurface()

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

noexcept

Assigns surface to this layer.

Parameters

surfaceId

Surface ID.

releaseSurface()

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

noexcept

Removes surface from this layer.

Parameters

surfaceId

Surface ID.

setSource()

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.

setDestination()

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.

setVisibility()

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

noexcept

Requests compositor to change visibility.

Parameters

visibility

Visibility to set.

setOpacity()

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

noexcept

Requests compositor to change opacity.

Parameters

opacity

Opacity value.

configure()

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.

syncStart()

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

noexcept

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

See also

syncStop()

syncStop()

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

noexcept

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

See also

syncStart()

clear()

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

noexcept

Requests the compositor to remove all surfaces from this layer.

isCreated()

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.

setCreated()

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

noexcept

Sets the m_isCreated value.

Parameters

value

Value to set.

getLayerId()

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

noexcept

Gets the layer ID.

Returns

layer ID.

getProps()

KZ_NO_DISCARD const IviLayerProps & kanzi::wayland::IviLayer::getProps ( ) const

noexcept

Gets the internal layer state.

Returns

Internal layer state.

setProps()

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