kanzi::EGLWindowSurface Class Reference

Class representing EGL window surface. More...

#include <kanzi/core.ui/platform/context_api/egl/egl_window_surface.hpp>

Public Member Functions
bool	destroy (const EGLDisplay &eglDisplay)
	Destroys EGL window surface.
	EGLWindowSurface (::EGLSurface eglSurface)
	Constructor.
	EGLWindowSurface (const EGLDisplay &eglDisplay, const EGLConfig &eglConfig, EGLNativeWindowType eglNativeWindow)
	Constructor.
	EGLWindowSurface (const EGLDisplay &eglDisplay, const EGLConfig &eglConfig, EGLNativeWindowType eglNativeWindow, SurfaceColorSpace surfaceColorSpace)
	Constructor.
KZ_NO_DISCARD::EGLSurface	getNativeHandle () const noexcept
	Gets EGL window surface handle.
bool	swapBuffers (const EGLDisplay &eglDisplay) const
	Posts rendering results.

Static Public Member Functions
static KZ_NO_DISCARD ::EGLSurface	getNoSurface () noexcept
	Gets a no surface EGL surface handle.
static KZ_NO_DISCARD optional< EGLWindowSurface >	tryCreate (const EGLDisplay &eglDisplay, const EGLConfig &eglConfig, EGLNativeWindowType eglNativeWindow, const EGLint *surfaceAttributes) noexcept
	Creates an EGL window surface.

Detailed Description

Class representing EGL window surface.

Constructor & Destructor Documentation

EGLWindowSurface() [1/3]

kanzi::EGLWindowSurface::EGLWindowSurface ( const EGLDisplay & eglDisplay, const EGLConfig & eglConfig, EGLNativeWindowType eglNativeWindow )

explicit

Constructor.

Parameters

eglDisplay	EGL display connection.
eglConfig	EGL configuration to use.
eglNativeWindow	Window to attach this surface to.

Postcondition

isNoSurface() returns false for this object.

egl::getError() returns EGL_SUCCESS.

EGLWindowSurface() [2/3]

kanzi::EGLWindowSurface::EGLWindowSurface ( const EGLDisplay & eglDisplay, const EGLConfig & eglConfig, EGLNativeWindowType eglNativeWindow, SurfaceColorSpace surfaceColorSpace )

explicit

Constructor.

Parameters

eglDisplay	EGL display connection.
eglConfig	EGL configuration to use.
eglNativeWindow	Window to attach this surface to.
surfaceColorSpace	Color space to use for the surface.

Postcondition

isNoSurface() returns false for this object.

egl::getError() returns EGL_SUCCESS.

Since

Kanzi 3.9.11 colorspace renamed to surfaceColorSpace for consistency with EGLPBufferSurface and EGLPixmapSurface.

EGLWindowSurface() [3/3]

kanzi::EGLWindowSurface::EGLWindowSurface ( ::EGLSurface eglSurface )

explicit

Constructor.

Parameters

eglSurface

EGL window surface handle.

Postcondition

egl::getError() returns EGL_SUCCESS.

Member Function Documentation

getNoSurface()

static KZ_NO_DISCARD ::EGLSurface kanzi::EGLWindowSurface::getNoSurface ( )

staticnoexcept

Gets a no surface EGL surface handle.

Returns

EGL surface handle with a value representing no surface.

tryCreate()

static KZ_NO_DISCARD optional< EGLWindowSurface > kanzi::EGLWindowSurface::tryCreate ( const EGLDisplay & eglDisplay, const EGLConfig & eglConfig, EGLNativeWindowType eglNativeWindow, const EGLint * surfaceAttributes )

staticnoexcept

Creates an EGL window surface.

Parameters

eglDisplay	EGL display connection.
eglConfig	EGL configuration to use.
eglNativeWindow	Window to attach this surface to.
surfaceAttributes	Array of extra attributes.

Return values

nullopt

Surface creation failed.

Returns

The newly created EGL window surface.

destroy()

bool kanzi::EGLWindowSurface::destroy

(

const EGLDisplay &

eglDisplay

)

Destroys EGL window surface.

Call this before destructing the object.

Parameters

eglDisplay

EGL display connection.

Postcondition

egl::getError() returns EGL_SUCCESS.

swapBuffers()

bool kanzi::EGLWindowSurface::swapBuffers

(

const EGLDisplay &

eglDisplay

)

const

Posts rendering results.

Implicitly flushes the rendering pipeline and executes all received rendering commands before posting.

Parameters

eglDisplay

EGL display connection.

See also

swapInterval().

Returns

True on success, false on failure.

Postcondition

egl::getError() returns EGL_SUCCESS.

getNativeHandle()

KZ_NO_DISCARD::EGLSurface kanzi::EGLWindowSurface::getNativeHandle ( ) const

noexcept

Gets EGL window surface handle.

Returns

EGL window surface handle.

---

The documentation for this class was generated from the following file:

• kanzi/core.ui/platform/context_api/egl/egl_window_surface.hpp