aboutsummaryrefslogtreecommitdiffstats
path: root/src/libgamma-error.h
blob: 5091d46551a82c1224a112bc4d3651e5d291fc77 (plain) (blame)
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
/**
 * libgamma — Display server abstraction layer for gamma ramp adjustments
 * Copyright © 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_ERROR_H
#define LIBGAMMA_ERROR_H

#if !defined(LIBGAMMA_CONFIG_H) && !defined(DEBUG)
# error libgamma-error.h should not be included directly, include libgamma.h instead
#endif

#include <sys/types.h>


/**
 * Group that the user needs to be a member of if `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned
 */
extern gid_t libgamma_group_gid;

/**
 * Group that the user needs to be a member of if `LIBGAMMA_DEVICE_REQUIRE_GROUP` is returned,
 * `NULL` if the name of the group `libgamma_group_gid` cannot be determined
 */
extern const char* libgamma_group_name;


/**
 * The selected adjustment method does not exist
 * or has been excluded at compile-time
 */
#define LIBGAMMA_NO_SUCH_ADJUSTMENT_METHOD  (-1)

/**
 * `errno` has be set with a standard error number
 * to indicate the what has gone wrong
 */
#define LIBGAMMA_ERRNO_SET  (-2)

/**
 * The selected site does not exist
 */
#define LIBGAMMA_NO_SUCH_SITE  (-3)

/**
 * The selected partition does not exist
 */
#define LIBGAMMA_NO_SUCH_PARTITION  (-4)

/**
 * The selected CRTC does not exist
 */
#define LIBGAMMA_NO_SUCH_CRTC  (-5)

/**
 * Counter overflowed when counting the number of available items
 */
#define LIBGAMMA_IMPOSSIBLE_AMOUNT  (-6)

/**
 * The selected connector is disabled, it does not have a CRTC
 */
#define LIBGAMMA_CONNECTOR_DISABLED  (-7)

/**
 * The selected CRTC could not be opened, reason unknown
 */
#define LIBGAMMA_OPEN_CRTC_FAILED  (-8)

/**
 * The CRTC information field is not supported by the adjustment method
 */
#define LIBGAMMA_CRTC_INFO_NOT_SUPPORTED  (-9)

/**
 * Failed to read the current gamma ramps for the selected CRTC, reason unknown
 */
#define LIBGAMMA_GAMMA_RAMP_READ_FAILED  (-10)

/**
 * Failed to write the current gamma ramps for the selected CRTC, reason unknown
 */
#define LIBGAMMA_GAMMA_RAMP_WRITE_FAILED  (-11)

/**
 * The specified ramp sizes does not match the ramps sizes returned by the
 * adjustment methods in response to the query/command
 */
#define LIBGAMMA_GAMMA_RAMP_SIZE_CHANGED  (-12)

/**
 * The specified ramp sizes are not identical which is required by the adjustment method
 * (Only returned in debug mode)
 */
#define LIBGAMMA_MIXED_GAMMA_RAMP_SIZE  (-13)

/**
 * The specified ramp sizes are not supported by the adjustment method
 * (Only returned in debug mode)
 */
#define LIBGAMMA_WRONG_GAMMA_RAMP_SIZE  (-14)

/**
 * The adjustment method reported that the gamma ramps size is 1, or perhaps even zero or negative
 */
#define LIBGAMMA_SINGLETON_GAMMA_RAMP  (-15)

/**
 * The adjustment method failed to list available CRTC:s, reason unknown
 */
#define LIBGAMMA_LIST_CRTCS_FAILED  (-16)

/**
 * Failed to acquire mode resources from the adjustment method
 */
#define LIBGAMMA_ACQUIRING_MODE_RESOURCES_FAILED  (-17)

/**
 * The adjustment method reported that a negative number of partitions exists in the site
 */
#define LIBGAMMA_NEGATIVE_PARTITION_COUNT  (-18)

/**
 * The adjustment method reported that a negative number of CRTC:s exists in the partition
 */
#define LIBGAMMA_NEGATIVE_CRTC_COUNT  (-19)

/**
 * Device cannot be access becauses of insufficient permissions
 */
#define LIBGAMMA_DEVICE_RESTRICTED  (-20)

/**
 * Device cannot be access, reason unknown
 */
#define LIBGAMMA_DEVICE_ACCESS_FAILED  (-21)

/**
 * Device cannot be access, membership of the `libgamma_group_gid`
 * (named by `libgamma_group_name` (can be `NULL`, if so `errno` may
 * have been set to tell why)) is required
 */
#define LIBGAMMA_DEVICE_REQUIRE_GROUP  (-22)

/**
 * The graphics card appear to have been removed
 */
#define LIBGAMMA_GRAPHICS_CARD_REMOVED  (-23)

/**
 * The state of the requested information is unknown
 */
#define LIBGAMMA_STATE_UNKNOWN  (-24)



#endif