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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
/**
* libgammamm -- C++ wrapper for libgamma
* Copyright (C) 2014 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/>.
*/
#ifndef LIBGAMMA_FACADE_HH
#define LIBGAMMA_FACADE_HH
#include <string>
#include <vector>
#include "libgamma-native.hh"
#include "libgamma-method.hh"
namespace libgamma
{
/**
* List available adjustment methods by their order of preference based on the environment.
*
* @param operation Allowed values:
* 0: Methods that the environment suggests will work, excluding fake.
* 1: Methods that the environment suggests will work, including fake.
* 2: All real non-fake methods.
* 3: All real methods.
* 4: All methods.
* Other values invoke undefined behaviour.
* @return Array of methods.
*/
std::vector<int> list_methods(int operation);
/**
* Check whether an adjustment method is available, non-existing (invalid) methods will be
* identified as not available under the rationale that the library may be out of date.
*
* @param method The adjustment method.
* @return Whether the adjustment method is available.
*/
int is_method_available(int method);
/**
* Return the capabilities of an adjustment method.
*
* @param output The data structure to fill with the method's capabilities,
* @param method The adjustment method (display server and protocol).
*/
void method_capabilities(MethodCapabilities* output, int method);
/**
* Return the default site for an adjustment method.
*
* @param method The adjustment method (display server and protocol.)
* @return The default site, `nullptr` if it cannot be determined or if
* multiple sites are not supported by the adjustment method.
*/
std::string* method_default_site(int method);
/**
* Return the default variable that determines
* the default site for an adjustment method.
*
* @param method The adjustment method (display server and protocol.)
* @return The environ variables that is used to determine the
* default site. `nullptr` if there is none, that is, if
* the method does not support multiple sites.
*/
std::string* method_default_site_variable(int method);
/**
* Convert a raw representation of an EDID to a lowercase hexadecimal representation.
*
* @param edid The EDID in raw representation.
* @param length The length of `edid`.
* @return The EDID in lowercase hexadecimal representation.
*/
std::string behex_edid(const unsigned char* edid, size_t length);
/**
* Convert a raw representation of an EDID to a lowercase hexadecimal representation.
*
* @param edid The EDID in raw representation.
* @param length The length of `edid`.
* @return The EDID in lowercase hexadecimal representation.
*/
std::string behex_edid_lowercase(const unsigned char* edid, size_t length);
/**
* Convert a raw representation of an EDID to an uppercase hexadecimal representation.
*
* @param edid The EDID in raw representation.
* @param length The length of `edid`.
* @return The EDID in uppercase hexadecimal representation.
*/
std::string behex_edid_uppercase(const unsigned char* edid, size_t length);
/**
* Convert an hexadecimal representation of an EDID to a raw representation.
*
* @param edid The EDID in hexadecimal representation.
* @return The EDID in raw representation, it will be half the length
* of `edid` (the input value).
*/
unsigned char* unhex_edid(const std::string edid);
/**
* Initialise a gamma ramp in the proper way that allows all adjustment
* methods to read from and write to it without causing segmentation violation.
*
* @param ramps The gamma ramp to initialise.
* @param red The size of the gamma ramp for the red channel.
* @param green The size of the gamma ramp for the green channel.
* @param blue The size of the gamma ramp for the blue channel.
*/
void gamma_ramps8_initialise(GammaRamps<uint8_t>* ramps, size_t red, size_t blue, size_t green);
/**
* Initialise a gamma ramp in the proper way that allows all adjustment
* methods to read from and write to it without causing segmentation violation.
*
* @param ramps The gamma ramp to initialise.
* @param red The size of the gamma ramp for the red channel.
* @param green The size of the gamma ramp for the green channel.
* @param blue The size of the gamma ramp for the blue channel.
*/
void gamma_ramps16_initialise(GammaRamps<uint16_t>* ramps, size_t red, size_t blue, size_t green);
/**
* Initialise a gamma ramp in the proper way that allows all adjustment
* methods to read from and write to it without causing segmentation violation.
*
* @param ramps The gamma ramp to initialise.
* @param red The size of the gamma ramp for the red channel.
* @param green The size of the gamma ramp for the green channel.
* @param blue The size of the gamma ramp for the blue channel.
*/
void gamma_ramps32_initialise(GammaRamps<uint32_t>* ramps, size_t red, size_t blue, size_t green);
/**
* Initialise a gamma ramp in the proper way that allows all adjustment
* methods to read from and write to it without causing segmentation violation.
*
* @param ramps The gamma ramp to initialise.
* @param red The size of the gamma ramp for the red channel.
* @param green The size of the gamma ramp for the green channel.
* @param blue The size of the gamma ramp for the blue channel.
*/
void gamma_ramps64_initialise(GammaRamps<uint64_t>* ramps, size_t red, size_t blue, size_t green);
/**
* Initialise a gamma ramp in the proper way that allows all adjustment
* methods to read from and write to it without causing segmentation violation.
*
* @param ramps The gamma ramp to initialise.
* @param red The size of the gamma ramp for the red channel.
* @param green The size of the gamma ramp for the green channel.
* @param blue The size of the gamma ramp for the blue channel.
*/
void gamma_rampsf_initialise(GammaRamps<float>* ramps, size_t red, size_t blue, size_t green);
/**
* Initialise a gamma ramp in the proper way that allows all adjustment
* methods to read from and write to it without causing segmentation violation.
*
* @param ramps The gamma ramp to initialise.
* @param red The size of the gamma ramp for the red channel.
* @param green The size of the gamma ramp for the green channel.
* @param blue The size of the gamma ramp for the blue channel.
*/
void gamma_rampsd_initialise(GammaRamps<double>* ramps, size_t red, size_t blue, size_t green);
/**
* Create a gamma ramp in the proper way that allows all adjustment
* methods to read from and write to it without causing segmentation violation.
*
* @param red The size of the gamma ramp for the red channel.
* @param green The size of the gamma ramp for the green channel.
* @param blue The size of the gamma ramp for the blue channel.
* @return The gamma ramp.
*/
GammaRamps<uint8_t>* gamma_ramps8_create(size_t red, size_t blue, size_t green);
/**
* Create a gamma ramp in the proper way that allows all adjustment
* methods to read from and write to it without causing segmentation violation.
*
* @param red The size of the gamma ramp for the red channel.
* @param green The size of the gamma ramp for the green channel.
* @param blue The size of the gamma ramp for the blue channel.
* @return The gamma ramp.
*/
GammaRamps<uint16_t>* gamma_ramps16_create(size_t red, size_t blue, size_t green);
/**
* Create a gamma ramp in the proper way that allows all adjustment
* methods to read from and write to it without causing segmentation violation.
*
* @param red The size of the gamma ramp for the red channel.
* @param green The size of the gamma ramp for the green channel.
* @param blue The size of the gamma ramp for the blue channel.
* @return The gamma ramp.
*/
GammaRamps<uint32_t>* gamma_ramps32_create(size_t red, size_t blue, size_t green);
/**
* Create a gamma ramp in the proper way that allows all adjustment
* methods to read from and write to it without causing segmentation violation.
*
* @param red The size of the gamma ramp for the red channel.
* @param green The size of the gamma ramp for the green channel.
* @param blue The size of the gamma ramp for the blue channel.
* @return The gamma ramp.
*/
GammaRamps<uint64_t>* gamma_ramps64_create(size_t red, size_t blue, size_t green);
/**
* Create a gamma ramp in the proper way that allows all adjustment
* methods to read from and write to it without causing segmentation violation.
*
* @param red The size of the gamma ramp for the red channel.
* @param green The size of the gamma ramp for the green channel.
* @param blue The size of the gamma ramp for the blue channel.
* @return The gamma ramp.
*/
GammaRamps<float>* gamma_rampsf_create(size_t red, size_t blue, size_t green);
/**
* Create a gamma ramp in the proper way that allows all adjustment
* methods to read from and write to it without causing segmentation violation.
*
* @param red The size of the gamma ramp for the red channel.
* @param green The size of the gamma ramp for the green channel.
* @param blue The size of the gamma ramp for the blue channel.
* @return The gamma ramp.
*/
GammaRamps<double>* gamma_rampsd_create(size_t red, size_t blue, size_t green);
}
#endif
|
