An abstraction class that allows to control IVI layers and surfaces. More...

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

Public Member Functions
void	bindLayer (uint32_t layerId) const noexcept
	Assigns a layer to the screen. More...

void	bindSurface (uint32_t surfaceId, uint32_t layerId) const
	Assigns a surface to the specified layer. More...

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

void	configureSurface (const IVISurfaceProps &surfaceProps) const
	Helper function that will request compositor to change surface state to match supplied properties. More...

void	createLayer (const IVILayerProps &iviLayerProps)
	Requests the compositor to create a layer. More...

void	createSurface (const IVISurfaceProps &iviSurfaceProps)
	Requests the compositor to create a surface. More...

KZ_NO_DISCARD const IVILayerProps &	getLayerProps (uint32_t layerId) const noexcept
	Gets the internal layer state. More...

KZ_NO_DISCARD windowing::Size	getResolution () const noexcept
	Gets screen resolution. More...

KZ_NO_DISCARD const IVISurfaceProps &	getSurfaceProps (uint32_t surfaceId) const noexcept
	Gets the internal surface state. More...

void	initializeLayer (const IVILayerProps &layerProps) const
	Helper function to set up a layer for use. More...

void	initializeSurface (const IVISurfaceProps &surfaceProps) const
	Helper function to set up a surface for use. More...

	IVILayoutManager (IVIWM &iviWM, const WaylandOutput &waylandOutput) noexcept
	Constructor. More...

void	layerCreatedNotification (uint32_t layerId)
	Called by Wayland listener when layer is created. More...

void	layerDestinationChangedNotification (uint32_t layerId, const windowing::Region &destination)
	Called by Wayland listener when layer destination rectangle changes. More...

void	layerDestroyedNotification (uint32_t layerId)
	Called by Wayland listener when layer is destroyed. More...

void	layerOpacityChangedNotification (uint32_t layerId, double opacity)
	Called by Wayland listener when layer opacity changes. More...

void	layerSourceChangedNotification (uint32_t layerId, const windowing::Region &source)
	Called by Wayland listener when layer source rectangle changes. More...

void	layerVisibilityChangedNotification (uint32_t layerId, int32_t visibility)
	Called by Wayland listener when layer visibility changes. More...

void	modeChangeNotification (int32_t width, int32_t height, int32_t refresh) noexcept
	Called by Wayland when screen properties change. More...

void	releaseLayer (uint32_t layerId) const noexcept
	Removes layer from the screen. More...

void	releaseSurface (uint32_t surfaceId, uint32_t layerId) const
	Removes a surface from the specified layer. More...

void	surfaceCreatedNotification (uint32_t surfaceId)
	Called by Wayland listener when surface has been created. More...

void	surfaceDestinationChangedNotification (uint32_t surfaceId, const windowing::Region &destination)
	Called by Wayland listener when surface destination rectangle changes. More...

void	surfaceDestroyedNotification (uint32_t surfaceId)
	Called by Wayland listener when surface is destroyed. More...

void	surfaceOpacityChangedNotification (uint32_t surfaceId, double opacity)
	Called by Wayland listener when surface opacity changes. More...

void	surfaceSourceChangedNotification (uint32_t surfaceId, const windowing::Region &source)
	Called by Wayland listener when surface source rectangle changes. More...

void	surfaceVisibilityChangedNotification (uint32_t surfaceId, int32_t visibility)
	Called by Wayland listener when surface visibility changes. More...

void	waitLayers (const WaylandDisplay &waylandDisplay) const
	Blocks until all layers are created by the compositor. More...

void	waitSurfaces (const WaylandDisplay &waylandDisplay) const
	Blocks until all surfaces are created by the compositor. More...

Detailed Description

An abstraction class that allows to control IVI layers and surfaces.

Since: Kanzi 3.9.8

Constructor & Destructor Documentation

kanzi::wayland::IVILayoutManager::IVILayoutManager	(	IVIWM &	iviWM,
		const WaylandOutput &	waylandOutput
	)

explicitnoexcept

Constructor.

Parameters

iviWM	IVIWM object.
waylandOutput	Associated WaylandOutput.

Member Function Documentation

void kanzi::wayland::IVILayoutManager::createLayer ( const IVILayerProps & iviLayerProps )

Requests the compositor to create a layer.

Parameters

iviLayerProps Layer ID.

void kanzi::wayland::IVILayoutManager::bindLayer ( uint32_t layerId ) const

noexcept

Assigns a layer to the screen.

Kanzi assumes that there is a single screen.

Parameters

layerId Layer ID.

void kanzi::wayland::IVILayoutManager::releaseLayer ( uint32_t layerId ) const

noexcept

Removes layer from the screen.

Kanzi assumes that there is a single screen.

Parameters

layerId Layer ID.

void kanzi::wayland::IVILayoutManager::createSurface ( const IVISurfaceProps & iviSurfaceProps )

Requests the compositor to create a surface.

Parameters

iviSurfaceProps Properties to use.

void kanzi::wayland::IVILayoutManager::bindSurface	(	uint32_t	surfaceId,
		uint32_t	layerId
	)		const

Assigns a surface to the specified layer.

Parameters

surfaceId	Surface ID.
layerId	Layer ID.

void kanzi::wayland::IVILayoutManager::releaseSurface	(	uint32_t	surfaceId,
		uint32_t	layerId
	)		const

Removes a surface from the specified layer.

Parameters

surfaceId	Surface ID.
layerId	Layer ID.

void kanzi::wayland::IVILayoutManager::initializeLayer ( const IVILayerProps & layerProps ) const

Helper function to set up a layer for use.

Parameters

layerProps Properties to use.

void kanzi::wayland::IVILayoutManager::initializeSurface ( const IVISurfaceProps & surfaceProps ) const

Helper function to set up a surface for use.

Parameters

surfaceProps Properties to use.

void kanzi::wayland::IVILayoutManager::configureLayer ( const IVILayerProps & layerProps ) const

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

Parameters

layerProps Properties to use.

void kanzi::wayland::IVILayoutManager::configureSurface ( const IVISurfaceProps & surfaceProps ) const

Helper function that will request compositor to change surface state to match supplied properties.

Parameters

surfaceProps Properties to use.

void kanzi::wayland::IVILayoutManager::waitLayers ( const WaylandDisplay & waylandDisplay ) const

Blocks until all layers are created by the compositor.

Parameters

waylandDisplay Associated WaylandDisplay.

void kanzi::wayland::IVILayoutManager::waitSurfaces ( const WaylandDisplay & waylandDisplay ) const

Blocks until all surfaces are created by the compositor.

Parameters

waylandDisplay Associated WaylandDisplay.

void kanzi::wayland::IVILayoutManager::layerCreatedNotification ( uint32_t layerId )

Called by Wayland listener when layer is created.

Parameters

layerId Layer ID.

void kanzi::wayland::IVILayoutManager::layerVisibilityChangedNotification	(	uint32_t	layerId,
		int32_t	visibility
	)

Called by Wayland listener when layer visibility changes.

Parameters

layerId	Layer ID.
visibility	New layer visibility.

void kanzi::wayland::IVILayoutManager::layerSourceChangedNotification	(	uint32_t	layerId,
		const windowing::Region &	source
	)

Called by Wayland listener when layer source rectangle changes.

Parameters

layerId	Layer ID.
source	New source rectangle.

void kanzi::wayland::IVILayoutManager::layerDestinationChangedNotification	(	uint32_t	layerId,
		const windowing::Region &	destination
	)

Called by Wayland listener when layer destination rectangle changes.

Parameters

layerId	Layer ID.
destination	New destination rectangle.

void kanzi::wayland::IVILayoutManager::layerOpacityChangedNotification	(	uint32_t	layerId,
		double	opacity
	)

Called by Wayland listener when layer opacity changes.

Parameters

layerId	Layer ID.
opacity	New layer opacity.

void kanzi::wayland::IVILayoutManager::surfaceCreatedNotification ( uint32_t surfaceId )

Called by Wayland listener when surface has been created.

Parameters

surfaceId Surface ID.

void kanzi::wayland::IVILayoutManager::surfaceVisibilityChangedNotification	(	uint32_t	surfaceId,
		int32_t	visibility
	)

Called by Wayland listener when surface visibility changes.

Parameters

surfaceId	Surface ID.
visibility	New surface visibility.

void kanzi::wayland::IVILayoutManager::surfaceSourceChangedNotification	(	uint32_t	surfaceId,
		const windowing::Region &	source
	)

Called by Wayland listener when surface source rectangle changes.

Parameters

surfaceId	Surface ID.
source	New source rectangle.

void kanzi::wayland::IVILayoutManager::surfaceDestinationChangedNotification	(	uint32_t	surfaceId,
		const windowing::Region &	destination
	)

Called by Wayland listener when surface destination rectangle changes.

Parameters

surfaceId	Surface ID.
destination	New destination rectangle.

void kanzi::wayland::IVILayoutManager::surfaceOpacityChangedNotification	(	uint32_t	surfaceId,
		double	opacity
	)

Called by Wayland listener when surface opacity changes.

Parameters

surfaceId	Surface ID.
opacity	New surface opacity.

void kanzi::wayland::IVILayoutManager::layerDestroyedNotification ( uint32_t layerId )

Called by Wayland listener when layer is destroyed.

Parameters

layerId Layer ID.

void kanzi::wayland::IVILayoutManager::surfaceDestroyedNotification ( uint32_t surfaceId )

Called by Wayland listener when surface is destroyed.

Parameters

surfaceId Surface ID.

void kanzi::wayland::IVILayoutManager::modeChangeNotification	(	int32_t	width,
		int32_t	height,
		int32_t	refresh
	)

noexcept

Called by Wayland when screen properties change.

Parameters

width	New screen width.
height	New screen height.
refresh	New refresh rate (mHz).

KZ_NO_DISCARD windowing::Size kanzi::wayland::IVILayoutManager::getResolution ( ) const

noexcept

Gets screen resolution.

Returns: Screen resolution.

KZ_NO_DISCARD const IVILayerProps& kanzi::wayland::IVILayoutManager::getLayerProps ( uint32_t layerId ) const

noexcept

Gets the internal layer state.

Parameters

layerId Layer ID.

Returns: Internal layer state.

KZ_NO_DISCARD const IVISurfaceProps& kanzi::wayland::IVILayoutManager::getSurfaceProps ( uint32_t surfaceId ) const

noexcept

Gets the internal surface state.

Parameters

surfaceId Surface ID.

Returns: Internal surface state.

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation