359 lines
9.9 KiB
C
359 lines
9.9 KiB
C
/*
|
|
* Cogl
|
|
*
|
|
* A Low Level GPU Graphics and Utilities API
|
|
*
|
|
* Copyright (C) 2012,2013 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.
|
|
*
|
|
* Cogl adds version information to both API deprecations and additions;
|
|
* by definining the macros %COGL_VERSION_MIN_REQUIRED and
|
|
* %COGL_VERSION_MAX_ALLOWED, you can specify the range of Cogl versions
|
|
* whose API you want to use. Functions that were deprecated before, or
|
|
* introduced after, this range will trigger compiler warnings. For instance,
|
|
* if we define the following symbols:
|
|
*
|
|
* |[
|
|
* COGL_VERSION_MIN_REQUIRED = COGL_VERSION_1_6
|
|
* COGL_VERSION_MAX_ALLOWED = COGL_VERSION_1_8
|
|
* ]|
|
|
*
|
|
* and we have the following functions annotated in the Cogl headers:
|
|
*
|
|
* |[
|
|
* COGL_DEPRECATED_IN_1_4 void cogl_function_A (void);
|
|
* COGL_DEPRECATED_IN_1_6 void cogl_function_B (void);
|
|
* COGL_AVAILABLE_IN_1_8 void cogl_function_C (void);
|
|
* COGL_AVAILABLE_IN_1_10 void cogl_function_D (void);
|
|
* ]|
|
|
*
|
|
* then any application code using the functions above will get the output:
|
|
*
|
|
* |[
|
|
* cogl_function_A: deprecation warning
|
|
* cogl_function_B: no warning
|
|
* cogl_function_C: no warning
|
|
* cogl_function_D: symbol not available warning
|
|
* ]|
|
|
*
|
|
* It is possible to disable the compiler warnings by defining the macro
|
|
* %COGL_DISABLE_DEPRECATION_WARNINGS before including the cogl.h
|
|
* header.
|
|
*/
|
|
|
|
/**
|
|
* 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))
|
|
|
|
/**
|
|
* COGL_VERSION_1_0:
|
|
*
|
|
* A macro that evaluates to the 1.0 version of Cogl, in a format
|
|
* that can be used by the C pre-processor.
|
|
*
|
|
* Since: 1.16
|
|
*/
|
|
#define COGL_VERSION_1_0 (COGL_VERSION_ENCODE (1, 0, 0))
|
|
|
|
/**
|
|
* COGL_VERSION_1_2:
|
|
*
|
|
* A macro that evaluates to the 1.2 version of Cogl, in a format
|
|
* that can be used by the C pre-processor.
|
|
*
|
|
* Since: 1.16
|
|
*/
|
|
#define COGL_VERSION_1_2 (COGL_VERSION_ENCODE (1, 2, 0))
|
|
|
|
/**
|
|
* COGL_VERSION_1_4:
|
|
*
|
|
* A macro that evaluates to the 1.4 version of Cogl, in a format
|
|
* that can be used by the C pre-processor.
|
|
*
|
|
* Since: 1.16
|
|
*/
|
|
#define COGL_VERSION_1_4 (COGL_VERSION_ENCODE (1, 4, 0))
|
|
|
|
/**
|
|
* COGL_VERSION_1_6:
|
|
*
|
|
* A macro that evaluates to the 1.6 version of Cogl, in a format
|
|
* that can be used by the C pre-processor.
|
|
*
|
|
* Since: 1.16
|
|
*/
|
|
#define COGL_VERSION_1_6 (COGL_VERSION_ENCODE (1, 6, 0))
|
|
|
|
/**
|
|
* COGL_VERSION_1_8:
|
|
*
|
|
* A macro that evaluates to the 1.8 version of Cogl, in a format
|
|
* that can be used by the C pre-processor.
|
|
*
|
|
* Since: 1.16
|
|
*/
|
|
#define COGL_VERSION_1_8 (COGL_VERSION_ENCODE (1, 8, 0))
|
|
|
|
/**
|
|
* COGL_VERSION_1_10:
|
|
*
|
|
* A macro that evaluates to the 1.10 version of Cogl, in a format
|
|
* that can be used by the C pre-processor.
|
|
*
|
|
* Since: 1.16
|
|
*/
|
|
#define COGL_VERSION_1_10 (COGL_VERSION_ENCODE (1, 10, 0))
|
|
|
|
/**
|
|
* COGL_VERSION_1_12:
|
|
*
|
|
* A macro that evaluates to the 1.12 version of Cogl, in a format
|
|
* that can be used by the C pre-processor.
|
|
*
|
|
* Since: 1.16
|
|
*/
|
|
#define COGL_VERSION_1_12 (COGL_VERSION_ENCODE (1, 12, 0))
|
|
|
|
/**
|
|
* COGL_VERSION_1_14:
|
|
*
|
|
* A macro that evaluates to the 1.14 version of Cogl, in a format
|
|
* that can be used by the C pre-processor.
|
|
*
|
|
* Since: 1.16
|
|
*/
|
|
#define COGL_VERSION_1_14 (COGL_VERSION_ENCODE (1, 14, 0))
|
|
|
|
/**
|
|
* COGL_VERSION_1_16:
|
|
*
|
|
* A macro that evaluates to the 1.16 version of Cogl, in a format
|
|
* that can be used by the C pre-processor.
|
|
*
|
|
* Since: 1.16
|
|
*/
|
|
#define COGL_VERSION_1_16 (COGL_VERSION_ENCODE (1, 16, 0))
|
|
|
|
/**
|
|
* COGL_VERSION_1_18:
|
|
*
|
|
* A macro that evaluates to the 1.18 version of Cogl, in a format
|
|
* that can be used by the C pre-processor.
|
|
*
|
|
* Since: 1.18
|
|
*/
|
|
#define COGL_VERSION_1_18 (COGL_VERSION_ENCODE (1, 18, 0))
|
|
|
|
/**
|
|
* COGL_VERSION_1_20:
|
|
*
|
|
* A macro that evaluates to the 1.20 version of Cogl, in a format
|
|
* that can be used by the C pre-processor.
|
|
*
|
|
* Since: 1.20
|
|
*/
|
|
#define COGL_VERSION_1_20 (COGL_VERSION_ENCODE (1, 20, 0))
|
|
|
|
/* evaluates to the current stable version; for development cycles,
|
|
* this means the next stable target
|
|
*/
|
|
#if (COGL_VERSION_MINOR_INTERNAL % 2)
|
|
#define COGL_VERSION_CURRENT_STABLE \
|
|
(COGL_VERSION_ENCODE (COGL_VERSION_MAJOR_INTERNAL, \
|
|
COGL_VERSION_MINOR_INTERNAL + 1, 0))
|
|
#else
|
|
#define COGL_VERSION_CURRENT_STABLE \
|
|
(COGL_VERSION_ENCODE (COGL_VERSION_MAJOR_INTERNAL, \
|
|
COGL_VERSION_MINOR_INTERNAL, 0))
|
|
#endif
|
|
|
|
/* evaluates to the previous stable version */
|
|
#if (COGL_VERSION_MINOR_INTERNAL % 2)
|
|
#define COGL_VERSION_PREVIOUS_STABLE \
|
|
(COGL_VERSION_ENCODE (COGL_VERSION_MAJOR_INTERNAL, \
|
|
COGL_VERSION_MINOR_INTERNAL - 1, 0))
|
|
#else
|
|
#define COGL_VERSION_PREVIOUS_STABLE \
|
|
(COGL_VERSION_ENCODE (COGL_VERSION_MAJOR_INTERNAL, \
|
|
COGL_VERSION_MINOR_INTERNAL - 2, 0))
|
|
#endif
|
|
|
|
#endif /* __COGL_VERSION_H__ */
|