wayland::zwp_i...imestamps_v1_t(3)

📦
version 1.0.1 · 10 versions
, in ubuntu stonking

okay so bestie, welcome to the wayland::zwp_i...imestamps_v1_t(3) page from the Wayland++ manual 💖 — this is literally all about wayland::zwp_input_timestamps_v1_t, the context object for input timestamps. no cap, every detail is below ✨

🎀 NAME

wayland::zwp_input_timestamps_v1_t — context object for input timestamps. it's giving exactly what the name says 🫶

✨ SYNOPSIS

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

It inherits wayland::proxy_t. iconic behavior, honestly 👑

🌸 Public Types

  • enum class wrapper_type { standard, display, foreign, proxy_wrapper } — the wrapper type enum, with all four values sitting right there 💅

💜 Public Member Functions

  • std::function< void(uint32_t, uint32_t, uint32_t)> & on_timestamp () — high-resolution timestamp event ⏱️
  • uint32_t get_id () const — grab the id of a proxy object
  • std::string get_class () const — grab the interface name (class) of a proxy object
  • uint32_t get_version () const — grab the protocol object version of a proxy object
  • wrapper_type get_wrapper_type () const — grab 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 — grab 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

🦋 Detailed Description

this is the context object for input timestamps 💫 it provides high-resolution timestamp events for a set of subscribed input events. the set of subscribed input events is determined by the zwp_input_timestamps_manager_v1 request used to create this object. that's the whole description, and it ate.

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

👑 Member Enumeration Documentation

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

underlying wl_proxy type and properties of a proxy_t that affect construction, destruction, and event handling. very "behind the scenes but important" energy 🌈

  • standard — the 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 — the 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 — the 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 — the 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 117 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.

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. no guessing, bestie — make safe assumptions ✨

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 303 of file wayland-client.hpp.

std::function< void(uint32_t, uint32_t, uint32_t)> & zwp_input_timestamps_v1_t::on_timestamp ()

high-resolution timestamp event ⏱️🔥

Parameters:

  • tv_sec_hi — high 32 bits of the seconds part of the timestamp
  • tv_sec_lo — low 32 bits of the seconds part of the timestamp
  • tv_nsec — nanoseconds part of the timestamp

the timestamp event is associated with the first subsequent input event carrying a timestamp which belongs to the set of input events this object is subscribed to.

the timestamp provided by this event is a high-resolution version of the timestamp argument of the associated input event. the provided timestamp is in the same clock domain and is at least as accurate as the associated input event timestamp. same clock domain, at least as accurate — periodt 💚

the timestamp is expressed as tv_sec_hi, tv_sec_lo, tv_nsec triples, each component being an unsigned 32-bit value. whole seconds are in tv_sec, which is a 64-bit value combined from tv_sec_hi and tv_sec_lo, and the additional fractional part in tv_nsec as nanoseconds. hence, for valid timestamps tv_nsec must be in [0, 999999999]. that range is not optional, bestie 🚨

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

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. ignored, not fixed — don't try it 🙈

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.

🌈 Author

generated automatically by Doxygen for Wayland++ from the source code. very "the docs made themselves" energy ✨

okay that's the whole page, bestie — version 1.0.1 of Wayland++, Fri Mar 27 2026. slay, you made it to the footer 💅✨

📦 where this page comes from