aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/gamma-x-vidmode.h
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2021-03-02 18:11:58 +0100
committerMattias Andrée <maandree@kth.se>2021-03-02 18:11:58 +0100
commitd615f10762649507aebee9419147246bb1dc2a93 (patch)
tree4b3196b0bb70b6be4dd720c4be533517634b7f7e /src/lib/gamma-x-vidmode.h
parentX RAndR: Fix connection failure detection (diff)
downloadlibgamma-d615f10762649507aebee9419147246bb1dc2a93.tar.gz
libgamma-d615f10762649507aebee9419147246bb1dc2a93.tar.bz2
libgamma-d615f10762649507aebee9419147246bb1dc2a93.tar.xz
Change license + change style + misc
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'src/lib/gamma-x-vidmode.h')
-rw-r--r--src/lib/gamma-x-vidmode.h138
1 files changed, 58 insertions, 80 deletions
diff --git a/src/lib/gamma-x-vidmode.h b/src/lib/gamma-x-vidmode.h
index 510f03b..618d5c4 100644
--- a/src/lib/gamma-x-vidmode.h
+++ b/src/lib/gamma-x-vidmode.h
@@ -1,20 +1,4 @@
-/**
- * libgamma -- Display server abstraction layer for gamma ramp adjustments
- * Copyright (C) 2014, 2015 Mattias Andrée (maandree@member.fsf.org)
- *
- * This library is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this library. If not, see <http://www.gnu.org/licenses/>.
- */
+/* See LICENSE file for copyright and license details. */
#ifndef LIBGAMMA_GAMMA_X_VIDMODE_H
#define LIBGAMMA_GAMMA_X_VIDMODE_H
@@ -27,16 +11,16 @@
/**
- * Return the capabilities of the adjustment method.
+ * Return the capabilities of the adjustment method
*
- * @param this The data structure to fill with the method's capabilities.
+ * @param this The data structure to fill with the method's capabilities
*/
-void libgamma_x_vidmode_method_capabilities(libgamma_method_capabilities_t* restrict this);
+void libgamma_x_vidmode_method_capabilities(libgamma_method_capabilities_t *restrict);
/**
- * Initialise an allocated site state.
+ * Initialise an allocated site state
*
- * @param this The site state to initialise.
+ * @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
@@ -44,119 +28,113 @@ void libgamma_x_vidmode_method_capabilities(libgamma_method_capabilities_t* rest
* 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.
+ * error identifier provided by this library
*/
-int libgamma_x_vidmode_site_initialise(libgamma_site_state_t* restrict this,
- char* restrict site);
+int libgamma_x_vidmode_site_initialise(libgamma_site_state_t *restrict, char *restrict);
/**
- * Release all resources held by a site state.
+ * Release all resources held by a site state
*
- * @param this The site state.
+ * @param this The site state
*/
-void libgamma_x_vidmode_site_destroy(libgamma_site_state_t* restrict this);
+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.
+ * Restore the gamma ramps all CRTC:s with a site to the system settings
*
- * @param this The site state.
+ * @param this The site state
* @return Zero on success, otherwise (negative) the value of an
- * error identifier provided by this library.
+ * error identifier provided by this library
*/
-int libgamma_x_vidmode_site_restore(libgamma_site_state_t* restrict this);
+int libgamma_x_vidmode_site_restore(libgamma_site_state_t *restrict);
/**
- * Initialise an allocated partition state.
+ * 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.
+ * @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.
+ * error identifier provided by this library
*/
-int libgamma_x_vidmode_partition_initialise(libgamma_partition_state_t* restrict this,
- libgamma_site_state_t* restrict site, size_t partition);
+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.
+ * Release all resources held by a partition state
*
- * @param this The partition state.
+ * @param this The partition state
*/
-void libgamma_x_vidmode_partition_destroy(libgamma_partition_state_t* restrict this) __attribute__((const));
+void libgamma_x_vidmode_partition_destroy(libgamma_partition_state_t *restrict) __attribute__((const));
/**
- * Restore the gamma ramps all CRTC:s with a partition to the system settings.
+ * Restore the gamma ramps all CRTC:s with a partition to the system settings
*
- * @param this The partition state.
+ * @param this The partition state
* @return Zero on success, otherwise (negative) the value of an
- * error identifier provided by this library.
+ * error identifier provided by this library
*/
-int libgamma_x_vidmode_partition_restore(libgamma_partition_state_t* restrict this);
+int libgamma_x_vidmode_partition_restore(libgamma_partition_state_t *restrict);
/**
- * Initialise an allocated CRTC state.
+ * 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.
+ * @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.
+ * error identifier provided by this library
*/
-int libgamma_x_vidmode_crtc_initialise(libgamma_crtc_state_t* restrict this,
- libgamma_partition_state_t* restrict partition, size_t crtc) __attribute__((const));
+__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.
+ * Release all resources held by a CRTC state
*
- * @param this The CRTC state.
+ * @param this The CRTC state
*/
-void libgamma_x_vidmode_crtc_destroy(libgamma_crtc_state_t* restrict this) __attribute__((const));
+void libgamma_x_vidmode_crtc_destroy(libgamma_crtc_state_t *restrict) __attribute__((const));
/**
- * Restore the gamma ramps for a CRTC to the system settings for that CRTC.
+ * Restore the gamma ramps for a CRTC to the system settings for that CRTC
*
- * @param this The CRTC state.
+ * @param this The CRTC state
* @return Zero on success, otherwise (negative) the value of an
- * error identifier provided by this library.
+ * error identifier provided by this library
*/
-int libgamma_x_vidmode_crtc_restore(libgamma_crtc_state_t* restrict this);
+int libgamma_x_vidmode_crtc_restore(libgamma_crtc_state_t *restrict);
/**
- * Read information about a CRTC.
+ * 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`.
+ * @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 this,
- libgamma_crtc_state_t* restrict crtc, int32_t fields);
+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.
+ * 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.
+ * @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.
+ * error identifier provided by this library
*/
-int libgamma_x_vidmode_crtc_get_gamma_ramps16(libgamma_crtc_state_t* restrict this,
- libgamma_gamma_ramps16_t* restrict ramps);
+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.
+ * Set the gamma ramps for a CRTC, 16-bit gamma-depth version
*
- * @param this The CRTC state.
- * @param ramps The gamma ramps to apply.
+ * @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.
+ * error identifier provided by this library
*/
-int libgamma_x_vidmode_crtc_set_gamma_ramps16(libgamma_crtc_state_t* restrict this,
- libgamma_gamma_ramps16_t ramps);
+int libgamma_x_vidmode_crtc_set_gamma_ramps16(libgamma_crtc_state_t *restrict, libgamma_gamma_ramps16_t);
#endif
-