Functions

Types and Values

Description

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:

1
2

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:

1
2
3
4

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:

1
2
3
4

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.

Functions

#define             COGL_VERSION_ENCODE(major, minor, micro)

1
2
3
4

#if COGL_VERSION >= COGL_VERSION_ENCODE (1, 3, 2) && \
    COGL_VERSION <= COGL_VERSION_ENCODE (1, 3, 4)
  /<!-- -->* Do the workaround *<!-- -->/
#endif

#define             COGL_VERSION_CHECK(major, minor, micro)

1
2
3
4
5
6

#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

#define             COGL_VERSION_GET_MAJOR(version)

#define             COGL_VERSION_GET_MINOR(version)

#define             COGL_VERSION_GET_MICRO(version)

Types and Values

#define COGL_VERSION_MAJOR COGL_VERSION_MAJOR_INTERNAL

#define COGL_VERSION_MINOR COGL_VERSION_MINOR_INTERNAL

#define COGL_VERSION_MICRO COGL_VERSION_MICRO_INTERNAL

#define COGL_VERSION_STRING COGL_VERSION_STRING_INTERNAL

#define             COGL_VERSION