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
|
/*
* Cogl
*
* A Low-Level GPU Graphics and Utilities API
*
* Copyright (C) 2012 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use, copy,
* modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*
*/
#ifndef __COGL_VERSION_H__
#define __COGL_VERSION_H__
#include <cogl/cogl-defines.h>
/**
* SECTION:cogl-version
* @short_description: Macros for determining the version of Cogl being used
*
* Cogl offers a set of macros for checking the version of the library
* at compile time.
*
* Since: 1.12.0
*/
/**
* COGL_VERSION_MAJOR:
*
* The major version of the Cogl library (1, if %COGL_VERSION is 1.2.3)
*
* Since: 1.12.0
*/
#define COGL_VERSION_MAJOR COGL_VERSION_MAJOR_INTERNAL
/**
* COGL_VERSION_MINOR:
*
* The minor version of the Cogl library (2, if %COGL_VERSION is 1.2.3)
*
* Since: 1.12.0
*/
#define COGL_VERSION_MINOR COGL_VERSION_MINOR_INTERNAL
/**
* COGL_VERSION_MICRO:
*
* The micro version of the Cogl library (3, if %COGL_VERSION is 1.2.3)
*
* Since: 1.12.0
*/
#define COGL_VERSION_MICRO COGL_VERSION_MICRO_INTERNAL
/**
* COGL_VERSION_STRING:
*
* The full version of the Cogl library, in string form (suited for
* string concatenation)
*
* Since: 1.12.0
*/
#define COGL_VERSION_STRING COGL_VERSION_STRING_INTERNAL
/* Macros to handle compacting a 3-component version number into an
* int for quick comparison. This assumes all of the components are <=
* 1023 and that an int is >= 31 bits */
#define COGL_VERSION_COMPONENT_BITS 10
#define COGL_VERSION_MAX_COMPONENT_VALUE \
((1 << COGL_VERSION_COMPONENT_BITS) - 1)
/**
* COGL_VERSION:
*
* The Cogl version encoded into a single integer using the
* COGL_VERSION_ENCODE() macro. This can be used for quick comparisons
* with particular versions.
*
* Since: 1.12.0
*/
#define COGL_VERSION \
COGL_VERSION_ENCODE (COGL_VERSION_MAJOR, \
COGL_VERSION_MINOR, \
COGL_VERSION_MICRO)
/**
* COGL_VERSION_ENCODE:
* @major: The major part of a version number
* @minor: The minor part of a version number
* @micro: The micro part of a version number
*
* Encodes a 3 part version number into a single integer. This can be
* used to compare the Cogl version. For example if there is a known
* bug in Cogl versions between 1.3.2 and 1.3.4 you could use the
* following code to provide a workaround:
*
* |[
* #if COGL_VERSION >= COGL_VERSION_ENCODE (1, 3, 2) && \
* COGL_VERSION <= COGL_VERSION_ENCODE (1, 3, 4)
* /<!-- -->* Do the workaround *<!-- -->/
* #endif
* ]|
*
* Since: 1.12.0
*/
#define COGL_VERSION_ENCODE(major, minor, micro) \
(((major) << (COGL_VERSION_COMPONENT_BITS * 2)) | \
((minor) << COGL_VERSION_COMPONENT_BITS) \
| (micro))
/**
* COGL_VERSION_GET_MAJOR:
* @version: An encoded version number
*
* Extracts the major part of an encoded version number.
*
* Since: 1.12.0
*/
#define COGL_VERSION_GET_MAJOR(version) \
(((version) >> (COGL_VERSION_COMPONENT_BITS * 2)) \
& COGL_VERSION_MAX_COMPONENT_VALUE)
/**
* COGL_VERSION_GET_MINOR:
* @version: An encoded version number
*
* Extracts the minor part of an encoded version number.
*
* Since: 1.12.0
*/
#define COGL_VERSION_GET_MINOR(version) \
(((version) >> COGL_VERSION_COMPONENT_BITS) & \
COGL_VERSION_MAX_COMPONENT_VALUE)
/**
* COGL_VERSION_GET_MICRO:
* @version: An encoded version number
*
* Extracts the micro part of an encoded version number.
*
* Since: 1.12.0
*/
#define COGL_VERSION_GET_MICRO(version) \
((version) & COGL_VERSION_MAX_COMPONENT_VALUE)
/**
* COGL_VERSION_CHECK:
* @major: The major part of a version number
* @minor: The minor part of a version number
* @micro: The micro part of a version number
*
* A convenient macro to check whether the Cogl version being compiled
* against is at least the given version number. For example if the
* function cogl_pipeline_frobnicate was added in version 2.0.1 and
* you want to conditionally use that function when it is available,
* you could write the following:
*
* |[
* #if COGL_VERSION_CHECK (2, 0, 1)
* cogl_pipeline_frobnicate (pipeline);
* #else
* /<!-- -->* Frobnication is not supported. Use a red color instead *<!-- -->/
* cogl_pipeline_set_color_4f (pipeline, 1.0f, 0.0f, 0.0f, 1.0f);
* #endif
* ]|
*
* Return value: %TRUE if the Cogl version being compiled against is
* greater than or equal to the given three part version number.
* Since: 1.12.0
*/
#define COGL_VERSION_CHECK(major, minor, micro) \
(COGL_VERSION >= COGL_VERSION_ENCODE (major, minor, micro))
#endif /* __COGL_VERSION_H__ */
|
