kanzi::wayland::WaylandDisplay Class Reference

Wayland display wrapper class. More...

#include <kanzi/core.ui/platform/windowing_ng/wayland/wayland_display.hpp>

Public Member Functions
void	cancelRead () const noexcept
	Cancels read intention on display's file descriptor.
bool	dispatch () const noexcept
	Dispatches queued Wayland events.
bool	dispatchPending () const noexcept
	Dispatches queued Wayland events.
bool	flush () const noexcept
	Sends all buffered requests on the display to the server.
KZ_NO_DISCARD int	getFileDescriptor () const noexcept
	Gets the underlying file descriptor.
KZ_NO_DISCARD wl_display *	getNativeHandle () const noexcept
	Gets the underlying native handle.
WaylandDisplay &	operator= (const WaylandDisplay &)=delete
	Copy assignment operator.
WaylandDisplay &	operator= (WaylandDisplay &&)=delete
	Move assignment operator.
bool	prepareRead () const noexcept
	Prepares to read events from the display's file descriptor.
bool	readEvents () const noexcept
	Reads events from a display file descriptor.
bool	roundtrip () const noexcept
	Blocks until compositor processes all requests.
	WaylandDisplay () noexcept
	Constructor.
	WaylandDisplay (const string &displayName) noexcept
	Constructor.
	WaylandDisplay (const WaylandDisplay &)=delete
	Copy constructor.
	WaylandDisplay (WaylandDisplay &&)=delete
	Move constructor.
	WaylandDisplay (wl_display *nativeHandle) noexcept
	Constructor.
	~WaylandDisplay ()
	Destructor.

Detailed Description

Wayland display wrapper class.

Since

Kanzi 3.9.8

Constructor & Destructor Documentation

WaylandDisplay() [1/5]

kanzi::wayland::WaylandDisplay::WaylandDisplay ( wl_display * nativeHandle )

explicitnoexcept

Constructor.

Parameters

nativeHandle

Native Wayland handle.

WaylandDisplay() [2/5]

kanzi::wayland::WaylandDisplay::WaylandDisplay ( const string & displayName )

explicitnoexcept

Constructor.

Parameters

displayName

Display name to use when connecting.

WaylandDisplay() [3/5]

kanzi::wayland::WaylandDisplay::WaylandDisplay ( )

explicitnoexcept

Constructor.

~WaylandDisplay()

kanzi::wayland::WaylandDisplay::~WaylandDisplay

(

)

Destructor.

WaylandDisplay() [4/5]

kanzi::wayland::WaylandDisplay::WaylandDisplay ( const WaylandDisplay & )

delete

Copy constructor.

WaylandDisplay() [5/5]

kanzi::wayland::WaylandDisplay::WaylandDisplay ( WaylandDisplay && )

delete

Move constructor.

Member Function Documentation

operator=() [1/2]

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

delete

Copy assignment operator.

operator=() [2/2]

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

delete

Move assignment operator.

dispatchPending()

bool kanzi::wayland::WaylandDisplay::dispatchPending ( ) const

noexcept

Dispatches queued Wayland events.

If no events are queued, this operation returns without blocking.

Returns

On success, true, otherwise false.

dispatch()

bool kanzi::wayland::WaylandDisplay::dispatch ( ) const

noexcept

Dispatches queued Wayland events.

If no events are queued, this operation blocks until the next event occurs.

Returns

On success, true, otherwise false.

roundtrip()

bool kanzi::wayland::WaylandDisplay::roundtrip ( ) const

noexcept

Blocks until compositor processes all requests.

This function is blocking.

Returns

On success, true, otherwise false.

flush()

bool kanzi::wayland::WaylandDisplay::flush ( ) const

noexcept

Sends all buffered requests on the display to the server.

Returns

On success, true, otherwise false.

prepareRead()

bool kanzi::wayland::WaylandDisplay::prepareRead ( ) const

noexcept

Prepares to read events from the display's file descriptor.

Returns

On success, true, otherwise false.

readEvents()

bool kanzi::wayland::WaylandDisplay::readEvents ( ) const

noexcept

Reads events from a display file descriptor.

Returns

On success, true, otherwise false.

cancelRead()

void kanzi::wayland::WaylandDisplay::cancelRead ( ) const

noexcept

Cancels read intention on display's file descriptor.

getFileDescriptor()

KZ_NO_DISCARD int kanzi::wayland::WaylandDisplay::getFileDescriptor ( ) const

noexcept

Gets the underlying file descriptor.

Returns

File descriptor that represents this WaylandDisplay.

getNativeHandle()

KZ_NO_DISCARD wl_display * kanzi::wayland::WaylandDisplay::getNativeHandle ( ) const

noexcept

Gets the underlying native handle.

Returns

Native Wayland handle.

---

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

• kanzi/core.ui/platform/windowing_ng/wayland/wayland_display.hpp