Kanzi  3.9.9
Kanzi Engine C++ API
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. More...
 
bool dispatch () const noexcept
 Dispatches queued Wayland events. More...
 
bool dispatchPending () const noexcept
 Dispatches queued Wayland events. More...
 
bool flush () const noexcept
 Sends all buffered requests on the display to the server. More...
 
KZ_NO_DISCARD int getFileDescriptor () const noexcept
 Gets the underlying file descriptor. More...
 
KZ_NO_DISCARD wl_display * getNativeHandle () const noexcept
 Gets the underlying native handle. More...
 
WaylandDisplayoperator= (const WaylandDisplay &)=delete
 Copy assignment operator. More...
 
WaylandDisplayoperator= (WaylandDisplay &&)=delete
 Move assignment operator. More...
 
bool prepareRead () const noexcept
 Prepares to read events from the display's file descriptor. More...
 
bool readEvents () const noexcept
 Reads events from a display file descriptor. More...
 
bool roundtrip () const noexcept
 Blocks until compositor processes all requests. More...
 
 WaylandDisplay (wl_display *nativeHandle) noexcept
 Constructor. More...
 
 WaylandDisplay (const string &displayName) noexcept
 Constructor. More...
 
 WaylandDisplay () noexcept
 Constructor. More...
 
 WaylandDisplay (const WaylandDisplay &)=delete
 Copy constructor. More...
 
 WaylandDisplay (WaylandDisplay &&)=delete
 Move constructor. More...
 
 ~WaylandDisplay ()
 Destructor. More...
 

Detailed Description

Wayland display wrapper class.

Since
Kanzi 3.9.8

Constructor & Destructor Documentation

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

Constructor.

Parameters
nativeHandleNative Wayland handle.
kanzi::wayland::WaylandDisplay::WaylandDisplay ( const string &  displayName)
explicitnoexcept

Constructor.

Parameters
displayNameDisplay name to use when connecting.
kanzi::wayland::WaylandDisplay::WaylandDisplay ( )
explicitnoexcept

Constructor.

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

Destructor.

kanzi::wayland::WaylandDisplay::WaylandDisplay ( const WaylandDisplay )
delete

Copy constructor.

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

Move constructor.

Member Function Documentation

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

Copy assignment operator.

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

Move assignment operator.

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.
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.
bool kanzi::wayland::WaylandDisplay::roundtrip ( ) const
noexcept

Blocks until compositor processes all requests.

This function is blocking.

Returns
On success, true, otherwise false.
bool kanzi::wayland::WaylandDisplay::flush ( ) const
noexcept

Sends all buffered requests on the display to the server.

Returns
On success, true, otherwise false.
bool kanzi::wayland::WaylandDisplay::prepareRead ( ) const
noexcept

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

Returns
On success, true, otherwise false.
bool kanzi::wayland::WaylandDisplay::readEvents ( ) const
noexcept

Reads events from a display file descriptor.

Returns
On success, true, otherwise false.
void kanzi::wayland::WaylandDisplay::cancelRead ( ) const
noexcept

Cancels read intention on display's file descriptor.

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

Gets the underlying file descriptor.

Returns
File descriptor that represents this WaylandDisplay.
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: