Classes
class	AbstractDefaultWaylandContext
	Class that represents an interface for Wayland callbacks. More...

class	AbstractWaylandShell
	Represents a Wayland shell class interface boilerplate. More...

class	CoreShell
	Wayland Core Shell abstraction. More...

class	DefaultWaylandEGLGraphicsOutput
	Class that represents the default Wayland EGL graphics output. More...

struct	DefaultWaylandEGLGraphicsOutputProperties
	Default properties to use when creating DefaultWaylandEGLGraphicsOutput. More...

struct	ExitRequestEvent
	Event that represents a request to close the window. More...

class	IviApplication
	Wrapper for an IVI application class. More...

class	IviApplicationMethods
	Class representing IVI application methods. More...

class	IviLayer
	Represents IVI layer. More...

struct	IviLayerProps
	Collection of IviLayer properties. More...

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

class	IviScreen
	Wrapper for a Wayland output class. More...

class	IviScreenMethods
	Class representing Wayland output methods. More...

class	IviShell
	Wayland IVI Shell abstraction. More...

class	IviSurface
	Wrapper for a IVI surface class. More...

class	IviSurfaceMethods
	Class representing IVI surface methods. More...

struct	IviSurfaceProps
	Collection of IviWmSurface properties. More...

class	IviWm
	Wrapper for an IVI WM class. More...

class	IviWmMethods
	Class representing IVI WM methods. More...

class	IviWmSurface
	Represents IVI surface from WM point of view. More...

struct	KeyboardEnterEvent
	Event that represents keyboard entering the window. More...

struct	KeyboardLeaveEvent
	Event that represents keyboard leaving the window. More...

struct	KeyEvent
	Event that represents a keyboard key changing state. More...

struct	KeyModEvent
	Event that represents the current keyboard modifier state. More...

class	ListenedWaylandOptionalHandle
	Represents WaylandOptionalHandle that can accept a listener. More...

class	ListenedWaylandOptionalHandleWrapper
	OptionalHandleWrapper for a listened Wayland interface. More...

struct	PointerAxisEvent
	Event that represents mouse scroll. More...

struct	PointerButtonEvent
	Event that represents mouse button events. More...

struct	PointerEnterEvent
	Event that represents mouse entering application window. More...

struct	PointerFrameEvent
	Event that groups pointer events together. More...

struct	PointerLeaveEvent
	Event that represents mouse leaving application window. More...

struct	PointerMotionEvent
	Event that represents mouse movement. More...

struct	TouchCancelEvent
	Event that represents compositor taking over all touch points. More...

struct	TouchDownEvent
	Event that starts a touch point. More...

struct	TouchFrameEvent
	Event that groups touch events together. More...

struct	TouchMotionEvent
	Event that represents touch point movement. More...

struct	TouchUpEvent
	Event that ends a touch point. More...

class	WaylandCallback
	Wrapper for a Wayland callback class. More...

class	WaylandCallbackMethods
	Class representing Wayland callback methods. More...

class	WaylandCompositor
	Wrapper for a Wayland compositor class. More...

class	WaylandCompositorMethods
	Class representing Wayland compositor methods. More...

class	WaylandDisplay
	Wayland display wrapper class. More...

class	WaylandEGLWindow
	Wayland EGL window wrapper class. More...

class	WaylandEventVisitor
	Visitor class that operates on different types of Wayland events. More...

class	WaylandIVIEGLGraphicsOutput
	Class that represents the Wayland IVI EGL graphics output. More...

struct	WaylandIVIEGLGraphicsOutputProperties
	Default properties to use when creating WaylandIVIEGLGraphicsOutput. More...

class	WaylandKeyboard
	Wrapper for a Wayland keyboard class. More...

class	WaylandKeyboardMethods
	Class representing Wayland keyboard methods. More...

class	WaylandOptionalHandle
	Represents a generic Wayland handle with managed lifetime. More...

class	WaylandOptionalHandleWrapper
	OptionalHandleWrapper for a Wayland interface. More...

class	WaylandOutput
	Wrapper for a Wayland output class. More...

class	WaylandOutputMethods
	Class representing Wayland output methods. More...

class	WaylandPointer
	Wrapper for a Wayland pointer class. More...

class	WaylandPointerMethods
	Class representing Wayland pointer methods. More...

class	WaylandRegistry
	Wrapper for a Wayland registry class. More...

class	WaylandRegistryMethods
	Class representing Wayland registry methods. More...

class	WaylandSeat
	Wrapper for a Wayland seat class. More...

class	WaylandSeatMethods
	Represents a Wayland seat and abstracts the underlying capabilities. More...

class	WaylandShell
	Wrapper for a Wayland shell class. More...

class	WaylandShellMethods
	Class representing Wayland shell methods. More...

class	WaylandShellSurface
	Wrapper for a Wayland shell surface class. More...

class	WaylandShellSurfaceMethods
	Class representing Wayland shell_surface methods. More...

class	WaylandSurface
	Wrapper for a Wayland surface class. More...

class	WaylandSurfaceMethods
	Class representing Wayland surface methods. More...

class	WaylandTouch
	Wrapper for a Wayland touch class. More...

class	WaylandTouchMethods
	Class representing Wayland touch methods. More...

class	XdgPositioner
	Wrapper for a Wayland XDG positioner class. More...

class	XdgPositionerMethods
	Class representing XDG positioner methods. More...

class	XdgShell
	Wayland Xdg Shell abstraction. More...

class	XdgSurface
	Wrapper for a XDG surface class. More...

class	XdgSurfaceMethods
	Class representing XDG surface methods. More...

class	XdgToplevel
	Wrapper for a Wayland XDG toplevel class. More...

class	XdgToplevelMethods
	Class representing XDG toplevel methods. More...

class	XdgWmBase
	Wrapper for a Wayland XDG WM base class. More...

class	XdgWmBaseMethods
	Class representing XDG WM base methods. More...

Typedefs
using	ShellVariant
	Alias to variant of all available shells.

using	WaylandEvent
	Alias that contains all Wayland events.

Enumerations
enum class	PointerFrameEventMode { Native , Emulated }
	Enumerator that represents Wayland pointer event processing mode. More...

enum class	WaylandInputMode { Retained , Immediate }
	Enumerator that represents Wayland input mode. More...

enum class	WaylandShellType { Core , XDG , IVI }
	Enumerator that represents Wayland shells available in Kanzi. More...

Functions
KZ_NO_DISCARD KeyModifier	getWaylandKeyModifiers (unsigned int modsDepressed, unsigned int modsLatched, unsigned int modsLocked) noexcept
	Gets the currently active key modifiers.

template<typename T >
KZ_NO_DISCARD T::Listener	makeDefaultListener () noexcept
	Creates a default listener for a WaylandOptionalHandle.

template<>
KZ_NO_DISCARD IviScreen::Listener	makeDefaultListener< IviScreen > () noexcept
	Creates a default listener for IviScreen.

template<>
KZ_NO_DISCARD IviSurface::Listener	makeDefaultListener< IviSurface > () noexcept
	Creates a default listener for IviSurface.

template<>
KZ_NO_DISCARD IviWm::Listener	makeDefaultListener< IviWm > () noexcept
	Creates a default listener for IviWm.

template<>
KZ_NO_DISCARD WaylandCallback::Listener	makeDefaultListener< WaylandCallback > () noexcept
	Creates a default listener for WaylandCallback.

template<>
KZ_NO_DISCARD WaylandKeyboard::Listener	makeDefaultListener< WaylandKeyboard > () noexcept
	Creates a default listener for WaylandKeyboard.

template<>
KZ_NO_DISCARD WaylandOutput::Listener	makeDefaultListener< WaylandOutput > () noexcept
	Creates a default listener for WaylandOutput.

template<>
KZ_NO_DISCARD WaylandPointer::Listener	makeDefaultListener< WaylandPointer > () noexcept
	Creates a default listener for WaylandPointer.

template<>
KZ_NO_DISCARD WaylandRegistry::Listener	makeDefaultListener< WaylandRegistry > () noexcept
	Creates a default listener for WaylandRegistry.

template<>
KZ_NO_DISCARD WaylandSeat::Listener	makeDefaultListener< WaylandSeat > () noexcept
	Creates a default listener for WaylandSeat.

template<>
KZ_NO_DISCARD WaylandShellSurface::Listener	makeDefaultListener< WaylandShellSurface > () noexcept
	Creates a default listener for WaylandShellSurface.

template<>
KZ_NO_DISCARD WaylandTouch::Listener	makeDefaultListener< WaylandTouch > () noexcept
	Creates a default listener for WaylandTouch.

template<>
KZ_NO_DISCARD XdgSurface::Listener	makeDefaultListener< XdgSurface > () noexcept
	Creates a default listener for XdgSurface.

template<>
KZ_NO_DISCARD XdgToplevel::Listener	makeDefaultListener< XdgToplevel > () noexcept
	Creates a default listener for XdgToplevel.

template<>
KZ_NO_DISCARD XdgWmBase::Listener	makeDefaultListener< XdgWmBase > () noexcept
	Creates a default listener for XdgWmBase.

template<typename T >
span< T >	makeSpanOverWlArray (wl_array *wlArray)
	Creates a kanzi::span over wl_array.

KZ_NO_DISCARD WaylandShellType	parseShellType (string_view shellTypeStr) noexcept
	Converts the text containing the shell type to the corresponding enumerator value.

KZ_NO_DISCARD WaylandInputMode	parseWaylandInputMode (string_view inputModeStr) noexcept
	Converts the text containing the Wayland input mode to the corresponding enumerator value.

KZ_NO_DISCARD string	shellTypeToString (WaylandShellType shellType) noexcept
	Converts the shell type from an enumerator value to string.

KZ_NO_DISCARD string	waylandInputModeToString (WaylandInputMode waylandInputMode) noexcept
	Converts the Wayland input mode from an enumerator value to string.

KZ_NO_DISCARD LogicalKey	waylandKeyToLogicalKey (unsigned int keyCode) noexcept
	Maps the native Wayland key to a logical key used by Kanzi.

Typedef Documentation

◆ ShellVariant

using kanzi::wayland::ShellVariant

Alias to variant of all available shells.

Since: Kanzi 4.0.0

◆ WaylandEvent

using kanzi::wayland::WaylandEvent

Alias that contains all Wayland events.

Since: Kanzi 3.9.8

Enumeration Type Documentation

◆ PointerFrameEventMode

enum class kanzi::wayland::PointerFrameEventMode

strong

Enumerator that represents Wayland pointer event processing mode.

Since: Kanzi 4.0.0

Enumerator
Native	Receives frame() events from the compositor.
Emulated	Emulates frame() event after each pointer event.

◆ WaylandShellType

enum class kanzi::wayland::WaylandShellType

strong

Enumerator that represents Wayland shells available in Kanzi.

Since: Kanzi 3.9.8

Enumerator

Core

The original Wayland shell.

See also: CoreShell

XDG

XDG shell.

See also: XdgShell

IVI

IVI shell.

See also: IviShell

◆ WaylandInputMode

enum class kanzi::wayland::WaylandInputMode

strong

Enumerator that represents Wayland input mode.

Since: Kanzi 3.9.9

Enumerator
Retained	Collects events until `frame()` event is received from compositor, then processes them all at once.
Immediate	Processes events immediately and ignores `frame()` event.

Function Documentation

◆ makeDefaultListener< WaylandKeyboard >()

template<>

KZ_NO_DISCARD WaylandKeyboard::Listener kanzi::wayland::makeDefaultListener< WaylandKeyboard > ( )

noexcept

Creates a default listener for WaylandKeyboard.

See also: makeDefaultListener<T>()

◆ makeDefaultListener< WaylandPointer >()

template<>

KZ_NO_DISCARD WaylandPointer::Listener kanzi::wayland::makeDefaultListener< WaylandPointer > ( )

noexcept

Creates a default listener for WaylandPointer.

See also: makeDefaultListener<T>()

◆ makeDefaultListener< WaylandSeat >()

template<>

KZ_NO_DISCARD WaylandSeat::Listener kanzi::wayland::makeDefaultListener< WaylandSeat > ( )

noexcept

Creates a default listener for WaylandSeat.

See also: makeDefaultListener<T>()

◆ makeDefaultListener< WaylandTouch >()

template<>

KZ_NO_DISCARD WaylandTouch::Listener kanzi::wayland::makeDefaultListener< WaylandTouch > ( )

noexcept

Creates a default listener for WaylandTouch.

See also: makeDefaultListener<T>()

◆ waylandKeyToLogicalKey()

KZ_NO_DISCARD LogicalKey kanzi::wayland::waylandKeyToLogicalKey ( unsigned int keyCode )

noexcept

Maps the native Wayland key to a logical key used by Kanzi.

Parameters

keyCode Wayland key code.

Returns: Logical key used by Kanzi.

Since: Kanzi 3.9.8

◆ getWaylandKeyModifiers()

KZ_NO_DISCARD KeyModifier kanzi::wayland::getWaylandKeyModifiers	(	unsigned int	modsDepressed,
		unsigned int	modsLatched,
		unsigned int	modsLocked )

noexcept

Gets the currently active key modifiers.

Parameters

modsDepressed	Depressed keys mask.
modsLatched	Latched keys mask.
modsLocked	Locked keys mask.

Returns: Currently active key modifiers.

Since: Kanzi 3.9.8

◆ makeDefaultListener< WaylandCallback >()

template<>

KZ_NO_DISCARD WaylandCallback::Listener kanzi::wayland::makeDefaultListener< WaylandCallback > ( )

noexcept

Creates a default listener for WaylandCallback.

See also: makeDefaultListener<T>()

◆ makeDefaultListener()

template<typename T >

KZ_NO_DISCARD T::Listener kanzi::wayland::makeDefaultListener ( )

noexcept

Creates a default listener for a WaylandOptionalHandle.

Note: There's no generic implementation for this function. The function needs to be specialized for each WaylandOptionalHandle.

Template Parameters

T	WaylandOptionalHandle type.

Returns: Native listener type.

Since: Kanzi 4.0.0

◆ makeDefaultListener< WaylandOutput >()

template<>

KZ_NO_DISCARD WaylandOutput::Listener kanzi::wayland::makeDefaultListener< WaylandOutput > ( )

noexcept

Creates a default listener for WaylandOutput.

See also: makeDefaultListener<T>()

◆ makeDefaultListener< WaylandRegistry >()

template<>

KZ_NO_DISCARD WaylandRegistry::Listener kanzi::wayland::makeDefaultListener< WaylandRegistry > ( )

noexcept

Creates a default listener for WaylandRegistry.

See also: makeDefaultListener<T>()

◆ makeDefaultListener< WaylandShellSurface >()

template<>

KZ_NO_DISCARD WaylandShellSurface::Listener kanzi::wayland::makeDefaultListener< WaylandShellSurface > ( )

noexcept

Creates a default listener for WaylandShellSurface.

See also: makeDefaultListener<T>()

◆ makeDefaultListener< IviSurface >()

template<>

KZ_NO_DISCARD IviSurface::Listener kanzi::wayland::makeDefaultListener< IviSurface > ( )

noexcept

Creates a default listener for IviSurface.

See also: makeDefaultListener<T>()

◆ parseShellType()

KZ_NO_DISCARD WaylandShellType kanzi::wayland::parseShellType ( string_view shellTypeStr )

noexcept

Converts the text containing the shell type to the corresponding enumerator value.

Parameters

shellTypeStr String representation of shell type.

Returns: Wayland shell enumerator value.

Since: Kanzi 3.9.8

◆ shellTypeToString()

KZ_NO_DISCARD string kanzi::wayland::shellTypeToString ( WaylandShellType shellType )

noexcept

Converts the shell type from an enumerator value to string.

Parameters

shellType Wayland shell enumerator value.

Returns: String representation of the shell type.

Since: Kanzi 3.9.8

◆ makeDefaultListener< XdgSurface >()

template<>

KZ_NO_DISCARD XdgSurface::Listener kanzi::wayland::makeDefaultListener< XdgSurface > ( )

noexcept

Creates a default listener for XdgSurface.

See also: makeDefaultListener<T>()

◆ makeDefaultListener< XdgToplevel >()

template<>

KZ_NO_DISCARD XdgToplevel::Listener kanzi::wayland::makeDefaultListener< XdgToplevel > ( )

noexcept

Creates a default listener for XdgToplevel.

See also: makeDefaultListener<T>()

◆ makeDefaultListener< XdgWmBase >()

template<>

KZ_NO_DISCARD XdgWmBase::Listener kanzi::wayland::makeDefaultListener< XdgWmBase > ( )

noexcept

Creates a default listener for XdgWmBase.

See also: makeDefaultListener<T>()

◆ parseWaylandInputMode()

KZ_NO_DISCARD WaylandInputMode kanzi::wayland::parseWaylandInputMode ( string_view inputModeStr )

noexcept

Converts the text containing the Wayland input mode to the corresponding enumerator value.

Parameters

inputModeStr String representation of Wayland input mode.

Returns: Wayland input mode enumerator value.

Since: Kanzi 3.9.9

◆ waylandInputModeToString()

KZ_NO_DISCARD string kanzi::wayland::waylandInputModeToString ( WaylandInputMode waylandInputMode )

noexcept

Converts the Wayland input mode from an enumerator value to string.

Parameters

waylandInputMode Wayland input mode enumerator value.

Returns: String representation of the Wayland input mode.

Since: Kanzi 3.9.9

◆ makeSpanOverWlArray()

template<typename T >

span< T > kanzi::wayland::makeSpanOverWlArray ( wl_array * wlArray )

Creates a kanzi::span over wl_array.

Template Parameters

T	Element type.

Parameters

wlArray Wayland array.

Returns: Span that wraps underlying wl_array.

Since: Kanzi 3.9.8

◆ makeDefaultListener< IviScreen >()

template<>

KZ_NO_DISCARD IviScreen::Listener kanzi::wayland::makeDefaultListener< IviScreen > ( )

noexcept

Creates a default listener for IviScreen.

See also: makeDefaultListener<T>()

◆ makeDefaultListener< IviWm >()

template<>

KZ_NO_DISCARD IviWm::Listener kanzi::wayland::makeDefaultListener< IviWm > ( )

noexcept

Creates a default listener for IviWm.

See also: makeDefaultListener<T>()

Classes

Typedefs

Enumerations

Functions

Typedef Documentation

◆ ShellVariant

◆ WaylandEvent

Enumeration Type Documentation

◆ PointerFrameEventMode

◆ WaylandShellType

◆ WaylandInputMode

Function Documentation

◆ makeDefaultListener< WaylandKeyboard >()

◆ makeDefaultListener< WaylandPointer >()

◆ makeDefaultListener< WaylandSeat >()

◆ makeDefaultListener< WaylandTouch >()

◆ waylandKeyToLogicalKey()

◆ getWaylandKeyModifiers()

◆ makeDefaultListener< WaylandCallback >()

◆ makeDefaultListener()

◆ makeDefaultListener< WaylandOutput >()

◆ makeDefaultListener< WaylandRegistry >()

◆ makeDefaultListener< WaylandShellSurface >()

◆ makeDefaultListener< IviSurface >()

◆ parseShellType()

◆ shellTypeToString()

◆ makeDefaultListener< XdgSurface >()

◆ makeDefaultListener< XdgToplevel >()

◆ makeDefaultListener< XdgWmBase >()

◆ parseWaylandInputMode()

◆ waylandInputModeToString()

◆ makeSpanOverWlArray()

◆ makeDefaultListener< IviScreen >()

◆ makeDefaultListener< IviWm >()