wayland_zwp_input_timestamps_manager_v1_t

context object for high-resolution input timestamps

Synopsis

#include <wayland-client-protocol-unstable.hpp>

Inherits wayland::proxy_t.

Public Types

enum wrapper_type { wrapper_type::standard, wrapper_type::display, wrapper_type::foreign, wrapper_type::proxy_wrapper }

Public Member Functions

zwp_input_timestamps_v1_t get_keyboard_timestamps (keyboard_t const &keyboard)
subscribe to high-resolution keyboard timestamp events
zwp_input_timestamps_v1_t get_pointer_timestamps (pointer_t const &pointer)
subscribe to high-resolution pointer timestamp events
zwp_input_timestamps_v1_t get_touch_timestamps (touch_t const &touch)
subscribe to high-resolution touch timestamp events
uint32_t get_id () const
Get the id of a proxy object.
std::string get_class () const
Get the interface name (class) of a proxy object.
uint32_t get_version () const
Get the protocol object version of a proxy object.
wrapper_type get_wrapper_type () const
Get the type of a proxy object.
void set_queue (event_queue_t queue)
Assign a proxy to an event queue.
wl_proxy * c_ptr () const
Get a pointer to the underlying C struct.
bool proxy_has_object () const
Check whether this wrapper actually wraps an object.
operator bool () const
Check whether this wrapper actually wraps an object.
bool operator== (const proxy_t &right) const
Check whether two wrappers refer to the same object.
bool operator!= (const proxy_t &right) const
Check whether two wrappers refer to different objects.
void proxy_release ()
Release the wrapped object (if any), making this an empty wrapper.

Static Public Attributes

static constexpr std::uint32_t get_keyboard_timestamps_since_version = 1
Minimum protocol version required for the get_keyboard_timestamps function.
static constexpr std::uint32_t get_pointer_timestamps_since_version = 1
Minimum protocol version required for the get_pointer_timestamps function.
static constexpr std::uint32_t get_touch_timestamps_since_version = 1
Minimum protocol version required for the get_touch_timestamps function.

Detailed Description

context object for high-resolution input timestamps

A global interface used for requesting high-resolution timestamps for input events.

Definition at line 1138 of file wayland-client-protocol-unstable.hpp.

Member Enumeration Documentation

enum wayland::proxy_t::wrapper_type [strong], [inherited]

Underlying wl_proxy type and properties of a proxy_t that affect construction, destruction, and event handling

Enumerator

standard

C pointer is a standard type compatible with wl_proxy*. Events are dispatched and it is destructed when the proxy_t is destructed. User data is set.

display

C pointer is a wl_display*. No events are dispatched, wl_display_disconnect is called when the proxy_t is destructed. User data is set.

foreign

C pointer is a standard type compatible with wl_proxy*, but another library owns it and it should not be touched in a way that could affect the operation of the other library. No events are dispatched, wl_proxy_destroy is not called when the proxy_t is destructed, user data is not touched. Consequently, there is no reference counting for the proxy_t. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl_proxy.

proxy_wrapper

C pointer is a wl_proxy* that was constructed with wl_proxy_create_wrapper. No events are dispatched, wl_proxy_wrapper_destroy is called when the proxy_t is destroyed. Reference counting is active. A reference to the proxy_t creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed.

Definition at line 115 of file wayland-client.hpp.

Member Function Documentation

wl_proxy* wayland::proxy_t::c_ptr () const [inherited]

Get a pointer to the underlying C struct.

Returns

The underlying wl_proxy wrapped by this proxy_t if it exists, otherwise an exception is thrown

std::string wayland::proxy_t::get_class () const [inherited]

Get the interface name (class) of a proxy object.

Returns

The interface name of the object associated with the proxy

uint32_t wayland::proxy_t::get_id () const [inherited]

Get the id of a proxy object.

Returns

The id the object associated with the proxy

Examples dump.cpp.

zwp_input_timestamps_v1_t zwp_input_timestamps_manager_v1_t::get_keyboard_timestamps (keyboard_t const & keyboard)

subscribe to high-resolution keyboard timestamp events

Parameters

keyboard the wl_keyboard object for which to get timestamp events

Creates a new input timestamps object that represents a subscription to high-resolution timestamp events for all wl_keyboard events that carry a timestamp.

If the associated wl_keyboard object is invalidated, either through client action (e.g. release) or server-side changes, the input timestamps object becomes inert and the client should destroy it by calling zwp_input_timestamps_v1.destroy.

Definition at line 4638 of file wayland-client-protocol-unstable.cpp.

zwp_input_timestamps_v1_t zwp_input_timestamps_manager_v1_t::get_pointer_timestamps (pointer_t const & pointer)

subscribe to high-resolution pointer timestamp events

Parameters

pointer the wl_pointer object for which to get timestamp events

Creates a new input timestamps object that represents a subscription to high-resolution timestamp events for all wl_pointer events that carry a timestamp.

If the associated wl_pointer object is invalidated, either through client action (e.g. release) or server-side changes, the input timestamps object becomes inert and the client should destroy it by calling zwp_input_timestamps_v1.destroy.

Definition at line 4644 of file wayland-client-protocol-unstable.cpp.

zwp_input_timestamps_v1_t zwp_input_timestamps_manager_v1_t::get_touch_timestamps (touch_t const & touch)

subscribe to high-resolution touch timestamp events

Parameters

touch the wl_touch object for which to get timestamp events

Creates a new input timestamps object that represents a subscription to high-resolution timestamp events for all wl_touch events that carry a timestamp.

If the associated wl_touch object becomes invalid, either through client action (e.g. release) or server-side changes, the input timestamps object becomes inert and the client should destroy it by calling zwp_input_timestamps_v1.destroy.

Definition at line 4650 of file wayland-client-protocol-unstable.cpp.

uint32_t wayland::proxy_t::get_version () const [inherited]

Get the protocol object version of a proxy object. Gets the protocol object version of a proxy object, or 0 if the proxy was created with unversioned API.

A returned value of 0 means that no version information is available, so the caller must make safe assumptions about the object's real version.

display_t will always return version 0.

Returns

The protocol object version of the proxy or 0

wrapper_type wayland::proxy_t::get_wrapper_type () const [inline], [inherited]

Get the type of a proxy object.

Definition at line 301 of file wayland-client.hpp.

wayland::proxy_t::operator bool () const [inherited]

Check whether this wrapper actually wraps an object.

Returns

true if there is an underlying object, false if this wrapper is empty

bool wayland::proxy_t::operator!= (const proxy_t & right) const [inherited]

Check whether two wrappers refer to different objects.

bool wayland::proxy_t::operator== (const proxy_t & right) const [inherited]

Check whether two wrappers refer to the same object.

bool wayland::proxy_t::proxy_has_object () const [inherited]

Check whether this wrapper actually wraps an object.

Returns

true if there is an underlying object, false if this wrapper is empty

void wayland::proxy_t::proxy_release () [inherited]

Release the wrapped object (if any), making this an empty wrapper. Note that display_t instances cannot be released this way. Attempts to do so are ignored.

Examples foreign_display.cpp.

void wayland::proxy_t::set_queue (event_queue_t queue) [inherited]

Assign a proxy to an event queue.

Parameters

queue The event queue that will handle this proxy

Assign proxy to event queue. Events coming from proxy will be queued in queue instead of the display's main queue.

See also: display_t::dispatch_queue().

Examples proxy_wrapper.cpp.

Member Data Documentation

constexpr std::uint32_t wayland::zwp_input_timestamps_manager_v1_t::get_keyboard_timestamps_since_version = 1 [static], [constexpr]

Minimum protocol version required for the get_keyboard_timestamps function.

Definition at line 1177 of file wayland-client-protocol-unstable.hpp.

constexpr std::uint32_t wayland::zwp_input_timestamps_manager_v1_t::get_pointer_timestamps_since_version = 1 [static], [constexpr]

Minimum protocol version required for the get_pointer_timestamps function.

Definition at line 1196 of file wayland-client-protocol-unstable.hpp.

constexpr std::uint32_t wayland::zwp_input_timestamps_manager_v1_t::get_touch_timestamps_since_version = 1 [static], [constexpr]

Minimum protocol version required for the get_touch_timestamps function.

Definition at line 1215 of file wayland-client-protocol-unstable.hpp.

Author

Generated automatically by Doxygen for Wayland++ from the source code.

Info

Wed Aug 5 2020 Version 0.2.8 Wayland++