From f52513b09580c1533e6c48a4162d3d5f61f3b081 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Fri, 5 Mar 2021 18:23:13 +0100 Subject: misc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- method-x-randr.h | 213 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 213 insertions(+) create mode 100644 method-x-randr.h (limited to 'method-x-randr.h') diff --git a/method-x-randr.h b/method-x-randr.h new file mode 100644 index 0000000..81c5275 --- /dev/null +++ b/method-x-randr.h @@ -0,0 +1,213 @@ +/* See LICENSE file for copyright and license details. */ + +#include +#include + + +/** + * The major version of RandR the library expects + */ +#define RANDR_VERSION_MAJOR 1 + +/** + * The minor version of RandR the library expects + */ +#define RANDR_VERSION_MINOR 3 + + +/** + * Data structure for partition data + */ +typedef struct libgamma_x_randr_partition_data { + /** + * Mapping from CRTC indices to CRTC identifiers + */ + xcb_randr_crtc_t *crtcs; + + /** + * Mapping from output indices to output identifiers + */ + xcb_randr_output_t *outputs; + + /** + * The number of outputs available + */ + size_t outputs_count; + + /** + * Mapping from CRTC indices to output indices. + * CRTC's without an output (should be impossible) + * have the value `SIZE_MAX` which is impossible + * for an existing mapping + */ + size_t *crtc_to_output; + + /** + * Screen configuration timestamp + */ + xcb_timestamp_t config_timestamp; + +} libgamma_x_randr_partition_data_t; + + + +/** + * Return the capabilities of the adjustment method + * + * @param this The data structure to fill with the method's capabilities + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__))) +void libgamma_x_randr_method_capabilities(libgamma_method_capabilities_t *restrict); + +/** + * Initialise an allocated site state + * + * @param this The site state to initialise + * @param site The site identifier, unless it is `NULL` it must a + * `free`:able. Once the state is destroyed the library + * will attempt to free it. There you should not free + * it yourself, and it must not be a string constant + * or allocate on the stack. Note however that it will + * not be free:d if this function fails + * @return Zero on success, otherwise (negative) the value of an + * error identifier provided by this library + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__(1), __warn_unused_result__))) +int libgamma_x_randr_site_initialise(libgamma_site_state_t *restrict, char *restrict); + +/** + * Release all resources held by a site state. + * + * @param this The site state. + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__))) +void libgamma_x_randr_site_destroy(libgamma_site_state_t *restrict); + +/** + * Restore the gamma ramps all CRTC:s with a site to the system settings + * + * @param this The site state + * @return Zero on success, otherwise (negative) the value of an + * error identifier provided by this library + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__, __warn_unused_result__))) +int libgamma_x_randr_site_restore(libgamma_site_state_t *restrict); + + +/** + * Initialise an allocated partition state + * + * @param this The partition state to initialise + * @param site The site state for the site that the partition belongs to + * @param partition The the index of the partition within the site + * @return Zero on success, otherwise (negative) the value of an + * error identifier provided by this library + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__, __warn_unused_result__))) +int libgamma_x_randr_partition_initialise(libgamma_partition_state_t *restrict, libgamma_site_state_t *restrict, size_t); + +/** + * Release all resources held by a partition state + * + * @param this The partition state + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__))) +void libgamma_x_randr_partition_destroy(libgamma_partition_state_t *restrict); + +/** + * Restore the gamma ramps all CRTC:s with a partition to the system settings + * + * @param this The partition state + * @return Zero on success, otherwise (negative) the value of an + * error identifier provided by this library + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__, __warn_unused_result__))) +int libgamma_x_randr_partition_restore(libgamma_partition_state_t *restrict); + + +/** + * Initialise an allocated CRTC state + * + * @param this The CRTC state to initialise + * @param partition The partition state for the partition that the CRTC belongs to + * @param crtc The the index of the CRTC within the site + * @return Zero on success, otherwise (negative) the value of an + * error identifier provided by this library + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__, __warn_unused_result__))) +int libgamma_x_randr_crtc_initialise(libgamma_crtc_state_t *restrict, libgamma_partition_state_t *restrict, size_t); + +/** + * Release all resources held by a CRTC state + * + * @param this The CRTC state + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__))) +void libgamma_x_randr_crtc_destroy(libgamma_crtc_state_t *restrict); + +/** + * Restore the gamma ramps for a CRTC to the system settings for that CRTC + * + * @param this The CRTC state + * @return Zero on success, otherwise (negative) the value of an + * error identifier provided by this library + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__, __warn_unused_result__))) +int libgamma_x_randr_crtc_restore(libgamma_crtc_state_t *restrict); + + +/** + * Read information about a CRTC + * + * @param this Instance of a data structure to fill with the information about the CRTC + * @param crtc The state of the CRTC whose information should be read + * @param fields OR:ed identifiers for the information about the CRTC that should be read + * @return Zero on success, -1 on error; on error refer to the error reports in `this` + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__, __warn_unused_result__))) +int libgamma_x_randr_get_crtc_information(libgamma_crtc_information_t *restrict, libgamma_crtc_state_t *restrict, int32_t); + +/** + * Get the current gamma ramps for a CRTC, 16-bit gamma-depth version + * + * @param this The CRTC state + * @param ramps The gamma ramps to fill with the current values + * @return Zero on success, otherwise (negative) the value of an + * error identifier provided by this library + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__, __warn_unused_result__))) +int libgamma_x_randr_crtc_get_gamma_ramps16(libgamma_crtc_state_t *restrict, libgamma_gamma_ramps16_t *restrict); + +/** + * Set the gamma ramps for a CRTC, 16-bit gamma-depth version + * + * @param this The CRTC state + * @param ramps The gamma ramps to apply + * @return Zero on success, otherwise (negative) the value of an + * error identifier provided by this library + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__nonnull__, __warn_unused_result__))) +int libgamma_x_randr_crtc_set_gamma_ramps16(libgamma_crtc_state_t *restrict, const libgamma_gamma_ramps16_t *restrict); + + + +/** + * Translate an xcb error into a libgamma error + * + * @param error_code The xcb error + * @param default_error The libgamma error to use if the xcb error is not recognised + * @param return_errno Whether an `errno` value may be returned + * @return The libgamma error + */ +LIBGAMMA_GCC_ONLY__(__attribute__((__warn_unused_result__))) +int libgamma_x_randr_internal_translate_error(int, int, int); + + + +/* xcb violates the rule to never return struct:s */ +#ifdef IN_LIBGAMMA_X_RANDR +# ifdef __GNUC__ +# pragma GCC diagnostic push +# pragma GCC diagnostic ignored "-Waggregate-return" +# endif +#endif -- cgit v1.2.3-70-g09d2