eglGetConfigAttrib

Name

eglGetConfigAttrib - return information about an EGL frame buffer configuration

C Specification

EGLBoolean eglGetConfigAttrib(EGLDisplay display,
    EGLConfig config,
    EGLint attribute,
    EGLint * value)

Parameters

display: Specifies the EGL display connection.
config: Specifies the EGL frame buffer configuration to be queried.
attribute: Specifies the EGL rendering context attribute to be returned.
value: Returns the requested value.

Description

eglGetConfigAttrib returns in value the value of attribute for config. attribute can be one of the following:

EGL_BUFFER_SIZE: Returns the depth of the color buffer. It is the sum of EGL_RED_SIZE, EGL_GREEN_SIZE, EGL_BLUE_SIZE, and EGL_ALPHA_SIZE.
EGL_RED_SIZE: Returns the number of bits of red stored in the color buffer.
EGL_GREEN_SIZE: Returns the number of bits of green stored in the color buffer.
EGL_BLUE_SIZE: Returns the number of bits of blue stored in the color buffer.
EGL_ALPHA_SIZE: Returns the number of bits of alpha stored in the color buffer.
EGL_CONFIG_CAVEAT: Returns the caveats for the frame buffer configuration. Possible caveat values are EGL_NONE, EGL_SLOW_CONFIG, and EGL_NON_CONFORMANT.
EGL_CONFIG_ID: Returns the ID of the frame buffer configuration.
EGL_DEPTH_SIZE: Returns the number of bits in the depth buffer.
EGL_LEVEL: Returns the frame buffer level. Level zero is the default frame buffer. Positive levels correspond to frame buffers that overlay the default buffer and negative levels correspond to frame buffers that underlay the default buffer.
EGL_MAX_PBUFFER_WIDTH: Returns the maximum width of a pixel buffer surface in pixels.
EGL_MAX_PBUFFER_HEIGHT: Returns the maximum height of a pixel buffer surface in pixels.
EGL_MAX_PBUFFER_PIXELS: Returns the maximum size of a pixel buffer surface in pixels.
EGL_NATIVE_RENDERABLE: Returns EGL_TRUE if native rendering APIs can render into the surface, EGL_FALSE otherwise.
EGL_NATIVE_VISUAL_ID: Returns the ID of the associated native visual.
EGL_NATIVE_VISUAL_TYPE: Returns the type of the associated native visual.
EGL_PRESERVED_RESOURCES: Returns EGL_TRUE if resources are preserved across power management events, EGL_FALSE otherwise.
EGL_SAMPLE_BUFFERS: Returns the number of multisample buffers.
EGL_SAMPLES: Returns the number of samples per pixel.
EGL_STENCIL_BITS: Returns the number of bits in the stencil buffer.
EGL_SURFACE_TYPE: Returns the types of supported EGL surfaces.
EGL_TRANSPARENT_TYPE: Returns the type of supported transparency. Possible transparency values are: EGL_NONE, and EGL_TRANSPARENT_RGB.
EGL_TRANSPARENT_RED: Returns the transparent red value.
EGL_TRANSPARENT_GREEN: Returns the transparent green value.
EGL_TRANSPARENT_BLUE: Returns the transparent blue value.

Errors

EGL_FALSE is returned on failure, EGL_TRUE otherwise. value is not modified when EGL_FALSE is returned.

EGL_BAD_DISPLAY is generated if display is not an EGL display connection.

EGL_NOT_INITIALIZED is generated if display has not been initialized.

EGL_BAD_CONFIG is generated if config is not an EGL frame buffer configuration.

EGL_BAD_ATTRIBUTE is generated if attribute is not a valid frame buffer configuration attribute.

Copyright