Kanzi  3.9.5
Kanzi Engine API
kanzi::EGLPBufferSurface Class Reference

Class representing EGL PBuffer surface. More...

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

Public Member Functions

bool destroy (const EGLDisplay &eglDisplay)
 Destroys EGL PBuffer surface. More...
 
 EGLPBufferSurface (const EGLDisplay &eglDisplay, const EGLConfig &eglConfig, int width, int height)
 Constructor. More...
 
 EGLPBufferSurface (const EGLDisplay &eglDisplay, const EGLConfig &eglConfig, const int *attributes)
 Constructor. More...
 
KZ_NO_DISCARD ::EGLSurface getNativeHandle () const noexcept
 Gets EGL PBuffer surface handle. More...
 
bool swapBuffers (const EGLDisplay &eglDisplay) const
 Posts rendering results. More...
 

Static Public Member Functions

static KZ_NO_DISCARD ::EGLSurface getNoSurface () noexcept
 Gets an no surface EGL surface handle. More...
 

Detailed Description

Class representing EGL PBuffer surface.

Constructor & Destructor Documentation

◆ EGLPBufferSurface() [1/2]

kanzi::EGLPBufferSurface::EGLPBufferSurface ( const EGLDisplay eglDisplay,
const EGLConfig eglConfig,
int  width,
int  height 
)
explicit

Constructor.

Creates a PBuffer surface of the default color space, unsuitable for use as a texture.

Parameters
eglDisplayEGL display connection.
eglConfigEGL configuration to use.
widthWidth of the PBuffer surface in pixels.
heightHeight of the PBuffer surface in pixels.
Postcondition
isNoSurface() returns false for this object.
egl::getError() returns EGL_SUCCESS.

◆ EGLPBufferSurface() [2/2]

kanzi::EGLPBufferSurface::EGLPBufferSurface ( const EGLDisplay eglDisplay,
const EGLConfig eglConfig,
const int *  attributes 
)
explicit

Constructor.

Parameters
eglDisplayEGL display connection.
eglConfigEGL configuration to use.
attributesArray of extra attributes.
Postcondition
isNoSurface() returns false for this object.
egl::getError() returns EGL_SUCCESS.

Member Function Documentation

◆ getNoSurface()

static KZ_NO_DISCARD ::EGLSurface kanzi::EGLPBufferSurface::getNoSurface ( )
staticnoexcept

Gets an no surface EGL surface handle.

Returns
EGL surface handle with a value representing no surface.

◆ destroy()

bool kanzi::EGLPBufferSurface::destroy ( const EGLDisplay eglDisplay)

Destroys EGL PBuffer surface.

Call this before destructing the object.

Parameters
eglDisplayEGL display connection.
Postcondition
egl::getError() returns EGL_SUCCESS.

◆ swapBuffers()

bool kanzi::EGLPBufferSurface::swapBuffers ( const EGLDisplay eglDisplay) const

Posts rendering results.

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

Parameters
eglDisplayEGL display connection.
See also
swapInterval().
Returns
True on success, false on failure.
Postcondition
egl::getError() returns EGL_SUCCESS.

◆ getNativeHandle()

KZ_NO_DISCARD ::EGLSurface kanzi::EGLPBufferSurface::getNativeHandle ( ) const
noexcept

Gets EGL PBuffer surface handle.

Returns
EGL PBuffer surface handle.

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