Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::wayland::WaylandSurface Class Reference

Wayland surface wrapper class. More...

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

Inheritance diagram for kanzi::wayland::WaylandSurface:
[legend]

Public Member Functions

void commit () const noexcept
 Commit pending surface state. More...
 
 WaylandSurface (wl_surface *nativeHandle) noexcept
 Constructor. More...
 
 WaylandSurface (const WaylandCompositor &compositor) noexcept
 Constructor. More...
 
- Public Member Functions inherited from kanzi::wayland::WaylandInterface< WaylandSurface, wl_surface, wl_surface_listener >
bool addListener (enable_if_t<!is_same< L, void >::value, const L & > listener, void *data) const noexcept
 Adds a listener to Wayland object. More...
 
KZ_NO_DISCARD unsigned int askVersion () const noexcept
 Requests compositor which interface version we use. More...
 
KZ_NO_DISCARD wl_surface * getNativeHandle () const noexcept
 Gets the underlying native handle. More...
 

Static Public Attributes

static const wl_interface s_nativeInterface
 Represents the underlying native interface. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::wayland::WaylandInterface< WaylandSurface, wl_surface, wl_surface_listener >
using ListenerType = wl_surface_listener
 Generic alias to query for appropriate listener type. More...
 
- Static Public Member Functions inherited from kanzi::wayland::WaylandInterface< WaylandSurface, wl_surface, wl_surface_listener >
static KZ_NO_DISCARD unsigned int askVersion (wl_surface *handle) noexcept
 Requests compositor which interface version we use. More...
 

Detailed Description

Wayland surface wrapper class.

Since
Kanzi 3.9.8

Constructor & Destructor Documentation

kanzi::wayland::WaylandSurface::WaylandSurface ( wl_surface *  nativeHandle)
explicitnoexcept

Constructor.

Parameters
nativeHandleNative Wayland handle.
kanzi::wayland::WaylandSurface::WaylandSurface ( const WaylandCompositor compositor)
explicitnoexcept

Constructor.

Parameters
compositorWaylandCompositor to construct WaylandSurface from.

Member Function Documentation

void kanzi::wayland::WaylandSurface::commit ( ) const
noexcept

Commit pending surface state.

Member Data Documentation

const wl_interface kanzi::wayland::WaylandSurface::s_nativeInterface
static

Represents the underlying native interface.


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