From ef6f01e3c73b7d0aec16dd8d476c0c024ab67e73 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Thu, 22 May 2014 00:45:16 +0200 Subject: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- src/gamma-helper.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/gamma-helper.h b/src/gamma-helper.h index 4324b84..1cd65f0 100644 --- a/src/gamma-helper.h +++ b/src/gamma-helper.h @@ -55,9 +55,25 @@ typedef union libgamma_gamma_ramps_any } libgamma_gamma_ramps_any_t; +/** + * A function for reading the gamma ramps from a CRTC + * + * @param this The CRTC state + * @param ramps The store for the gamma ramps + * @return Zero on success, otherwise (negative) the value of an + * error identifier provided by this library + */ typedef int libgamma_get_ramps_any_fun(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_any_t* restrict ramps); +/** + * A function for writing the gamma ramps to a CRTC + * + * @param this The CRTC state + * @param ramps The gamma ramps + * @return Zero on success, otherwise (negative) the value of an + * error identifier provided by this library + */ typedef int libgamma_set_ramps_any_fun(libgamma_crtc_state_t* restrict this, libgamma_gamma_ramps_any_t ramps); -- cgit v1.2.3-70-g09d2