This repository has been archived by the owner on Jul 3, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
libglitter_colour_model_convert_rasters_double.3
153 lines (151 loc) · 5.64 KB
/
libglitter_colour_model_convert_rasters_double.3
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
.TH LIBGLITTER_COLOUR_MODEL_CONVERT_RASTERS_* 3 LIBGLITTER
.SH NAME
LIBGLITTER_COLOUR_MODEL_CONVERT_RASTERS_* - Change colour model used for a set of corasters
.SH SYNOPSIS
.LP
.nf
#include <libglitter.h>
void libglitter_colour_model_convert_rasters_double(size_t \fIn\fP, size_t \fIm\fP, double *\fIoutputs\fP[m],
const double *\fIinputs\fP[n], size_t \fIoutput_rowsize\fP,
size_t \fIoutput_cellsize\fP, size_t \fIinput_rowsize\fP,
size_t \fIinput_cellsize\fP, size_t \fIwidth\fP,
size_t \fIheight\fP, const double \fImatrix\fP[m][n]);
void libglitter_colour_model_convert_rasters_float(size_t \fIn\fP, size_t \fIm\fP, float *\fIoutputs\fP[m],
const float *\fIinputs\fP[n], size_t \fIoutput_rowsize\fP,
size_t \fIoutput_cellsize\fP, size_t \fIinput_rowsize\fP,
size_t \fIinput_cellsize\fP, size_t \fIwidth\fP,
size_t \fIheight\fP, const float \fImatrix\fP[m][n]);
.fi
.PP
Link with
.IR "-lglitter -lm" .
.SH DESCRIPTION
The
.BR libglitter_colour_model_convert_rasters_double ()
and
.BR libglitter_colour_model_convert_rasters_float ()
functions convert a set of rasters (one per source
colour channel) into another set of rasters (one per
target colour channel) using a different colour model.
This is useful for application that cannot output
directly in the output's colour model.
.PP
.I n
shall be the number of source colour channels
(input rasters), and
.I m
shall be the number of target colour channels
(output rasters).
.PP
.I outputs
shall be the list of output rasters: it is to its elements
that the function will write. Note that the rasters shall
already be allocated. Additionally, the function may offset
the input pointers in this list during execution. Therefore,
the contents of this list shall be considered undefined
immediately when the function is called, and may not be
modified before the function terminates. The application
must therefore have the pointers to these rasters saved
elsewhere. The order the rasters shall have in the list
.I outputs
is determined how the colour model conversion matrix
.RI ( matrix )
was constructed: if it was created using the
.BR libglitter_colour_model_convert_rasters_double (3),
function, or the
.BR libglitter_colour_model_convert_rasters_float (3),
function, the order shall be (0) red, (1) green, (2) blue
or (0) X, (1) Y, (2) Z.
.PP
.I inputs
shall be the list of input rasters: it is from its elements
that the function will read. The function may offset the
input pointers in this list during execution. Therefore,
the contents of this list shall be considered undefined
immediately when the function is called, and may not be
modified before the function terminates. The application
must therefore have the pointers to these rasters saved
elsewhere. The order the rasters shall have in the list
.I inputs
is determined how the colour model conversion matrix
.RI ( matrix )
was constructed: if it was created using the
.BR libglitter_colour_model_convert_rasters_double (3),
function, or the
.BR libglitter_colour_model_convert_rasters_float (3),
function, the order shall the order the output's primary
colours' chromas hade in the function's argument list.
.PP
.I output_cellsize
shall be the number of elements in an output raster the
pointer to the raster must be offset with to get to a
pointer to the next cell in the raster.
.PP
.I output_rowsize
shall be the number of cells (not elements; but rather the
number of elements divided by
.IR output_cellsize )
in an output raster the pointer to the raster must be
offset with to get a pointer to the next row but the
same column in the raster
.PP
.I input_cellsize
shall be the number of elements in an input raster the
pointer to the raster must be offset with to get to a
pointer to the next cell in the raster.
.PP
.I input_rowsize
shall be the number of cells (not elements; but rather the
number of elements divided by
.IR input_cellsize )
in an input raster the pointer to the raster must be
offset with to get a pointer to the next row but the
same column in the raster
.PP
.I width
and
.I height
shall describe the affected area in the rasters.
.I width
shall be the number of pixels the rasters have
horizontally, and
.I height
shall be the number of pixels the rasters have
vertically.
.PP
.I matrix
shall be column-major conversion matrix from the source
colour model (the output's colour model) to the target
colour model (the application's colour model).
.PP
All rasters are in row-major order and must be distinct,
except the input rasters are allowed to the same, with
the same offsets, as the output rasters: they must overlap
exactly or not at all.
.PP
By default, these functions do not use hardware acceleration,
they run on the CPU. However the
.BR libglitter_enable_acceleration (3)
may be able to enable hardware acceleration for these
functions. It will require at least the following bits in
its first argument to enable hardware acceleration:
.RS
.TP
.I LIBGLITTER_FEATURE_COLOUR_MODEL | LIBGLITTER_FEATURE_DOUBLE_TYPE
for
.BR libglitter_colour_model_convert_rasters_double ()
or
.TP
.I LIBGLITTER_FEATURE_COLOUR_MODEL | LIBGLITTER_FEATURE_FLOAT_TYPE
for
.BR libglitter_colour_model_convert_rasters_float ().
.RE
.SH RETURN VALUES
None.
.SH ERRORS
None.
.SH SEE ALSO
.BR libglitter (7),
.BR libglitter_colour_model_convert_rasters_double (3),
.BR libglitter_compose_double (3),
.BR libglitter_desaturate_double (3)