VTK  9.5.20251123
vtkEGLRenderWindowInternals Class Reference

Internal class used to store and control EGL state. More...

#include <vtkEGLRenderWindowInternals.h>

Public Member Functions

EGLDisplay GetDisplay () const
 Return the EGLDisplay.
 
EGLDisplay GetSurface () const
 Return the EGLSurface.
 
void SwapBuffer ()
 Ensure to call the SwapBuffers() on the correct display and surface.
 
int GetNumberOfDevices ()
 Get the number of devices (graphic cards) from the system.
 
bool SetDeviceAsDisplay (int deviceIndex)
 Set the wanted device for display if the device is available.
 
void DestroyWindow ()
 Release EGL window.
 
void ConfigureWindow (int width, int height)
 Configure the current EGLWindow with the requested size.
 
void SetDeviceIndex (int deviceIndex)
 Setter used to store the device expected by the user.
 
void SetUseOnscreenRendering (bool useOnscreenRendering)
 Setter to handle onscreen rendering.
 
void GetSizeFromSurface (int *size)
 Get the current size of the EGLSurface.
 
void ReleaseCurrent ()
 Release the EGL state.
 
bool MakeCurrent ()
 Try to attach the EGL rendering context to the EGL surface.
 
 vtkEGLRenderWindowInternals ()
 
 ~vtkEGLRenderWindowInternals ()=default
 
EGLContext GetContext () const
 Get/Set the EGLContext.
 
void SetContext (EGLContext context)
 Get/Set the EGLContext.
 
EGLNativeWindowType GetWindow () const
 Get/Set the EGLWindow.
 
void SetWindow (EGLNativeWindowType window)
 Get/Set the EGLWindow.
 

Detailed Description

Internal class used to store and control EGL state.

vtkEGLRenderWindow

Definition at line 19 of file vtkEGLRenderWindowInternals.h.

Constructor & Destructor Documentation

◆ vtkEGLRenderWindowInternals()

vtkEGLRenderWindowInternals::vtkEGLRenderWindowInternals ( )

◆ ~vtkEGLRenderWindowInternals()

vtkEGLRenderWindowInternals::~vtkEGLRenderWindowInternals ( )
default

Member Function Documentation

◆ GetDisplay()

EGLDisplay vtkEGLRenderWindowInternals::GetDisplay ( ) const
inlinenodiscard

Return the EGLDisplay.

Definition at line 25 of file vtkEGLRenderWindowInternals.h.

◆ GetSurface()

EGLDisplay vtkEGLRenderWindowInternals::GetSurface ( ) const
inlinenodiscard

Return the EGLSurface.

Definition at line 30 of file vtkEGLRenderWindowInternals.h.

◆ GetContext()

EGLContext vtkEGLRenderWindowInternals::GetContext ( ) const
inlinenodiscard

Get/Set the EGLContext.

Definition at line 36 of file vtkEGLRenderWindowInternals.h.

◆ SetContext()

void vtkEGLRenderWindowInternals::SetContext ( EGLContext context)
inline

Get/Set the EGLContext.

Definition at line 37 of file vtkEGLRenderWindowInternals.h.

◆ GetWindow()

EGLNativeWindowType vtkEGLRenderWindowInternals::GetWindow ( ) const
inlinenodiscard

Get/Set the EGLWindow.

Definition at line 44 of file vtkEGLRenderWindowInternals.h.

◆ SetWindow()

void vtkEGLRenderWindowInternals::SetWindow ( EGLNativeWindowType window)
inline

Get/Set the EGLWindow.

Definition at line 45 of file vtkEGLRenderWindowInternals.h.

◆ SwapBuffer()

void vtkEGLRenderWindowInternals::SwapBuffer ( )

Ensure to call the SwapBuffers() on the correct display and surface.

◆ GetNumberOfDevices()

int vtkEGLRenderWindowInternals::GetNumberOfDevices ( )
nodiscard

Get the number of devices (graphic cards) from the system.

◆ SetDeviceAsDisplay()

bool vtkEGLRenderWindowInternals::SetDeviceAsDisplay ( int deviceIndex)
nodiscard

Set the wanted device for display if the device is available.

Return true if it found a valid device, false otherwiise.

◆ DestroyWindow()

void vtkEGLRenderWindowInternals::DestroyWindow ( )

Release EGL window.

◆ ConfigureWindow()

void vtkEGLRenderWindowInternals::ConfigureWindow ( int width,
int height )

Configure the current EGLWindow with the requested size.

Ensure to create the window if its not already the case.

◆ SetDeviceIndex()

void vtkEGLRenderWindowInternals::SetDeviceIndex ( int deviceIndex)
inline

Setter used to store the device expected by the user.

Definition at line 78 of file vtkEGLRenderWindowInternals.h.

◆ SetUseOnscreenRendering()

void vtkEGLRenderWindowInternals::SetUseOnscreenRendering ( bool useOnscreenRendering)

Setter to handle onscreen rendering.

See upper class for more information espcially regarding limitations regarding platforms.

◆ GetSizeFromSurface()

void vtkEGLRenderWindowInternals::GetSizeFromSurface ( int * size)

Get the current size of the EGLSurface.

◆ ReleaseCurrent()

void vtkEGLRenderWindowInternals::ReleaseCurrent ( )

Release the EGL state.

◆ MakeCurrent()

bool vtkEGLRenderWindowInternals::MakeCurrent ( )

Try to attach the EGL rendering context to the EGL surface.

Return false if it fails.


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