VTK  9.5.20250811
Public Member Functions | Protected Attributes | List of all members
vtkEGLConfig Class Referenceabstract

Base class for EGL configuration. More...

#include <vtkEGLConfig.h>

Inheritance diagram for vtkEGLConfig:
[legend]

Public Member Functions

 vtkEGLConfig ()=default
 
virtual ~vtkEGLConfig ()=default
 
virtual void SetOnscreenRendering (bool onscreenRendering)
 Set the onscreen rendering flag.
 
virtual EGLenum GetPlatform ()=0
 Get the platform type.
 
virtual void * GetDisplay ()=0
 Get the display object.
 
virtual void CreateWindowSurface (EGLSurface &surface, EGLDisplay display, EGLConfig config, int width, int height)=0
 Create an EGL window surface.
 
virtual void CreateContext (EGLContext &context, EGLDisplay display, EGLConfig config)=0
 Create an EGL context.
 

Protected Attributes

bool OnscreenRendering = false
 

Detailed Description

Base class for EGL configuration.

This class is used to create EGL configurations for different platforms (e.g., Android, Wayland). It provides a common interface for creating EGL surfaces and contexts, as well as retrieving display information.

Definition at line 22 of file vtkEGLConfig.h.

Constructor & Destructor Documentation

◆ vtkEGLConfig()

vtkEGLConfig::vtkEGLConfig ( )
default

◆ ~vtkEGLConfig()

virtual vtkEGLConfig::~vtkEGLConfig ( )
virtualdefault

Member Function Documentation

◆ SetOnscreenRendering()

virtual void vtkEGLConfig::SetOnscreenRendering ( bool  onscreenRendering)
virtual

Set the onscreen rendering flag.

Default is false.

Reimplemented in vtkEGLAndroidConfig, and vtkEGLXConfig.

◆ GetPlatform()

virtual EGLenum vtkEGLConfig::GetPlatform ( )
pure virtual

Get the platform type.

Implemented in vtkEGLAndroidConfig, vtkEGLWaylandConfig, and vtkEGLXConfig.

◆ GetDisplay()

virtual void * vtkEGLConfig::GetDisplay ( )
pure virtual

Get the display object.

Note
: return a void* as type is dependent on the platform, see eglGetPlatformDisplay.

Implemented in vtkEGLAndroidConfig, vtkEGLWaylandConfig, and vtkEGLXConfig.

◆ CreateWindowSurface()

virtual void vtkEGLConfig::CreateWindowSurface ( EGLSurface &  surface,
EGLDisplay  display,
EGLConfig  config,
int  width,
int  height 
)
pure virtual

Create an EGL window surface.

Implemented in vtkEGLAndroidConfig, vtkEGLWaylandConfig, and vtkEGLXConfig.

◆ CreateContext()

virtual void vtkEGLConfig::CreateContext ( EGLContext &  context,
EGLDisplay  display,
EGLConfig  config 
)
pure virtual

Create an EGL context.

Implemented in vtkEGLAndroidConfig, vtkEGLWaylandConfig, and vtkEGLXConfig.

Member Data Documentation

◆ OnscreenRendering

bool vtkEGLConfig::OnscreenRendering = false
protected

Definition at line 58 of file vtkEGLConfig.h.


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