diff options
Diffstat (limited to 'gamma-x-vidmode.h')
| -rw-r--r-- | gamma-x-vidmode.h | 133 |
1 files changed, 133 insertions, 0 deletions
diff --git a/gamma-x-vidmode.h b/gamma-x-vidmode.h new file mode 100644 index 0000000..8a95442 --- /dev/null +++ b/gamma-x-vidmode.h @@ -0,0 +1,133 @@ +/* See LICENSE file for copyright and license details. */ +#ifndef LIBGAMMA_GAMMA_X_VIDMODE_H +#define LIBGAMMA_GAMMA_X_VIDMODE_H + + +/** + * Return the capabilities of the adjustment method + * + * @param this The data structure to fill with the method's capabilities + */ +void libgamma_x_vidmode_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 + */ +int libgamma_x_vidmode_site_initialise(libgamma_site_state_t *restrict, char *restrict); + +/** + * Release all resources held by a site state + * + * @param this The site state + */ +void libgamma_x_vidmode_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 + */ +int libgamma_x_vidmode_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 + */ +int libgamma_x_vidmode_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 + */ +void libgamma_x_vidmode_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 + */ +int libgamma_x_vidmode_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 + */ +__attribute__((const)) +int libgamma_x_vidmode_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 + */ +void libgamma_x_vidmode_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 + */ +int libgamma_x_vidmode_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` + */ +int libgamma_x_vidmode_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 + */ +int libgamma_x_vidmode_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 + */ +int libgamma_x_vidmode_crtc_set_gamma_ramps16(libgamma_crtc_state_t *restrict, libgamma_gamma_ramps16_t); + + +#endif |