2018
The Khronos Group Inc.
eglGetPlatformDisplay
3G
eglGetPlatformDisplay
return an EGL display connection
C Specification
EGLDisplay eglGetPlatformDisplay
EGLenum platform
void * native_display
const EGLAttrib * attrib_list
Parameters
platform
Specifies the native platform to obtain a display for.
native_display
Specifies the native display to connect to.
attrib_list
Specifies attributes of the display being obtained.
Description
eglGetPlatformDisplay obtains an
EGL display connection for the specified
platform and
native_display.
Valid values for platform are defined by
EGL extensions, as are requirements for
native_display.
For example, an extension specification that defines support for
the X11 platform may require that
native_display be a pointer to an X11
Display, and an extension specification that defines support for
the Microsoft Windows platform may require that
native_display be a pointer to a Windows
Device Context.
Valid attributes are defined by EGL extensions.
All attributes in attrib_list,
including boolean attributes, are immediately followed by
the corresponding desired value.
The list is terminated with EGL_NONE.
If an attribute is not specified in
attrib_list but is required for the
specified platform, then a default value
is used (and the attribute is said to be specified implicitly).
Multiple calls made to
eglGetPlatformDisplay with the same
parameters will return the same EGLDisplay handle.
If platform is valid but no display
matching native_display is available,
then EGL_NO_DISPLAY is returned; no error
condition is raised in this case.
Notes
eglGetPlatformDisplay is supported only if
the EGL version is 1.5 or greater.
Errors
eglGetPlatformDisplay returns
EGL_NO_DISPLAY on failure.
An EGL_BAD_PARAMETER error is generated if
platform has an invalid value.
See Also
eglInitialize,
eglGetDisplay