Class representing Wayland registry methods. More...

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

Inheritance diagram for kanzi::wayland::WaylandRegistryMethods:

Public Member Functions
KZ_NO_DISCARD void *	bind (const wl_interface *interface, unsigned int registerName, unsigned int version) const noexcept
	Bind an interface to the display.

template<typename T >
KZ_NO_DISCARD T	bindTo (const wl_interface *interface, unsigned int registerName, unsigned int version) const noexcept
	Bind and interface to the display and cast to the correct type.

Static Public Attributes
static const uint32_t	s_maxVersion
	Represents maximum interface version supported by the Wayland implementation that Kanzi libraries were compiled against.

static const wl_interface	s_nativeInterface
	Represents the underlying native interface.

Protected Member Functions
	WaylandRegistryMethods () noexcept=default
	Constructor.

	WaylandRegistryMethods (const NativeHandleType &handle) noexcept
	Constructor.

Protected Member Functions inherited from kanzi::OptionalHandle< T, sentinel, deleter, typename >
KZ_NO_DISCARD optional< T >	createOptional () const noexcept
	Creates a kanzi::optional copy of the native handle.

KZ_NO_DISCARD const T	get () const noexcept
	Provides access to stored handle.

KZ_NO_DISCARD T	get () noexcept
	Provides access to stored handle.

KZ_NO_DISCARD const T	getNativeHandle () const noexcept
	Provides access to stored handle.

KZ_NO_DISCARD T	getNativeHandle () noexcept
	Provides access to stored handle.

KZ_NO_DISCARD bool	hasValue () const noexcept
	Checks if a handle is stored.

KZ_NO_DISCARD	operator bool () const noexcept
	Conversion operator to bool.

KZ_NO_DISCARD T &&	operator* () &&noexcept
	Provides access to stored handle via rvalue reference.

KZ_NO_DISCARD T &	operator* () &noexcept
	Provides access to stored handle via reference.

KZ_NO_DISCARD const T &&	operator* () const &&noexcept
	Provides access to stored handle via const rvalue reference.

KZ_NO_DISCARD const T &	operator* () const &noexcept
	Provides access to stored handle via const reference.

OptionalHandle &	operator= (const OptionalHandle &other)=delete
	Copy assignment operator.

OptionalHandle &	operator= (const T &value)
	Copy assignment operator.

OptionalHandle &	operator= (OptionalHandle &&other) noexcept
	Move assignment operator.

OptionalHandle &	operator= (T &&value) noexcept
	Move assignment operator.

	OptionalHandle () noexcept
	Constructor.

	OptionalHandle (const OptionalHandle &other)=delete
	Copy constructor.

	OptionalHandle (const T &nativeHandle) noexcept
	Constructor.

	OptionalHandle (OptionalHandle &&other) noexcept
	Move constructor.

T	release () noexcept
	Releases ownership of a native handle without destroying the resource.

void	reset () noexcept
	Replaces stored handle with sentinel value.

template<typename U , typename = enable_if_t<is_same_v<T, decay_t<U>>>>
void	reset (U &&newHandle) noexcept
	Stores a new handle inside.

void	swap (OptionalHandle &other)
	Swap function.

KZ_NO_DISCARD optional< T >	toOptional () &&noexcept
	Converts OptionalHandle to kanzi::optional.

	~OptionalHandle ()
	Destructor.

Static Protected Member Functions
static KZ_NO_DISCARD WaylandRegistryMethods	create (const WaylandDisplay &waylandDisplay) noexcept
	Creates WaylandRegistry from a display.

Static Protected Member Functions inherited from kanzi::OptionalHandle< T, sentinel, deleter, typename >
static constexpr auto	getDeleter () noexcept
	Gets deleter function.

static constexpr T	getSentinel () noexcept
	Gets sentinel value that can be used to represent invalid handle.

Additional Inherited Members
Protected Types inherited from kanzi::OptionalHandle< T, sentinel, deleter, typename >
using	HandleType
	Alias for this handle type.

using	NativeHandleType
	Alias for the underlying native handle type.

Protected Attributes inherited from kanzi::OptionalHandle< T, sentinel, deleter, typename >
FlatOptional< T, sentinel >	m_handle
	Native handle that is managed by this class.

Detailed Description

Class representing Wayland registry methods.

Note: Do not use this class directly. Use WaylandRegistry instead.

See also: WaylandRegistry

Since: Kanzi 3.9.8; Kanzi 4.0.0 WaylandRegistry is now a safe wrapper around WaylandRegistryMethods.

Constructor & Destructor Documentation

◆ WaylandRegistryMethods() [1/2]

kanzi::wayland::WaylandRegistryMethods::WaylandRegistryMethods ( )

explicitprotecteddefaultnoexcept

Constructor.

◆ WaylandRegistryMethods() [2/2]

kanzi::wayland::WaylandRegistryMethods::WaylandRegistryMethods ( const NativeHandleType & handle )

explicitprotectednoexcept

Constructor.

Parameters

handle Native handle.

Member Function Documentation

◆ bind()

KZ_NO_DISCARD void * kanzi::wayland::WaylandRegistryMethods::bind	(	const wl_interface *	interface,
		unsigned int	registerName,
		unsigned int	version ) const

noexcept

Bind an interface to the display.

Parameters

interface	Interface to bind.
registerName	Unique numeric name of the interface.
version	Version of the interface to request.

Returns: Handle to the bound interface.

◆ bindTo()

template<typename T >

KZ_NO_DISCARD T WaylandRegistryMethods::bindTo	(	const wl_interface *	interface,
		unsigned int	registerName,
		unsigned int	version ) const

noexcept

Bind and interface to the display and cast to the correct type.

Prefer using this function instead of bind() because it casts handle to the specified type.

See also: bind()

Template Parameters

T	Wayland type to which to cast handle.

Parameters

interface	Interface to bind.
registerName	Unique numeric name of the interface.
version	Version of the interface to request.

Returns: Handle to the bound interface.

◆ create()

static KZ_NO_DISCARD WaylandRegistryMethods kanzi::wayland::WaylandRegistryMethods::create ( const WaylandDisplay & waylandDisplay )

staticprotectednoexcept

Creates WaylandRegistry from a display.

Parameters

waylandDisplay WaylandDisplay to construct WaylandRegistry from.

Returns: Created WaylandRegistry.

Since: Kanzi 4.0.0

Member Data Documentation

◆ s_nativeInterface

const wl_interface kanzi::wayland::WaylandRegistryMethods::s_nativeInterface

static

Represents the underlying native interface.

◆ s_maxVersion

const uint32_t kanzi::wayland::WaylandRegistryMethods::s_maxVersion

static

Represents maximum interface version supported by the Wayland implementation that Kanzi libraries were compiled against.

Defines correct maximum possible interface version based on available events and requests.

Since: Kanzi 4.0.0

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

kanzi/core.ui/platform/windowing_ng/wayland/wayland_registry.hpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WaylandRegistryMethods() [1/2]

◆ WaylandRegistryMethods() [2/2]

Member Function Documentation

◆ bind()

◆ bindTo()

◆ create()

Member Data Documentation

◆ s_nativeInterface

◆ s_maxVersion