compositor logical output region More...

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

Inheritance diagram for wayland::zxdg_output_v1_t:

Collaboration diagram for wayland::zxdg_output_v1_t:

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

Public Member Functions
std::function< void(int32_t, int32_t)> &	on_logical_position ()
	position of the output within the global compositor space More...

std::function< void(int32_t, int32_t)> &	on_logical_size ()
	size of the output in the global compositor space More...

std::function< void()> &	on_done ()
	all information about the output have been sent More...

std::function< void(std::string)> &	on_name ()
	name of this output More...

std::function< void(std::string)> &	on_description ()
	human-readable description of this output More...

uint32_t	get_id () const
	Get the id of a proxy object. More...

std::string	get_class () const
	Get the interface name (class) of a proxy object. More...

uint32_t	get_version () const
	Get the protocol object version of a proxy object. More...

wrapper_type	get_wrapper_type () const
	Get the type of a proxy object. More...

void	set_queue (event_queue_t queue)
	Assign a proxy to an event queue. More...

wl_proxy *	c_ptr () const
	Get a pointer to the underlying C struct. More...

bool	proxy_has_object () const
	Check whether this wrapper actually wraps an object. More...

	operator bool () const
	Check whether this wrapper actually wraps an object. More...

bool	operator== (const proxy_t &right) const
	Check whether two wrappers refer to the same object. More...

bool	operator!= (const proxy_t &right) const
	Check whether two wrappers refer to different objects. More...

void	proxy_release ()
	Release the wrapped object (if any), making this an empty wrapper. More...

Detailed Description

compositor logical output region

An xdg_output describes part of the compositor geometry.

This typically corresponds to a monitor that displays part of the compositor space.

For objects version 3 onwards, after all xdg_output properties have been sent (when the object is created and when properties are updated), a wl_output.done event is sent. This allows changes to the output properties to be seen as atomic, even if they happen via multiple events.

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

Member Enumeration Documentation

◆ wrapper_type

enum wayland::proxy_t::wrapper_type

stronginherited

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

Member Function Documentation

◆ c_ptr()

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

◆ get_class()

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

◆ get_id()

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.

◆ get_version()

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

◆ get_wrapper_type()

wrapper_type wayland::proxy_t::get_wrapper_type ( ) const

inlineinherited

Get the type of a proxy object.

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

◆ on_description()

std::function< void(std::string)> & zxdg_output_v1_t::on_description ( )

human-readable description of this output

Parameters

description output description

Many compositors can produce human-readable descriptions of their outputs. The client may wish to know this description as well, to communicate the user for various purposes.

The description is a UTF-8 string with no convention defined for its contents. Examples might include 'Foocorp 11" Display' or 'Virtual X11 output via :1'.

The description event is sent after creating an xdg_output (see xdg_output_manager.get_xdg_output) and whenever the description changes. The description is optional, and may not be sent at all.

For objects of version 2 and lower, this event is only sent once per xdg_output, and the description does not change over the lifetime of the wl_output global.

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

◆ on_done()

std::function< void()> & zxdg_output_v1_t::on_done ( )

all information about the output have been sent

This event is sent after all other properties of an xdg_output have been sent.

This allows changes to the xdg_output properties to be seen as atomic, even if they happen via multiple events.

For objects version 3 onwards, this event is deprecated. Compositors are not required to send it anymore and must send wl_output.done instead.

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

◆ on_logical_position()

std::function< void(int32_t, int32_t)> & zxdg_output_v1_t::on_logical_position ( )

position of the output within the global compositor space

Parameters

x	x position within the global compositor space
y	y position within the global compositor space

The position event describes the location of the wl_output within the global compositor space.

The logical_position event is sent after creating an xdg_output (see xdg_output_manager.get_xdg_output) and whenever the location of the output changes within the global compositor space.

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

◆ on_logical_size()

std::function< void(int32_t, int32_t)> & zxdg_output_v1_t::on_logical_size ( )

size of the output in the global compositor space

Parameters

width	width in global compositor space
height	height in global compositor space

The logical_size event describes the size of the output in the global compositor space.

For example, a surface without any buffer scale, transformation nor rotation set, with the size matching the logical_size will have the same size as the corresponding output when displayed.

Most regular Wayland clients should not pay attention to the logical size and would rather rely on xdg_shell interfaces.

Some clients such as Xwayland, however, need this to configure their surfaces in the global compositor space as the compositor may apply a different scale from what is advertised by the output scaling property (to achieve fractional scaling, for example).

For example, for a wl_output mode 3840×2160 and a scale factor 2:

A compositor not scaling the surface buffers will advertise a logical size of 3840×2160,
A compositor automatically scaling the surface buffers will advertise a logical size of 1920×1080,
A compositor using a fractional scale of 1.5 will advertise a logical size to 2560×1620.

For example, for a wl_output mode 1920×1080 and a 90 degree rotation, the compositor will advertise a logical size of 1080x1920.

The logical_size event is sent after creating an xdg_output (see xdg_output_manager.get_xdg_output) and whenever the logical size of the output changes, either as a result of a change in the applied scale or because of a change in the corresponding output mode(see wl_output.mode) or transform (see wl_output.transform).

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

◆ on_name()

std::function< void(std::string)> & zxdg_output_v1_t::on_name ( )

name of this output

Parameters

name	output name

Many compositors will assign names to their outputs, show them to the user, allow them to be configured by name, etc. The client may wish to know this name as well to offer the user similar behaviors.

The naming convention is compositor defined, but limited to alphanumeric characters and dashes (-). Each name is unique among all wl_output globals, but if a wl_output global is destroyed the same name may be reused later. The names will also remain consistent across sessions with the same hardware and software configuration.

Examples of names include 'HDMI-A-1', 'WL-1', 'X11-1', etc. However, do not assume that the name is a reflection of an underlying DRM connector, X11 connection, etc.

The name event is sent after creating an xdg_output (see xdg_output_manager.get_xdg_output). This event is only sent once per xdg_output, and the name does not change over the lifetime of the wl_output global.

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

◆ operator bool()

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

◆ operator!=()

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

inherited

Check whether two wrappers refer to different objects.

◆ operator==()

bool wayland::proxy_t::operator== ( const proxy_t & right ) const

inherited

Check whether two wrappers refer to the same object.

◆ proxy_has_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

◆ proxy_release()

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.

◆ set_queue()

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.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ wrapper_type

Member Function Documentation

◆ c_ptr()

◆ get_class()

◆ get_id()

◆ get_version()

◆ get_wrapper_type()

◆ on_description()

◆ on_done()

◆ on_logical_position()

◆ on_logical_size()

◆ on_name()

◆ operator bool()

◆ operator!=()

◆ operator==()

◆ proxy_has_object()

◆ proxy_release()

◆ set_queue()