aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/libcoopgamma.h.077
-rw-r--r--doc/man/libcoopgamma_get_gamma_info_recv.364
-rw-r--r--doc/man/libcoopgamma_get_gamma_info_sync.364
3 files changed, 205 insertions, 0 deletions
diff --git a/doc/man/libcoopgamma.h.0 b/doc/man/libcoopgamma.h.0
index 15fb38f..73a0b8a 100644
--- a/doc/man/libcoopgamma.h.0
+++ b/doc/man/libcoopgamma.h.0
@@ -120,6 +120,30 @@ Only remove the filter when it is explicitly requested.
The
.B <libcoopgamma.h>
header defines
+.I "enum libcoopgamma_colourspace"
+with the alias
+.I libcoopgamma_colourspace_t
+and the following distinct values:
+.TP
+.BR LIBCOOPGAMMA_UNKNOWN " = 0"
+The monitor's colourspace is unknown.
+.TP
+.BR LIBCOOPGAMMA_SRGB " > 0"
+The monitor uses sRGB as its colourspace.
+.TP
+.BR LIBCOOPGAMMA_RGB " > 0"
+The monitor uses an RGB colourspace other than sRGB.
+.TP
+.BR LIBCOOPGAMMA_NON_RGB " > 0"
+The monitor uses a non-RGB multicolour colourspace.
+.TP
+.BR LIBCOOPGAMMA_GREY " > 0"
+The monitor uses a singlecolour scale colourspace,
+possibility greyscale, or is monochrome.
+.P
+The
+.B <libcoopgamma.h>
+header defines
.I "struct libcoopgamma_ramps8"
.RI ( libcoopgamma_ramps8_t ),
.I "struct libcoopgamma_ramps16"
@@ -250,6 +274,59 @@ The number of stops in the green ramp.
.TP
.B "size_t blue_size"
The number of stops in the blue ramp.
+.TP
+.B "enum libcoopgamma_colourspace colourspace"
+The monitor's colurspace.
+.TP
+.B "int have_gamut"
+Is the gamut of the monitor known?
+If, and only if, so,
+.IR .red_x ,
+.IR .red_y ,
+.IR .green_x ,
+.IR .green_y ,
+.IR .blue_x ,
+.IR .blue_y ,
+.IR .white_x ,
+and
+.IR .white_y
+are set. Unless the monitor uses an
+RGB colourspace, this value should
+be false, but there is no guarantee
+of this, you have to check that the
+colourspace is an RGB colourspace.
+.TP
+.B "unsigned red_x"
+The x-value (CIE xyY) of the monitor's
+red colour, multiplied by 1024.
+.TP
+.B "unsigned red_y"
+The y-value (CIE xyY) of the monitor's
+red colour, multiplied by 1024.
+.TP
+.B "unsigned green_x"
+The x-value (CIE xyY) of the monitor's
+green colour, multiplied by 1024.
+.TP
+.B "unsigned green_y"
+The y-value (CIE xyY) of the monitor's
+green colour, multiplied by 1024.
+.TP
+.B "unsigned blue_x"
+The x-value (CIE xyY) of the monitor's
+blue colour, multiplied by 1024.
+.TP
+.B "unsigned blue_y"
+The y-value (CIE xyY) of the monitor's
+blue colour, multiplied by 1024.
+.TP
+.B "unsigned white_x"
+The x-value (CIE xyY) of the monitor's
+default white point, multiplied by 1024.
+.TP
+.B "unsigned white_y"
+The y-value (CIE xyY) of the monitor's
+default white point, multiplied by 1024.
.P
The
.B <libcoopgamma.h>
diff --git a/doc/man/libcoopgamma_get_gamma_info_recv.3 b/doc/man/libcoopgamma_get_gamma_info_recv.3
index b9822f2..1307fe5 100644
--- a/doc/man/libcoopgamma_get_gamma_info_recv.3
+++ b/doc/man/libcoopgamma_get_gamma_info_recv.3
@@ -59,6 +59,70 @@ The number of stops on the blue gamma ramp.
.TP
.I info->depth
Describes the gamma ramp types used for the CRTC.
+.P
+The
+.BR libcoopgamma_get_gamma_info_recv ()
+will also store monitor's colourspace information in
+.IR *info .
+In particular,
+.I info->colourspace
+will be set to
+.IR LIBCOOPGAMMA_SRGB ,
+.IR LIBCOOPGAMMA_RGB ,
+.IR LIBCOOPGAMMA_NON_RGB ,
+.IR LIBCOOPGAMMA_GREY ,
+or
+.IR LIBCOOPGAMMA_UNKNOWN ,
+and
+.I info->have_gamut
+will be set to 1 or 0.
+.I info->have_gamut
+should be set to 0 unless
+.I info->colourspace
+is set to
+.I LIBCOOPGAMMA_SRGB
+or
+.IR LIBCOOPGAMMA_RGB ,
+and it should be set to 1 if
+.I info->colourspace
+is set to
+.I LIBCOOPGAMMA_SRGB ,
+however there are no guarantees that
+this is true. If
+.I info->have_gamut
+is non-zero, the following will also be set:
+.TP
+.I info->red_x
+The x-value (CIE xyY) of the monitor's
+red colour, multiplied by 1024.
+.TP
+.I info->red_y
+The y-value (CIE xyY) of the monitor's
+red colour, multiplied by 1024.
+.TP
+.I info->green_x
+The x-value (CIE xyY) of the monitor's
+green colour, multiplied by 1024.
+.TP
+.I info->green_y
+The y-value (CIE xyY) of the monitor's
+green colour, multiplied by 1024.
+.TP
+.I info->blue_x
+The x-value (CIE xyY) of the monitor's
+blue colour, multiplied by 1024.
+.TP
+.I info->blue_y
+The y-value (CIE xyY) of the monitor's
+blue colour, multiplied by 1024.
+.TP
+.I info->white_x
+The x-value (CIE xyY) of the monitor's
+default white point, multiplied by 1024.
+.TP
+.I info->white_y
+The y-value (CIE xyY) of the monitor's
+default white point, multiplied by 1024.
.SH "RETURN VALUES"
Upon successful completion, the
.BR libcoopgamma_get_gamma_info_recv ()
diff --git a/doc/man/libcoopgamma_get_gamma_info_sync.3 b/doc/man/libcoopgamma_get_gamma_info_sync.3
index b4df1f6..3187231 100644
--- a/doc/man/libcoopgamma_get_gamma_info_sync.3
+++ b/doc/man/libcoopgamma_get_gamma_info_sync.3
@@ -53,6 +53,70 @@ The number of stops on the blue gamma ramp.
.TP
.I info->depth
Describes the gamma ramp types used for the CRTC.
+.P
+The
+.BR libcoopgamma_get_gamma_info_sync ()
+will also store monitor's colourspace information in
+.IR *info .
+In particular,
+.I info->colourspace
+will be set to
+.IR LIBCOOPGAMMA_SRGB ,
+.IR LIBCOOPGAMMA_RGB ,
+.IR LIBCOOPGAMMA_NON_RGB ,
+.IR LIBCOOPGAMMA_GREY ,
+or
+.IR LIBCOOPGAMMA_UNKNOWN ,
+and
+.I info->have_gamut
+will be set to 1 or 0.
+.I info->have_gamut
+should be set to 0 unless
+.I info->colourspace
+is set to
+.I LIBCOOPGAMMA_SRGB
+or
+.IR LIBCOOPGAMMA_RGB ,
+and it should be set to 1 if
+.I info->colourspace
+is set to
+.I LIBCOOPGAMMA_SRGB ,
+however there are no guarantees that
+this is true. If
+.I info->have_gamut
+is non-zero, the following will also be set:
+.TP
+.I info->red_x
+The x-value (CIE xyY) of the monitor's
+red colour, multiplied by 1024.
+.TP
+.I info->red_y
+The y-value (CIE xyY) of the monitor's
+red colour, multiplied by 1024.
+.TP
+.I info->green_x
+The x-value (CIE xyY) of the monitor's
+green colour, multiplied by 1024.
+.TP
+.I info->green_y
+The y-value (CIE xyY) of the monitor's
+green colour, multiplied by 1024.
+.TP
+.I info->blue_x
+The x-value (CIE xyY) of the monitor's
+blue colour, multiplied by 1024.
+.TP
+.I info->blue_y
+The y-value (CIE xyY) of the monitor's
+blue colour, multiplied by 1024.
+.TP
+.I info->white_x
+The x-value (CIE xyY) of the monitor's
+default white point, multiplied by 1024.
+.TP
+.I info->white_y
+The y-value (CIE xyY) of the monitor's
+default white point, multiplied by 1024.
.SH "RETURN VALUES"
Upon successful completion, the
.BR libcoopgamma_get_gamma_info_recv ()
generated by cgit v1.2.3-70-g09d2 (git 2.47.0) at 2024-11-17 02:24:48 +0000