wayland::zxdg_positioner_v6_t(3)

📦

version 1.0.1 · 10 versions

1.0.1 · ubuntu stonking (latest)
1.0.1-devman · nixos 26.05, nixpkgs unstable
1.0.0 · alpine 3.24
1.0.0 · ubuntu questing
1.0.1 · fedora 43
1.0.1 · fedora 44
1.0.0 · ubuntu noble
1.0.0 · debian bookworm
1.0.1 · ubuntu resolute
1.0.0 · debian trixie

💅 wayland::zxdg_positioner_v6_t — child surface positioner

okay so bestie, welcome to the manual page for wayland::zxdg_positioner_v6_t(3) from Wayland++ 🦋 this is part 1 of 2, so like, keep the tab open ✨

✨ NAME ✨

wayland::zxdg_positioner_v6_t — child surface positioner 🎀

✨ SYNOPSIS ✨

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

Inherits wayland::proxy_t. lowkey iconic inheritance ngl 👑

🧚 Public Types

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

🌸 Public Member Functions

void set_size (int32_t width, int32_t height) — sets the size of the to-be positioned rectangle
void set_anchor_rect (int32_t x, int32_t y, int32_t width, int32_t height) — sets the anchor rectangle within the parent surface
void set_anchor (zxdg_positioner_v6_anchor const &anchor) — sets the anchor rectangle anchor edges
void set_gravity (zxdg_positioner_v6_gravity const &gravity) — sets the child surface gravity
void set_constraint_adjustment (zxdg_positioner_v6_constraint_adjustment const &constraint_adjustment) — sets the adjustment to be done when constrained
void set_offset (int32_t x, int32_t y) — sets the surface position offset
uint32_t get_id () const — gets the id of a proxy object
std::string get_class () const — gets the interface name (class) of a proxy object
uint32_t get_version () const — gets the protocol object version of a proxy object
wrapper_type get_wrapper_type () const — gets the type of a proxy object
void set_queue (event_queue_t queue) — assigns a proxy to an event queue
wl_proxy * c_ptr () const — gets a pointer to the underlying C struct
bool proxy_has_object () const — checks whether this wrapper actually wraps an object
operator bool () const — checks whether this wrapper actually wraps an object
bool operator== (const proxy_t &right) const — checks whether two wrappers refer to the same object
bool operator!= (const proxy_t &right) const — checks whether two wrappers refer to different objects
void proxy_release () — releases the wrapped object (if any), making this an empty wrapper

⭐ Static Public Attributes

static constexpr std::uint32_t set_size_since_version = 1 — minimum protocol version required for the set_size function
static constexpr std::uint32_t set_anchor_rect_since_version = 1 — minimum protocol version required for the set_anchor_rect function
static constexpr std::uint32_t set_anchor_since_version = 1 — minimum protocol version required for the set_anchor function
static constexpr std::uint32_t set_gravity_since_version = 1 — minimum protocol version required for the set_gravity function
static constexpr std::uint32_t set_constraint_adjustment_since_version = 1 — minimum protocol version required for the set_constraint_adjustment function
static constexpr std::uint32_t set_offset_since_version = 1 — minimum protocol version required for the set_offset function

🌈 Detailed Description 🌈

child surface positioner 🫶

okay so picture this: the xdg_positioner is literally the rulebook for where a child surface goes relative to a parent surface. like, it's giving "placement manager energy" 👑

You can define rules to make sure the child surface stays inside the visible area's borders 💅 and you can also say how the child surface changes its position — sliding along an axis, or flipping around a rectangle, that kinda thing. But here's the catch, bestie: these positioner-created rules are constrained by the requirement that a child surface must intersect with, or be at least partially adjacent to, its parent surface. no cap, that's a hard requirement 😤

see the various requests for details about possible rules 👀

⚠️ timing tea: at the time of the request, the compositor makes a copy of the rules specified by the xdg_positioner. so after the request is complete, the xdg_positioner object can be destroyed or reused. further changes to the object will have no effect on previous usages. periodt. don't come for me when ur old rules don't update 💀

🦋 when is a positioner "complete"? (vibe check)

For an xdg_positioner object to be considered complete, it must have:

a non-zero size set by set_size, and
a non-zero anchor rectangle set by set_anchor_rect

🚨 Passing an incomplete xdg_positioner object when positioning a surface raises an error. like, it will literally not slay. set ur size, set ur anchor rect, then we talk 🙈

Definition at line 7821 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 🧚

Enumerator

standard — the C pointer is a standard type compatible with wl_proxy*. events are dispatched, and it gets 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. like, respectfully, don't linger 👋
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. 📍

part 1 of 2 — more incoming ⬇️💖

🧰 Member Function Documentation 🧰

okay bestie, this is the whole function lineup — inherited proxy_t basics first, then the zxdg_positioner_v6_t setters. signatures, params, defaults, errors, and line numbers are all staying exactly where they belong. no cap. 💅

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. important safety vibe check!
- 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.
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 zxdg_positioner_v6_t::set_anchor (zxdg_positioner_v6_anchor const & anchor) — set anchor rectangle anchor edges
- Parameters:
  - anchor — bit mask of anchor edges
- Defines a set of edges for the anchor rectangle. These are used to derive an anchor point that the child surface will be positioned relative to. If two orthogonal edges are specified (e.g. 'top' and 'left'), then the anchor point will be the intersection of the edges (e.g. the top left position of the rectangle); otherwise, the derived anchor point will be centered on the specified edge, or in the center of the anchor rectangle if no edge is specified.
- If two parallel anchor edges are specified (e.g. 'left' and 'right'), the invalid_input error is raised.
- Definition at line 9780 of file wayland-client-protocol-unstable.cpp.
void zxdg_positioner_v6_t::set_anchor_rect (int32_t x, int32_t y, int32_t width, int32_t height) — set the anchor rectangle within the parent surface
- Parameters:
  - x — x position of anchor rectangle
  - y — y position of anchor rectangle
  - width — width of anchor rectangle
  - height — height of anchor rectangle
- Specify the anchor rectangle within the parent surface that the child surface will be placed relative to. The rectangle is relative to the window geometry as defined by xdg_surface.set_window_geometry of the parent surface. The rectangle must be at least 1x1 large.
- When the xdg_positioner object is used to position a child surface, the anchor rectangle may not extend outside the window geometry of the positioned child's parent surface.
- If a zero or negative size is set the invalid_input error is raised.
- Definition at line 9774 of file wayland-client-protocol-unstable.cpp.
void zxdg_positioner_v6_t::set_constraint_adjustment (zxdg_positioner_v6_constraint_adjustment const & constraint_adjustment) — set the adjustment to be done when constrained
- Parameters:
  - constraint_adjustment — bit mask of constraint adjustments
- Specify how the window should be positioned if the originally intended position caused the surface to be constrained, meaning at least partially outside positioning boundaries set by the compositor. The adjustment is set by constructing a bitmask describing the adjustment to be made when the surface is constrained on that axis.
- If no bit for one axis is set, the compositor will assume that the child surface should not change its position on that axis when constrained.
- If more than one bit for one axis is set, the order of how adjustments are applied is specified in the corresponding adjustment descriptions.
- The default adjustment is none.
- Definition at line 9792 of file wayland-client-protocol-unstable.cpp.
void zxdg_positioner_v6_t::set_gravity (zxdg_positioner_v6_gravity const & gravity) — set child surface gravity
- Parameters:
  - gravity — bit mask of gravity directions
- Defines in what direction a surface should be positioned, relative to the anchor point of the parent surface. If two orthogonal gravities are specified (e.g. 'bottom' and 'right'), then the child surface will be placed in the specified direction; otherwise, the child surface will be centered over the anchor point on any axis that had no gravity specified.
- If two parallel gravities are specified (e.g. 'left' and 'right'), the invalid_input error is raised.
- Definition at line 9786 of file wayland-client-protocol-unstable.cpp.
void zxdg_positioner_v6_t::set_offset (int32_t x, int32_t y) — set surface position offset
- Parameters:
  - x — surface position x offset
  - y — surface position y offset
- Specify the surface position offset relative to the position of the anchor on the anchor rectangle and the anchor on the surface. For example if the anchor of the anchor rectangle is at (x, y), the surface has the gravity bottom|right, and the offset is (ox, oy), the calculated surface position will be (x + ox, y + oy). The offset position of the surface is the one used for constraint testing. See set_constraint_adjustment.
- An example use case is placing a popup menu on top of a user interface element, while aligning the user interface element of the parent surface with some user interface element placed somewhere in the popup surface.
- Definition at line 9798 of file wayland-client-protocol-unstable.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
void zxdg_positioner_v6_t::set_size (int32_t width, int32_t height) — set the size of the to-be positioned rectangle
- Parameters:
  - width — width of positioned rectangle
  - height — height of positioned rectangle
- Set the size of the surface that is to be positioned with the positioner object. The size is in surface-local coordinates and corresponds to the window geometry. See xdg_surface.set_window_geometry.
- If a zero or negative size is set the invalid_input error is raised.
- Definition at line 9768 of file wayland-client-protocol-unstable.cpp.

🗂️ Member Data Documentation 🗂️

these are the little constexpr version markers, bestie — they tell you the minimum protocol version each setter needs. tiny but iconic. ✨

std::uint32_t wayland::zxdg_positioner_v6_t::set_anchor_rect_since_version = 1 [static], [constexpr] — Minimum protocol version required for the set_anchor_rect function.
- Definition at line 7882 of file wayland-client-protocol-unstable.hpp.
std::uint32_t wayland::zxdg_positioner_v6_t::set_anchor_since_version = 1 [static], [constexpr] — Minimum protocol version required for the set_anchor function.
- Definition at line 7903 of file wayland-client-protocol-unstable.hpp.
std::uint32_t wayland::zxdg_positioner_v6_t::set_constraint_adjustment_since_version = 1 [static], [constexpr] — Minimum protocol version required for the set_constraint_adjustment function.
- Definition at line 7947 of file wayland-client-protocol-unstable.hpp.
std::uint32_t wayland::zxdg_positioner_v6_t::set_gravity_since_version = 1 [static], [constexpr] — Minimum protocol version required for the set_gravity function.
- Definition at line 7923 of file wayland-client-protocol-unstable.hpp.
std::uint32_t wayland::zxdg_positioner_v6_t::set_offset_since_version = 1 [static], [constexpr] — Minimum protocol version required for the set_offset function.
- Definition at line 7970 of file wayland-client-protocol-unstable.hpp.
std::uint32_t wayland::zxdg_positioner_v6_t::set_size_since_version = 1 [static], [constexpr] — Minimum protocol version required for the set_size function.
- Definition at line 7858 of file wayland-client-protocol-unstable.hpp.

✍️ Author ✍️

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

xoxo, your Unix bestie 💖 this page came from the Wayland++ auto-generated Doxygen source, version 1.0.1, dated Fri Mar 27 2026 — the footer timestamp trails off at 13: but you get the vibe. 🎀✨🦋

📦 where this page comes from

ubuntu stonking: waylandpp-dev 1.0.1-2 · BSD-2-Clause
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-06: a language model's rewrite of the original, under its terms