xdg_output_unstable_v1

• # zxdg_output_manager_v1

  A global factory interface for xdg_output objects.

  Requests

  • #

    destroy

    destroy the xdg_output_manager object
    void zxdg_output_manager_v1_destroy(

    struct zxdg_output_manager_v1* zxdg_output_manager_v1

    )
    Using this request a client can tell the server that it is not going to use the xdg_output_manager object anymore. Any objects already created through this instance are not affected.
  • #

    get_xdg_output

    create an xdg output from a wl_output
    struct zxdg_output_v1* zxdg_output_manager_v1_get_xdg_output(

    struct zxdg_output_manager_v1* zxdg_output_manager_v1,

    struct wl_output* output

    )
    This creates a new xdg_output object for the given wl_output.

• # zxdg_output_v1

  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.

  Requests

  • #

    destroy

    destroy the xdg_output object
    void zxdg_output_v1_destroy(

    struct zxdg_output_v1* zxdg_output_v1

    )
    Using this request a client can tell the server that it is not going to use the xdg_output object anymore.

  Events

  • #

    logical_position

    position of the output within the global compositor space
    int32_t x /* x position within the global compositor space */
    int32_t 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.
  • #

    logical_size

    size of the output in the global compositor space
    int32_t width /* width in global compositor space */
    int32_t height /* height in global compositor space */
    The logical_size event describes the size of the output in the global compositor space. 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 monitor viewport in its compositing space will advertise a logical size of 3840×2160, - A compositor scaling the monitor viewport with scale factor 2 will advertise a logical size of 1920×1080, - A compositor scaling the monitor viewport using a fractional scale of 1.5 will advertise a logical size of 2560×1440. 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).
  • #

    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.
  • #

    name

    name of this output
    const char* 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. This event is deprecated, instead clients should use wl_output.name. Compositors must still support this event.
  • #

    description

    human-readable description of this output
    const char* 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. This event is deprecated, instead clients should use wl_output.description. Compositors must still support this event.

Copyright Info