org_kde_kwin_outputdevice

• # org_kde_kwin_outputdevice

  An outputdevice describes a display device available to the compositor. outputdevice is similar to wl_output, but focuses on output configuration management. A client can query all global outputdevice objects to enlist all available display devices, even those that may currently not be represented by the compositor as a wl_output. The client sends configuration changes to the server through the outputconfiguration interface, and the server applies the configuration changes to the hardware and signals changes to the outputdevices accordingly. This object is published as global during start up for every available display devices, or when one later becomes available, for example by being hotplugged via a physical connector.

  Events

  • #

    geometry

    geometric properties of the output
    int32_t x /* x position within the global compositor space */
    int32_t y /* y position within the global compositor space */
    int32_t physical_width /* width in millimeters of the output */
    int32_t physical_height /* height in millimeters of the output */
    int32_t subpixel /* subpixel orientation of the output */
    const char* make /* textual description of the manufacturer */
    const char* model /* textual description of the model */
    int32_t transform /* transform that maps framebuffer to output */
    The geometry event describes geometric properties of the output. The event is sent when binding to the output object and whenever any of the properties change.
  • #

    mode

    advertise available output modes and current one
    uint32_t flags /* bitfield of mode flags */
    int32_t width /* width of the mode in hardware units */
    int32_t height /* height of the mode in hardware units */
    int32_t refresh /* vertical refresh rate in mHz */
    int32_t mode_id /* Per outputdevice unique id to identify a mode */
    The mode event describes an available mode for the output. When the client binds to the outputdevice object, the server sends this event once for every available mode the outputdevice can be operated by. There will always be at least one event sent out on initial binding, which represents the current mode. Later on if an output changes its mode the event is sent again, whereby this event represents the mode that has now become current. In other words, the current mode is always represented by the latest event sent with the current flag set. The size of a mode is given in physical hardware units of the output device. This is not necessarily the same as the output size in the global compositor space. For instance, the output may be scaled, as described in org_kde_kwin_outputdevice.scale, or transformed, as described in org_kde_kwin_outputdevice.transform. The id can be used to refer to a mode when calling set_mode on an org_kde_kwin_outputconfiguration object.
  • #

    done

    sent all information about output
    This event is sent after all other properties have been sent on binding to the output object as well as after any other output property change have been applied later on. This allows to see changes to the output properties as atomic, even if multiple events successively announce them.
  • #

    scale

    output scaling properties
    int32_t factor /* scaling factor of output */
    This event contains scaling geometry information that is not in the geometry event. It may be sent after binding the output object or if the output scale changes later. If it is not sent, the client should assume a scale of 1. A scale larger than 1 means that the compositor will automatically scale surface buffers by this amount when rendering. This is used for high resolution displays where applications rendering at the native resolution would be too small to be legible. It is intended that scaling aware clients track the current output of a surface, and if it is on a scaled output it should use wl_surface.set_buffer_scale with the scale of the output. That way the compositor can avoid scaling the surface, and the client can supply a higher detail image.
  • #

    edid

    advertise EDID data for the output
    const char* raw /* base64-encoded EDID string */
    The edid event encapsulates the EDID data for the outputdevice. The event is sent when binding to the output object. The EDID data may be empty, in which case this event is sent anyway. If the EDID information is empty, you can fall back to the name et al. properties of the outputdevice.
  • #

    enabled

    output is enabled or disabled
    int32_t enabled /* output enabled state */
    The enabled event notifies whether this output is currently enabled and used for displaying content by the server. The event is sent when binding to the output object and whenever later on an output changes its state by becoming enabled or disabled.
  • #

    uuid

    A unique id for this outputdevice
    const char* uuid /* output devices ID */
    The uuid can be used to identify the output. It's controlled by the server entirely. The server should make sure the uuid is persistent across restarts. An empty uuid is considered invalid.
  • #

    scalef

    output scaling properties
    wl_fixed_t factor /* scaling factor of output */
    This event contains scaling geometry information that is not in the geometry event. It may be sent after binding the output object or if the output scale changes later. If it is not sent, the client should assume a scale of 1. A scale larger than 1 means that the compositor will automatically scale surface buffers by this amount when rendering. This is used for high resolution displays where applications rendering at the native resolution would be too small to be legible. It is intended that scaling aware clients track the current output of a surface, and if it is on a scaled output it should use wl_surface.set_buffer_scale with the scale of the output. That way the compositor can avoid scaling the surface, and the client can supply a higher detail image. wl_output will keep the output scale as an integer. In every situation except configuring the window manager you want to use that.
  • #

    colorcurves

    output color curves
    struct wl_array* red /* red color ramp */
    struct wl_array* green /* green color ramp */
    struct wl_array* blue /* blue color ramp */
    Describes the color intensity profile of the output. Commonly used for gamma/color correction. The array contains all color ramp values of the output. For example on 8bit screens there are 256 of them. The array elements are unsigned 16bit integers.
  • #

    serial_number

    Serial Number
    const char* serialNumber /* textual representation of serial number */
    Serial ID of the monitor, sent on startup before the first done event.
  • #

    eisa_id

    EISA ID
    const char* eisaId /* textual representation of EISA identifier */
    EISA ID of the monitor, sent on startup before the first done event.
  • #

    capabilities

    capability flags
    uint32_t flags
    What capabilities this device has, sent on startup before the first done event.
  • #

    overscan

    overscan
    uint32_t overscan /* amount of overscan of the monitor */
    Overscan value of the monitor in percent, sent on startup before the first done event.
  • #

    vrr_policy

    Variable Refresh Rate Policy
    uint32_t vrr_policy
    What policy the compositor will employ regarding its use of variable refresh rate.

  Enums

  • #

    subpixel

    subpixel geometry information
    ORG_KDE_KWIN_OUTPUTDEVICE_SUBPIXEL_UNKNOWN
    ORG_KDE_KWIN_OUTPUTDEVICE_SUBPIXEL_NONE
    ORG_KDE_KWIN_OUTPUTDEVICE_SUBPIXEL_HORIZONTAL_RGB
    ORG_KDE_KWIN_OUTPUTDEVICE_SUBPIXEL_HORIZONTAL_BGR
    ORG_KDE_KWIN_OUTPUTDEVICE_SUBPIXEL_VERTICAL_RGB
    ORG_KDE_KWIN_OUTPUTDEVICE_SUBPIXEL_VERTICAL_BGR
    This enumeration describes how the physical pixels on an output are laid out.
  • #

    transform

    transform from framebuffer to output
    ORG_KDE_KWIN_OUTPUTDEVICE_TRANSFORM_NORMAL
    ORG_KDE_KWIN_OUTPUTDEVICE_TRANSFORM_90
    ORG_KDE_KWIN_OUTPUTDEVICE_TRANSFORM_180
    ORG_KDE_KWIN_OUTPUTDEVICE_TRANSFORM_270
    ORG_KDE_KWIN_OUTPUTDEVICE_TRANSFORM_FLIPPED
    ORG_KDE_KWIN_OUTPUTDEVICE_TRANSFORM_FLIPPED_90
    ORG_KDE_KWIN_OUTPUTDEVICE_TRANSFORM_FLIPPED_180
    ORG_KDE_KWIN_OUTPUTDEVICE_TRANSFORM_FLIPPED_270
    This describes the transform, that a compositor will apply to a surface to compensate for the rotation or mirroring of an output device. The flipped values correspond to an initial flip around a vertical axis followed by rotation. The purpose is mainly to allow clients to render accordingly and tell the compositor, so that for fullscreen surfaces, the compositor is still able to scan out directly client surfaces.
  • #

    mode

    mode information
    ORG_KDE_KWIN_OUTPUTDEVICE_MODE_CURRENT /* indicates this is the current mode */
    ORG_KDE_KWIN_OUTPUTDEVICE_MODE_PREFERRED /* indicates this is the preferred mode */
    These flags describe properties of an output mode. They are used in the flags bitfield of the mode event.
  • #

    enablement

    describes enabled state
    ORG_KDE_KWIN_OUTPUTDEVICE_ENABLEMENT_DISABLED
    ORG_KDE_KWIN_OUTPUTDEVICE_ENABLEMENT_ENABLED
    Describes whether a device is enabled, i.e. device is used to display content by the compositor. This wraps a boolean around an int to avoid a boolean trap.
  • #

    capability

    describes capabilities of the outputdevice
    ORG_KDE_KWIN_OUTPUTDEVICE_CAPABILITY_OVERSCAN /* if this outputdevice can use overscan */
    ORG_KDE_KWIN_OUTPUTDEVICE_CAPABILITY_VRR /* if this outputdevice supports variable refresh rate */
    Describes what capabilities this device has.
  • #

    vrr_policy

    describes vrr policy
    ORG_KDE_KWIN_OUTPUTDEVICE_VRR_POLICY_NEVER
    ORG_KDE_KWIN_OUTPUTDEVICE_VRR_POLICY_ALWAYS
    ORG_KDE_KWIN_OUTPUTDEVICE_VRR_POLICY_AUTOMATIC
    Describes when the compositor may employ variable refresh rate

Copyright Info