kde_external_brightness_v1

• # kde_external_brightness_v1

  Some brightness control mechanisms are somewhat unstable, or require root privileges, so putting them inside of the compositor is not desired. This protocol is for outsourcing the actual brightness-setting to a process outside of the compositor.

  Requests

  • #

    destroy

    Destroy the object.
    void kde_external_brightness_v1_destroy(

    struct kde_external_brightness_v1* kde_external_brightness_v1

    )
  • #

    create_brightness_control

    registers a brightness device with the compositor
    struct kde_external_brightness_device_v1* kde_external_brightness_v1_create_brightness_control(

    struct kde_external_brightness_v1* kde_external_brightness_v1

    )

• # kde_external_brightness_device_v1

  After creating this object, the client should issue all relevant setup requests (set_internal, set_edid, set_max_brightness) and finish the sequence with commit. Afterwards, for each change in values, the client must call commit again.

  Requests

  • #

    destroy

    destroy the object and unregister the brightness control device
    void kde_external_brightness_device_v1_destroy(

    struct kde_external_brightness_device_v1* kde_external_brightness_device_v1

    )
  • #

    set_internal

    sets whether or not the brightness device belongs to an internal display
    void kde_external_brightness_device_v1_set_internal(

    struct kde_external_brightness_device_v1* kde_external_brightness_device_v1,

    uint32_t internal /* 1 if it's an internal panel, 0 if not */

    )
  • #

    set_edid

    set the EDID data for identification of the display
    void kde_external_brightness_device_v1_set_edid(

    struct kde_external_brightness_device_v1* kde_external_brightness_device_v1,

    const char* string /* base-64 encoded string of the first 128 bytes of the EDID */

    )
  • #

    set_max_brightness

    notifies the compositor of the maximum brightness that can be set on this device
    void kde_external_brightness_device_v1_set_max_brightness(

    struct kde_external_brightness_device_v1* kde_external_brightness_device_v1,

    uint32_t value /* the maximum value that can be set */

    )
  • #

    commit

    notifies the compositor that all relevant identifiers and values have been sent
    void kde_external_brightness_device_v1_commit(

    struct kde_external_brightness_device_v1* kde_external_brightness_device_v1

    )

  Events

  • #

    requested_brightness

    requests the client to change the brightness to this value
    uint32_t value /* the value to set the device to */
    The client must ensure that if the brightness level changes due to external factors, that it overwrites those changes with what the compositor last requested.

Copyright Info