VTK  9.0.20200709
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkEGLRenderWindow Class Reference

OpenGL rendering window. More...

#include <vtkEGLRenderWindow.h>

Inheritance diagram for vtkEGLRenderWindow:
[legend]
Collaboration diagram for vtkEGLRenderWindow:
[legend]

Public Types

typedef vtkOpenGLRenderWindow Superclass
 
- Public Types inherited from vtkOpenGLRenderWindow
enum  FrameBlitModes { BlitToHardware, BlitToCurrent, NoBlit }
 Define how the resulting image should be blitted when at the end of the Frame() call if SwapBuffers is true. More...
 
typedef vtkRenderWindow Superclass
 
- Public Types inherited from vtkRenderWindow
typedef vtkWindow Superclass
 
- Public Types inherited from vtkWindow
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkEGLRenderWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Frame (void) override
 End the rendering process and display the image. More...
 
void SetShowWindow (bool) override
 
virtual void WindowInitialize (void)
 Initialize the window for rendering. More...
 
void Initialize (void) override
 Initialize the rendering window. More...
 
void Finalize (void) override
 "Deinitialize" the rendering window. More...
 
void SetFullScreen (vtkTypeBool) override
 Change the window to fill the entire screen. More...
 
void WindowRemap (void) override
 Resize the window. More...
 
virtual void PrefFullScreen (void)
 Set the preferred window size to full screen. More...
 
void SetSize (int width, int height) override
 Set the size (width and height) of the rendering window in screen coordinates (in pixels). More...
 
void SetSize (int a[2]) override
 
void SetStereoCapableWindow (vtkTypeBool capable) override
 Prescribe that the window be created in a stereo-capable mode. More...
 
void MakeCurrent () override
 Make this window the current OpenGL context. More...
 
bool IsCurrent () override
 Tells if this window is the current OpenGL context for the calling thread. More...
 
vtkTypeBool IsDirect () override
 Is this render window using hardware acceleration? 0-false, 1-true. More...
 
int * GetScreenSize () override
 Get the current size of the screen in pixels. More...
 
int * GetPosition () override
 Get the position (x and y) of the rendering window in screen coordinates (in pixels). More...
 
void SetDisplayId (void *) override
 Dummy stubs for vtkWindow API. More...
 
void SetWindowId (void *window) override
 
void SetNextWindowId (void *) override
 
void SetParentId (void *) override
 
void * GetGenericDisplayId () override
 
void * GetGenericWindowId () override
 
void * GetGenericParentId () override
 
void * GetGenericContext () override
 
void * GetGenericDrawable () override
 
void SetWindowInfo (const char *) override
 
void SetNextWindowInfo (const char *) override
 
void SetParentInfo (const char *) override
 
void SetWindowName (const char *) override
 
void SetPosition (int x, int y) override
 Set the position (x and y) of the rendering window in screen coordinates (in pixels). More...
 
void SetPosition (int a[2]) override
 
void HideCursor () override
 Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead. More...
 
void ShowCursor () override
 
void Render () override
 This computes the size of the render window before calling the supper classes render. More...
 
vtkTypeBool GetEventPending () override
 Check to see if a mouse button has been pressed. More...
 
vtkTypeBool GetOwnWindow ()
 
void GetEGLSurfaceSize (int *width, int *height)
 Returns the width and height of the allocated EGL surface. More...
 
int GetNumberOfDevices () override
 Returns the number of devices (graphics cards) on a system. More...
 
bool IsPointSpriteBugPresent () override
 Returns true if driver has an EGL/OpenGL bug that makes vtkChartsCoreCxx-TestChartDoubleColors and other tests to fail because point sprites don't work correctly (gl_PointCoord is undefined) unless glEnable(GL_POINT_SPRITE) More...
 
- Public Member Functions inherited from vtkOpenGLRenderWindow
vtkOpenGLRenderWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Start (void) override
 Begin the rendering process. More...
 
void Frame () override
 A termination method performed at the end of the rendering process to do things like swapping buffers (if necessary) or similar actions. More...
 
const char * GetRenderingBackend () override
 What rendering backend has the user requested. More...
 
unsigned char * GetPixelData (int x, int y, int x2, int y2, int front, int right) override
 Set/Get the pixel data of an image, transmitted as RGBRGB... More...
 
int GetPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right) override
 
int SetPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int right) override
 Set/Get the pixel data of an image, transmitted as RGBRGBRGB. More...
 
int SetPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int right) override
 
float * GetRGBAPixelData (int x, int y, int x2, int y2, int front, int right=0) override
 Set/Get the pixel data of an image, transmitted as RGBARGBA... More...
 
int GetRGBAPixelData (int x, int y, int x2, int y2, int front, vtkFloatArray *data, int right=0) override
 
int SetRGBAPixelData (int x, int y, int x2, int y2, float *data, int front, int blend=0, int right=0) override
 
int SetRGBAPixelData (int x, int y, int x2, int y2, vtkFloatArray *data, int front, int blend=0, int right=0) override
 
void ReleaseRGBAPixelData (float *data) override
 
unsigned char * GetRGBACharPixelData (int x, int y, int x2, int y2, int front, int right=0) override
 
int GetRGBACharPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right=0) override
 
int SetRGBACharPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int blend=0, int right=0) override
 
int SetRGBACharPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int blend=0, int right=0) override
 
float * GetZbufferData (int x1, int y1, int x2, int y2) override
 Set/Get the zbuffer data from an image. More...
 
int GetZbufferData (int x1, int y1, int x2, int y2, float *z) override
 
int GetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *buffer) override
 
int SetZbufferData (int x1, int y1, int x2, int y2, float *buffer) override
 
int SetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *buffer) override
 
void ActivateTexture (vtkTextureObject *)
 Activate a texture unit for this texture. More...
 
void DeactivateTexture (vtkTextureObject *)
 Deactivate a previously activated texture. More...
 
int GetTextureUnitForTexture (vtkTextureObject *)
 Get the texture unit for a given texture object. More...
 
int GetDepthBufferSize () override
 Get the size of the depth buffer. More...
 
bool GetUsingSRGBColorSpace ()
 Is this window/fo in sRGB colorspace. More...
 
int GetColorBufferSizes (int *rgba) override
 Get the size of the color buffer. More...
 
int GetColorBufferInternalFormat (int attachmentPoint)
 Get the internal format of current attached texture or render buffer. More...
 
virtual void OpenGLInit ()
 Initialize OpenGL for this window. More...
 
virtual void OpenGLInitState ()
 
virtual void OpenGLInitContext ()
 
void GetOpenGLVersion (int &major, int &minor)
 Get the major and minor version numbers of the OpenGL context we are using ala 3.2, 3.3, 4.0, etc... More...
 
unsigned int GetBackLeftBuffer ()
 
unsigned int GetBackRightBuffer ()
 
unsigned int GetFrontLeftBuffer ()
 
unsigned int GetFrontRightBuffer ()
 
unsigned int GetBackBuffer ()
 
unsigned int GetFrontBuffer ()
 
virtual vtkMTimeType GetContextCreationTime ()
 Get the time when the OpenGL context was created. More...
 
vtkOpenGLShaderCacheGetShaderCache ()
 Returns an Shader Cache object. More...
 
vtkOpenGLVertexBufferObjectCacheGetVBOCache ()
 Returns the VBO Cache. More...
 
virtual vtkOpenGLFramebufferObjectGetRenderFramebuffer ()
 Returns the render framebuffer object. More...
 
vtkOpenGLFramebufferObjectGetOffScreenFramebuffer ()
 
vtkTextureUnitManagerGetTextureUnitManager ()
 Returns its texture unit manager object. More...
 
void WaitForCompletion () override
 Block the thread until the actual rendering is finished(). More...
 
virtual void DrawPixels (int x1, int y1, int x2, int y2, int numComponents, int dataType, void *data)
 Replacement for the old glDrawPixels function. More...
 
virtual void DrawPixels (int dstXmin, int dstYmin, int dstXmax, int dstYmax, int srcXmin, int srcYmin, int srcXmax, int srcYmax, int srcWidth, int srcHeight, int numComponents, int dataType, void *data)
 Replacement for the old glDrawPixels function, but it allows for scaling the data and using only part of the texture. More...
 
virtual void DrawPixels (int srcWidth, int srcHeight, int numComponents, int dataType, void *data)
 Replacement for the old glDrawPixels function. More...
 
virtual float GetMaximumHardwareLineWidth ()
 Return the largest line width supported by the hardware. More...
 
int GetDefaultTextureInternalFormat (int vtktype, int numComponents, bool needInteger, bool needFloat, bool needSRGB)
 Get a mapping of vtk data types to native texture formats for this window we put this on the RenderWindow so that every texture does not have to build these structures themselves. More...
 
std::string GetOpenGLSupportMessage ()
 Return a message profiding additional details about the results of calling SupportsOpenGL() This can be used to retrieve more specifics about what failed. More...
 
int SupportsOpenGL () override
 Does this render window support OpenGL? 0-false, 1-true. More...
 
const char * ReportCapabilities () override
 Get report of capabilities for the render window. More...
 
void RegisterGraphicsResources (vtkGenericOpenGLResourceFreeCallback *cb)
 
void UnregisterGraphicsResources (vtkGenericOpenGLResourceFreeCallback *cb)
 
virtual void PushContext ()
 Ability to push and pop this window's context as the current context. More...
 
virtual void PopContext ()
 
bool InitializeFromCurrentContext () override
 Initialize the render window from the information associated with the currently activated OpenGL context. More...
 
virtual bool SetSwapControl (int)
 Set the number of vertical syncs required between frames. More...
 
virtual vtkOpenGLStateGetState ()
 
vtkOpenGLBufferObjectGetTQuad2DVBO ()
 
int GetNoiseTextureUnit ()
 
void End () override
 Update the system, if needed, at end of render process. More...
 
void Render () override
 Handle opengl specific code and calls superclass. More...
 
void StereoMidpoint () override
 Intermediate method performs operations required between the rendering of the left and right eye. More...
 
bool GetBufferNeedsResolving ()
 
void ReleaseGraphicsResources (vtkWindow *) override
 Free up any graphics resources associated with this window a value of NULL means the context may already be destroyed. More...
 
void BlitDisplayFramebuffer ()
 Blit a display framebuffer into a currently bound draw destination. More...
 
void BlitDisplayFramebuffer (int right, int srcX, int srcY, int srcWidth, int srcHeight, int destX, int destY, int destWidth, int destHeight, int bufferMode, int interpolation)
 Blit a display buffer into a currently bound draw destination. More...
 
void BlitToRenderFramebuffer (bool includeDepth)
 Blit the currently bound read buffer to the renderbuffer. More...
 
void BlitToRenderFramebuffer (int srcX, int srcY, int srcWidth, int srcHeight, int destX, int destY, int destWidth, int destHeight, int bufferMode, int interpolation)
 
virtual void SetFrameBlitMode (FrameBlitModes)
 SetGet how to handle blits at the end of a Frame() call. More...
 
virtual FrameBlitModes GetFrameBlitMode ()
 
void SetFrameBlitModeToBlitToHardware ()
 
void SetFrameBlitModeToBlitToCurrent ()
 
void SetFrameBlitModeToNoBlit ()
 
- Public Member Functions inherited from vtkRenderWindow
vtkRenderWindowNewInstance () const
 
virtual void AddRenderer (vtkRenderer *)
 Add a renderer to the list of renderers. More...
 
void RemoveRenderer (vtkRenderer *)
 Remove a renderer from the list of renderers. More...
 
int HasRenderer (vtkRenderer *)
 Query if a renderer is in the list of renderers. More...
 
 vtkGetNewMacro (RenderTimer, vtkRenderTimerLog)
 Get the render timer log for this window. More...
 
vtkRendererCollectionGetRenderers ()
 Return the collection of renderers in the render window. More...
 
void CaptureGL2PSSpecialProps (vtkCollection *specialProps)
 The GL2PS exporter must handle certain props in a special way (e.g. More...
 
virtual int GetCapturingGL2PSSpecialProps ()
 Returns true if the render process is capturing text actors. More...
 
virtual void CopyResultFrame ()
 Performed at the end of the rendering process to generate image. More...
 
virtual vtkRenderWindowInteractorMakeRenderWindowInteractor ()
 Create an interactor to control renderers in this window. More...
 
virtual void SetCursorPosition (int, int)
 
virtual void SetCurrentCursor (int)
 Change the shape of the cursor. More...
 
virtual int GetCurrentCursor ()
 
virtual vtkTypeBool GetFullScreen ()
 
virtual void FullScreenOn ()
 
virtual void FullScreenOff ()
 
virtual void SetBorders (vtkTypeBool)
 Turn on/off window manager borders. More...
 
virtual vtkTypeBool GetBorders ()
 
virtual void BordersOn ()
 
virtual void BordersOff ()
 
virtual vtkTypeBool GetStereoCapableWindow ()
 Prescribe that the window be created in a stereo-capable mode. More...
 
virtual void StereoCapableWindowOn ()
 
virtual void StereoCapableWindowOff ()
 
virtual vtkTypeBool GetStereoRender ()
 Turn on/off stereo rendering. More...
 
void SetStereoRender (vtkTypeBool stereo)
 
virtual void StereoRenderOn ()
 
virtual void StereoRenderOff ()
 
virtual void SetAlphaBitPlanes (vtkTypeBool)
 Turn on/off the use of alpha bitplanes. More...
 
virtual vtkTypeBool GetAlphaBitPlanes ()
 
virtual void AlphaBitPlanesOn ()
 
virtual void AlphaBitPlanesOff ()
 
virtual void SetPointSmoothing (vtkTypeBool)
 Turn on/off point smoothing. More...
 
virtual vtkTypeBool GetPointSmoothing ()
 
virtual void PointSmoothingOn ()
 
virtual void PointSmoothingOff ()
 
virtual void SetLineSmoothing (vtkTypeBool)
 Turn on/off line smoothing. More...
 
virtual vtkTypeBool GetLineSmoothing ()
 
virtual void LineSmoothingOn ()
 
virtual void LineSmoothingOff ()
 
virtual void SetPolygonSmoothing (vtkTypeBool)
 Turn on/off polygon smoothing. More...
 
virtual vtkTypeBool GetPolygonSmoothing ()
 
virtual void PolygonSmoothingOn ()
 
virtual void PolygonSmoothingOff ()
 
virtual int GetStereoType ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoType (int)
 
void SetStereoTypeToCrystalEyes ()
 
void SetStereoTypeToRedBlue ()
 
void SetStereoTypeToInterlaced ()
 
void SetStereoTypeToLeft ()
 
void SetStereoTypeToRight ()
 
void SetStereoTypeToDresden ()
 
void SetStereoTypeToAnaglyph ()
 
void SetStereoTypeToCheckerboard ()
 
void SetStereoTypeToSplitViewportHorizontal ()
 
void SetStereoTypeToFake ()
 
void SetStereoTypeToEmulate ()
 
const char * GetStereoTypeAsString ()
 Returns the stereo type as a string. More...
 
virtual void StereoUpdate ()
 Update the system, if needed, due to stereo rendering. More...
 
virtual void StereoRenderComplete ()
 Handles work required once both views have been rendered when using stereo rendering. More...
 
virtual void SetAnaglyphColorSaturation (float)
 Set/get the anaglyph color saturation factor. More...
 
virtual float GetAnaglyphColorSaturation ()
 
virtual void SetAnaglyphColorMask (int, int)
 Set/get the anaglyph color mask values. More...
 
void SetAnaglyphColorMask (int[2])
 
virtual int * GetAnaglyphColorMask ()
 
virtual void GetAnaglyphColorMask (int data[2])
 
virtual void SetSwapBuffers (vtkTypeBool)
 Turn on/off buffer swapping between images. More...
 
virtual vtkTypeBool GetSwapBuffers ()
 
virtual void SwapBuffersOn ()
 
virtual void SwapBuffersOff ()
 
float GetZbufferDataAtPoint (int x, int y)
 
virtual int GetNeverRendered ()
 This flag is set if the window hasn't rendered since it was created. More...
 
virtual int GetAbortRender ()
 This is a flag that can be set to interrupt a rendering that is in progress. More...
 
virtual void SetAbortRender (int)
 
virtual int GetInAbortCheck ()
 
virtual void SetInAbortCheck (int)
 
virtual int CheckAbortStatus ()
 
vtkTypeBool GetIsPicking ()
 
void SetIsPicking (vtkTypeBool)
 
void IsPickingOn ()
 
void IsPickingOff ()
 
virtual int CheckInRenderStatus ()
 Are we rendering at the moment. More...
 
virtual void ClearInRenderStatus ()
 Clear status (after an exception was thrown for example) More...
 
virtual void SetDesiredUpdateRate (double)
 Set/Get the desired update rate. More...
 
virtual double GetDesiredUpdateRate ()
 
virtual int GetNumberOfLayers ()
 Get the number of layers for renderers. More...
 
virtual void SetNumberOfLayers (int)
 
virtual vtkRenderWindowInteractorGetInteractor ()
 Get the interactor associated with this render window. More...
 
virtual void SetInteractor (vtkRenderWindowInteractor *)
 Set the interactor to the render window. More...
 
void UnRegister (vtkObjectBase *o) override
 This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. More...
 
virtual void SetSharedRenderWindow (vtkRenderWindow *)
 Set/Get an already existing window that this window should share data with if possible. More...
 
virtual vtkRenderWindowGetSharedRenderWindow ()
 
virtual bool GetPlatformSupportsRenderWindowSharing ()
 
 VTK_DEPRECATED_IN_9_1_0 ("Deprecated in 9.1 because no one knows what it's for and nothing uses it") virtual bool IsDrawable()
 Test if the window has a valid drawable. More...
 
virtual void SetForceMakeCurrent ()
 If called, allow MakeCurrent() to skip cache-check when called. More...
 
virtual void SetMultiSamples (int)
 Set / Get the number of multisamples to use for hardware antialiasing. More...
 
virtual int GetMultiSamples ()
 
virtual void SetStencilCapable (vtkTypeBool)
 Set / Get the availability of the stencil buffer. More...
 
virtual vtkTypeBool GetStencilCapable ()
 
virtual void StencilCapableOn ()
 
virtual void StencilCapableOff ()
 
virtual void SetDeviceIndex (int)
 If there are several graphics card installed on a system, this index can be used to specify which card you want to render to. More...
 
virtual int GetDeviceIndex ()
 
virtual bool GetUseSRGBColorSpace ()
 Set/Get if we want this window to use the sRGB color space. More...
 
virtual void SetUseSRGBColorSpace (bool)
 
virtual void UseSRGBColorSpaceOn ()
 
virtual void UseSRGBColorSpaceOff ()
 
- Public Member Functions inherited from vtkWindow
vtkWindowNewInstance () const
 
virtual int * GetSize ()
 Get the size (width and height) of the rendering window in screen coordinates (in pixels). More...
 
int * GetActualSize ()
 GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale. More...
 
virtual vtkTypeBool GetMapped ()
 Keep track of whether the rendering window has been mapped to screen. More...
 
virtual bool GetShowWindow ()
 Show or not Show the window. More...
 
virtual void ShowWindowOn ()
 
virtual void ShowWindowOff ()
 
virtual void SetUseOffScreenBuffers (bool)
 Render to an offscreen destination such as a framebuffer. More...
 
virtual bool GetUseOffScreenBuffers ()
 
virtual void UseOffScreenBuffersOn ()
 
virtual void UseOffScreenBuffersOff ()
 
virtual void SetErase (vtkTypeBool)
 Turn on/off erasing the screen between images. More...
 
virtual vtkTypeBool GetErase ()
 
virtual void EraseOn ()
 
virtual void EraseOff ()
 
virtual void SetDoubleBuffer (vtkTypeBool)
 Keep track of whether double buffering is on or off. More...
 
virtual vtkTypeBool GetDoubleBuffer ()
 
virtual void DoubleBufferOn ()
 
virtual void DoubleBufferOff ()
 
virtual char * GetWindowName ()
 Get name of rendering window. More...
 
virtual void SetIcon (vtkImageData *)
 Set the icon used in title bar and task bar. More...
 
virtual int GetDPI ()
 Return a best estimate to the dots per inch of the display device being rendered (or printed). More...
 
virtual void SetDPI (int)
 
virtual bool DetectDPI ()
 Attempt to detect and set the DPI of the display device by querying the system. More...
 
void SetOffScreenRendering (vtkTypeBool val)
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOn ()
 
virtual void OffScreenRenderingOff ()
 
vtkTypeBool GetOffScreenRendering ()
 Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead. More...
 
virtual void SetTileScale (int, int)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
void SetTileScale (int[2])
 
virtual int * GetTileScale ()
 
virtual void GetTileScale (int &, int &)
 
virtual void GetTileScale (int[2])
 
void SetTileScale (int s)
 
virtual void SetTileViewport (double, double, double, double)
 
virtual void SetTileViewport (double[4])
 
virtual double * GetTileViewport ()
 
virtual void GetTileViewport (double &, double &, double &, double &)
 
virtual void GetTileViewport (double[4])
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkEGLRenderWindowNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkEGLRenderWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkOpenGLRenderWindow
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLRenderWindowSafeDownCast (vtkObjectBase *o)
 
static void SetGlobalMaximumNumberOfMultiSamples (int val)
 Set/Get the maximum number of multisamples. More...
 
static int GetGlobalMaximumNumberOfMultiSamples ()
 
- Static Public Member Functions inherited from vtkRenderWindow
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderWindowSafeDownCast (vtkObjectBase *o)
 
static vtkRenderWindowNew ()
 Construct an instance of vtkRenderWindow with its screen size set to 300x300, borders turned on, positioned at (0,0), double buffering turned on. More...
 
static const char * GetRenderLibrary ()
 What rendering library has the user requested. More...
 
static const char * GetStereoTypeAsString (int type)
 
- Static Public Member Functions inherited from vtkWindow
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkEGLRenderWindow ()
 
 ~vtkEGLRenderWindow () override
 
void CreateAWindow () override
 Create a not-off-screen window. More...
 
void DestroyWindow () override
 Destroy a not-off-screen window. More...
 
void ResizeWindow (int width, int height)
 
void SetDeviceAsDisplay (int deviceIndex)
 Use EGL_EXT_device_base, EGL_EXT_platform_device and EGL_EXT_platform_base extensions to set the display (output graphics card) to something different than EGL_DEFAULT_DISPLAY. More...
 
- Protected Member Functions inherited from vtkOpenGLRenderWindow
 vtkOpenGLRenderWindow ()
 
 ~vtkOpenGLRenderWindow () override
 
virtual void BlitDisplayFramebuffersToHardware ()
 
virtual int ReadPixels (const vtkRecti &rect, int front, int glFormat, int glType, void *data, int right=0)
 
int CreateFramebuffers (int width, int height)
 Create the offScreen framebuffer Return if the creation was successful or not. More...
 
void SaveGLState ()
 Query and save OpenGL state. More...
 
void RestoreGLState ()
 Restore OpenGL state at end of the rendering. More...
 
- Protected Member Functions inherited from vtkRenderWindow
 vtkRenderWindow ()
 
 ~vtkRenderWindow () override
 
virtual void DoStereoRender ()
 
- Protected Member Functions inherited from vtkWindow
 vtkWindow ()
 
 ~vtkWindow () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTypeBool OwnWindow
 
bool IsPointSpriteBugTested
 
bool IsPointSpriteBugPresent_
 
vtkInternals * Internals
 
- Protected Attributes inherited from vtkOpenGLRenderWindow
FrameBlitModes FrameBlitMode
 
vtkOpenGLQuadHelperResolveQuad
 
bool OpenGLSupportTested
 
int OpenGLSupportResult
 
std::string OpenGLSupportMessage
 
vtkOpenGLFramebufferObjectRenderFramebuffer
 
vtkOpenGLFramebufferObjectDisplayFramebuffer
 
vtkOpenGLFramebufferObjectResolveFramebuffer
 
std::map< std::string, int > GLStateIntegers
 
vtkTypeBool OwnContext
 Flag telling if the context has been created here or was inherited. More...
 
vtkTimeStamp ContextCreationTime
 
vtkTextureObjectDrawPixelsTextureObject
 
bool Initialized
 
bool GlewInitValid
 
float MaximumHardwareLineWidth
 
char * Capabilities
 
vtkOpenGLBufferObjectTQuad2DVBO
 
vtkTextureObjectNoiseTextureObject
 
double FirstRenderTime
 
int LastMultiSamples
 
int ScreenSize [2]
 
- Protected Attributes inherited from vtkRenderWindow
vtkRendererCollectionRenderers
 
vtkNew< vtkRenderTimerLogRenderTimer
 
vtkTypeBool Borders
 
vtkTypeBool FullScreen
 
int OldScreen [5]
 
vtkTypeBool PointSmoothing
 
vtkTypeBool LineSmoothing
 
vtkTypeBool PolygonSmoothing
 
vtkTypeBool StereoRender
 
int StereoType
 
vtkTypeBool StereoCapableWindow
 
vtkTypeBool AlphaBitPlanes
 
vtkRenderWindowInteractorInteractor
 
vtkSmartPointer< vtkUnsignedCharArrayStereoBuffer
 
vtkSmartPointer< vtkUnsignedCharArrayResultFrame
 
vtkTypeBool SwapBuffers
 
double DesiredUpdateRate
 
int AbortRender
 
int InAbortCheck
 
int InRender
 
int NeverRendered
 
int NumberOfLayers
 
int CurrentCursor
 
float AnaglyphColorSaturation
 
int AnaglyphColorMask [2]
 
int MultiSamples
 
vtkTypeBool StencilCapable
 
int CapturingGL2PSSpecialProps
 
int DeviceIndex
 
bool UseSRGBColorSpace
 
double AbortCheckTime
 The universal time since the last abort check occurred. More...
 
vtkRenderWindowSharedRenderWindow
 
- Protected Attributes inherited from vtkWindow
char * WindowName
 
int Size [2]
 
int Position [2]
 
vtkTypeBool Mapped
 
bool ShowWindow
 
bool UseOffScreenBuffers
 
vtkTypeBool Erase
 
vtkTypeBool DoubleBuffer
 
int DPI
 
double TileViewport [4]
 
int TileSize [2]
 
int TileScale [2]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkOpenGLRenderWindow
std::set< vtkGenericOpenGLResourceFreeCallback * > Resources
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

OpenGL rendering window.

vtkEGLRenderWindow is a concrete implementation of the abstract class vtkRenderWindow. This class creates a window on Android platform and for client API OpenGL ES and an offscreen pbuffer for OpenGL. vtkOpenGLRenderer interfaces to the OpenGL graphics library. Application programmers should normally use vtkRenderWindow instead of the OpenGL specific version.

If the VTK_DEFAULT_EGL_DEVICE_INDEX environment variable is present at the time of construction, it's value will be used to initialize the DeviceIndex, falling back to the VTK_DEFAULT_EGL_DEVICE_INDEX preprocessor definition otherwise.

Definition at line 40 of file vtkEGLRenderWindow.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkEGLRenderWindow.h.

Constructor & Destructor Documentation

◆ vtkEGLRenderWindow()

vtkEGLRenderWindow::vtkEGLRenderWindow ( )
protected

◆ ~vtkEGLRenderWindow()

vtkEGLRenderWindow::~vtkEGLRenderWindow ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkEGLRenderWindow* vtkEGLRenderWindow::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkEGLRenderWindow::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkEGLRenderWindow::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkOpenGLRenderWindow.

◆ SafeDownCast()

static vtkEGLRenderWindow* vtkEGLRenderWindow::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkEGLRenderWindow::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkOpenGLRenderWindow.

◆ NewInstance()

vtkEGLRenderWindow* vtkEGLRenderWindow::NewInstance ( ) const

◆ PrintSelf()

void vtkEGLRenderWindow::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkRenderWindow.

◆ Frame()

void vtkEGLRenderWindow::Frame ( void  )
overridevirtual

End the rendering process and display the image.

Reimplemented from vtkRenderWindow.

◆ SetShowWindow()

void vtkEGLRenderWindow::SetShowWindow ( bool  )
overridevirtual

Reimplemented from vtkWindow.

◆ WindowInitialize()

virtual void vtkEGLRenderWindow::WindowInitialize ( void  )
virtual

Initialize the window for rendering.

◆ Initialize()

void vtkEGLRenderWindow::Initialize ( void  )
overridevirtual

Initialize the rendering window.

This will setup all system-specific resources. This method and Finalize() must be symmetric and it should be possible to call them multiple times, even changing WindowId in-between. This is what WindowRemap does.

Reimplemented from vtkOpenGLRenderWindow.

◆ Finalize()

void vtkEGLRenderWindow::Finalize ( void  )
overridevirtual

"Deinitialize" the rendering window.

This will shutdown all system-specific resources. After having called this, it should be possible to destroy a window that was used for a SetWindowId() call without any ill effects.

Reimplemented from vtkRenderWindow.

◆ SetFullScreen()

void vtkEGLRenderWindow::SetFullScreen ( vtkTypeBool  )
overridevirtual

Change the window to fill the entire screen.

Reimplemented from vtkRenderWindow.

◆ WindowRemap()

void vtkEGLRenderWindow::WindowRemap ( void  )
overridevirtual

Resize the window.

Reimplemented from vtkRenderWindow.

◆ PrefFullScreen()

virtual void vtkEGLRenderWindow::PrefFullScreen ( void  )
virtual

Set the preferred window size to full screen.

◆ SetSize() [1/2]

void vtkEGLRenderWindow::SetSize ( int  width,
int  height 
)
overridevirtual

Set the size (width and height) of the rendering window in screen coordinates (in pixels).

This resizes the operating system's view/window and redraws it.

If the size has changed, this method will fire vtkCommand::WindowResizeEvent.

Reimplemented from vtkWindow.

◆ SetSize() [2/2]

void vtkEGLRenderWindow::SetSize ( int  a[2])
inlineoverridevirtual

Reimplemented from vtkWindow.

Definition at line 99 of file vtkEGLRenderWindow.h.

◆ SetStereoCapableWindow()

void vtkEGLRenderWindow::SetStereoCapableWindow ( vtkTypeBool  capable)
overridevirtual

Prescribe that the window be created in a stereo-capable mode.

This method must be called before the window is realized. This method overrides the superclass method since this class can actually check whether the window has been realized yet.

Reimplemented from vtkRenderWindow.

◆ MakeCurrent()

void vtkEGLRenderWindow::MakeCurrent ( )
overridevirtual

Make this window the current OpenGL context.

Reimplemented from vtkRenderWindow.

◆ IsCurrent()

bool vtkEGLRenderWindow::IsCurrent ( )
overridevirtual

Tells if this window is the current OpenGL context for the calling thread.

Reimplemented from vtkRenderWindow.

◆ IsDirect()

vtkTypeBool vtkEGLRenderWindow::IsDirect ( )
inlineoverridevirtual

Is this render window using hardware acceleration? 0-false, 1-true.

Reimplemented from vtkRenderWindow.

Definition at line 122 of file vtkEGLRenderWindow.h.

◆ GetScreenSize()

int* vtkEGLRenderWindow::GetScreenSize ( )
overridevirtual

Get the current size of the screen in pixels.

An HDTV for example would be 1920 x 1080 pixels.

Reimplemented from vtkWindow.

◆ GetPosition()

int* vtkEGLRenderWindow::GetPosition ( )
overridevirtual

Get the position (x and y) of the rendering window in screen coordinates (in pixels).

Reimplemented from vtkWindow.

◆ SetDisplayId()

void vtkEGLRenderWindow::SetDisplayId ( void *  )
inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkRenderWindow.

Definition at line 140 of file vtkEGLRenderWindow.h.

◆ SetWindowId()

void vtkEGLRenderWindow::SetWindowId ( void *  window)
overridevirtual

Reimplemented from vtkRenderWindow.

◆ SetNextWindowId()

void vtkEGLRenderWindow::SetNextWindowId ( void *  )
inlineoverridevirtual

Reimplemented from vtkRenderWindow.

Definition at line 142 of file vtkEGLRenderWindow.h.

◆ SetParentId()

void vtkEGLRenderWindow::SetParentId ( void *  )
inlineoverridevirtual

Reimplemented from vtkRenderWindow.

Definition at line 143 of file vtkEGLRenderWindow.h.

◆ GetGenericDisplayId()

void* vtkEGLRenderWindow::GetGenericDisplayId ( )
overridevirtual

Reimplemented from vtkRenderWindow.

◆ GetGenericWindowId()

void* vtkEGLRenderWindow::GetGenericWindowId ( )
inlineoverridevirtual

Reimplemented from vtkRenderWindow.

Definition at line 145 of file vtkEGLRenderWindow.h.

◆ GetGenericParentId()

void* vtkEGLRenderWindow::GetGenericParentId ( )
inlineoverridevirtual

Reimplemented from vtkRenderWindow.

Definition at line 146 of file vtkEGLRenderWindow.h.

◆ GetGenericContext()

void* vtkEGLRenderWindow::GetGenericContext ( )
overridevirtual

Reimplemented from vtkRenderWindow.

◆ GetGenericDrawable()

void* vtkEGLRenderWindow::GetGenericDrawable ( )
inlineoverridevirtual

Reimplemented from vtkRenderWindow.

Definition at line 148 of file vtkEGLRenderWindow.h.

◆ SetWindowInfo()

void vtkEGLRenderWindow::SetWindowInfo ( const char *  )
overridevirtual

Reimplemented from vtkRenderWindow.

◆ SetNextWindowInfo()

void vtkEGLRenderWindow::SetNextWindowInfo ( const char *  )
inlineoverridevirtual

Reimplemented from vtkRenderWindow.

Definition at line 150 of file vtkEGLRenderWindow.h.

◆ SetParentInfo()

void vtkEGLRenderWindow::SetParentInfo ( const char *  )
inlineoverridevirtual

Reimplemented from vtkRenderWindow.

Definition at line 151 of file vtkEGLRenderWindow.h.

◆ SetWindowName()

void vtkEGLRenderWindow::SetWindowName ( const char *  )
overridevirtual

Reimplemented from vtkWindow.

◆ SetPosition() [1/2]

void vtkEGLRenderWindow::SetPosition ( int  x,
int  y 
)
overridevirtual

Set the position (x and y) of the rendering window in screen coordinates (in pixels).

This resizes the operating system's view/window and redraws it.

Reimplemented from vtkWindow.

◆ SetPosition() [2/2]

void vtkEGLRenderWindow::SetPosition ( int  a[2])
inlineoverridevirtual

Reimplemented from vtkWindow.

Definition at line 163 of file vtkEGLRenderWindow.h.

◆ HideCursor()

void vtkEGLRenderWindow::HideCursor ( )
overridevirtual

Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead.

Reimplemented from vtkRenderWindow.

◆ ShowCursor()

void vtkEGLRenderWindow::ShowCursor ( )
overridevirtual

Reimplemented from vtkRenderWindow.

◆ Render()

void vtkEGLRenderWindow::Render ( )
overridevirtual

This computes the size of the render window before calling the supper classes render.

Reimplemented from vtkRenderWindow.

◆ GetEventPending()

vtkTypeBool vtkEGLRenderWindow::GetEventPending ( )
inlineoverridevirtual

Check to see if a mouse button has been pressed.

All other events are ignored by this method. Ideally, you want to abort the render on any event which causes the DesiredUpdateRate to switch from a high-quality rate to a more interactive rate.

Reimplemented from vtkRenderWindow.

Definition at line 187 of file vtkEGLRenderWindow.h.

◆ GetOwnWindow()

vtkTypeBool vtkEGLRenderWindow::GetOwnWindow ( )
inline

Definition at line 189 of file vtkEGLRenderWindow.h.

◆ GetEGLSurfaceSize()

void vtkEGLRenderWindow::GetEGLSurfaceSize ( int *  width,
int *  height 
)

Returns the width and height of the allocated EGL surface.

If no surface is allocated width and height are set to 0.

◆ GetNumberOfDevices()

int vtkEGLRenderWindow::GetNumberOfDevices ( )
overridevirtual

Returns the number of devices (graphics cards) on a system.

Reimplemented from vtkRenderWindow.

◆ IsPointSpriteBugPresent()

bool vtkEGLRenderWindow::IsPointSpriteBugPresent ( )
overridevirtual

Returns true if driver has an EGL/OpenGL bug that makes vtkChartsCoreCxx-TestChartDoubleColors and other tests to fail because point sprites don't work correctly (gl_PointCoord is undefined) unless glEnable(GL_POINT_SPRITE)

Reimplemented from vtkOpenGLRenderWindow.

◆ CreateAWindow()

void vtkEGLRenderWindow::CreateAWindow ( )
overrideprotectedvirtual

Create a not-off-screen window.

Implements vtkOpenGLRenderWindow.

◆ DestroyWindow()

void vtkEGLRenderWindow::DestroyWindow ( )
overrideprotectedvirtual

Destroy a not-off-screen window.

Implements vtkOpenGLRenderWindow.

◆ ResizeWindow()

void vtkEGLRenderWindow::ResizeWindow ( int  width,
int  height 
)
protected

◆ SetDeviceAsDisplay()

void vtkEGLRenderWindow::SetDeviceAsDisplay ( int  deviceIndex)
protected

Use EGL_EXT_device_base, EGL_EXT_platform_device and EGL_EXT_platform_base extensions to set the display (output graphics card) to something different than EGL_DEFAULT_DISPLAY.

Just use the default display if deviceIndex == 0.

Member Data Documentation

◆ OwnWindow

vtkTypeBool vtkEGLRenderWindow::OwnWindow
protected

Definition at line 212 of file vtkEGLRenderWindow.h.

◆ IsPointSpriteBugTested

bool vtkEGLRenderWindow::IsPointSpriteBugTested
protected

Definition at line 213 of file vtkEGLRenderWindow.h.

◆ IsPointSpriteBugPresent_

bool vtkEGLRenderWindow::IsPointSpriteBugPresent_
protected

Definition at line 214 of file vtkEGLRenderWindow.h.

◆ Internals

vtkInternals* vtkEGLRenderWindow::Internals
protected

Definition at line 215 of file vtkEGLRenderWindow.h.


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