EGLFALSE

EGL_FALSE is a macro in the Khronos EGL API used to denote the false value in the EGLBoolean type. It is defined in the EGL headers (such as egl.h) alongside EGL_TRUE and is used to represent failure or a negative condition in EGL function calls.

EGLBoolean is the boolean type used by EGL, typically defined as an unsigned int. Within this type, EGL_TRUE is defined as 1 and EGL_FALSE is defined as 0. The macros provide a portable and readable way to express boolean results across different platforms and languages that interface with EGL.

In practice, many EGL functions return an EGLBoolean to indicate success or failure. A successful operation returns EGL_TRUE, while a failure returns EGL_FALSE. When a function returns EGL_FALSE, the error details can usually be retrieved with eglGetError, which provides an EGL error code corresponding to the failure.

Usage notes include adhering to the EGL API conventions: compare function results to EGL_TRUE or EGL_FALSE rather than testing for nonzero values, and include the appropriate EGL headers to access these definitions. While EGL_BOOLEAN can be interoperable with C's _Bool in some contexts, EGL-specific macros like EGL_FALSE and EGL_TRUE are preferred for clarity and portability within EGL-based code.

See also: EGL_TRUE, EGL_BOOLEAN, and eglGetError.