VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkXOpenGLRenderWindow Class Reference

OpenGL rendering window. More...

#include <vtkXOpenGLRenderWindow.h>

Inheritance diagram for vtkXOpenGLRenderWindow:
[legend]
Collaboration diagram for vtkXOpenGLRenderWindow:
[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.
 
vtkXOpenGLRenderWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void Start () override
 Begin the rendering process.
 
void Frame () override
 End the rendering process and display the image.
 
virtual void WindowInitialize ()
 Initialize the window for rendering.
 
void Initialize () override
 Initialize the rendering window.
 
void Finalize () override
 "Deinitialize" the rendering window.
 
void SetFullScreen (vtkTypeBool) override
 Change the window to fill the entire screen.
 
void WindowRemap () override
 Resize the window.
 
void SetShowWindow (bool val) override
 Show or not Show the window.
 
virtual void PrefFullScreen ()
 Set the preferred window size to full screen.
 
void SetSize (int width, int height) override
 Set the size (width and height) of the rendering window in screen coordinates (in pixels).
 
void SetSize (int a[2]) override
 Get the size (width and height) of the rendering window in screen coordinates (in pixels).
 
void SetSizeNoXResize (int, int)
 Specify the size of the rendering window in pixels but do not resize the XWindow.
 
void SetStereoCapableWindow (vtkTypeBool capable) override
 Prescribe that the window be created in a stereo-capable mode.
 
void MakeCurrent () override
 Make this window the current OpenGL context.
 
bool IsCurrent () override
 Tells if this window is the current OpenGL context for the calling thread.
 
void ReleaseCurrent () override
 Release the current context.
 
void SetForceMakeCurrent () override
 If called, allow MakeCurrent() to skip cache-check when called.
 
const char * ReportCapabilities () override
 Get report of capabilities for the render window.
 
vtkTypeBool IsDirect () override
 Is this render window using hardware acceleration? 0-false, 1-true.
 
void * GetGenericDisplayId () override
 Xwindow get set functions.
 
void * GetGenericWindowId () override
 Dummy stubs for vtkWindow API.
 
void * GetGenericParentId () override
 Dummy stubs for vtkWindow API.
 
void * GetGenericContext () override
 Dummy stubs for vtkWindow API.
 
void * GetGenericDrawable () override
 Dummy stubs for vtkWindow API.
 
int * GetScreenSize () override
 Get the current size of the screen in pixels.
 
int * GetPosition () override
 Get the position (x and y) of the rendering window in screen coordinates (in pixels).
 
Display * GetDisplayId ()
 Get this RenderWindow's X display id.
 
Window GetParentId ()
 Get this RenderWindow's parent X window id.
 
Window GetWindowId ()
 Get this RenderWindow's X window id.
 
void SetNextWindowId (Window)
 Specify the X window id to use if a WindowRemap is done.
 
void SetNextWindowId (void *) override
 Set the window id of the new window once a WindowRemap is done.
 
void SetWindowName (const char *) override
 Set name of rendering window.
 
void SetIcon (vtkImageData *img) override
 For window manager that supports it, set the icon displayed in the taskbar and the title bar.
 
bool InitializeFromCurrentContext () override
 Initialize the render window from the information associated with the currently activated OpenGL context.
 
bool GetPlatformSupportsRenderWindowSharing () override
 Does this platform support render window data sharing.
 
void SetCurrentCursor (int) override
 Change the shape of the cursor.
 
vtkTypeBool GetEventPending () override
 Check to see if a mouse button has been pressed or mouse wheel activated.
 
void SetWindowInfo (const char *info) override
 Set this RenderWindow's X window id to a pre-existing window.
 
void SetNextWindowInfo (const char *info) override
 Set the window info that will be used after WindowRemap()
 
void SetParentInfo (const char *info) override
 Sets the X window id of the window that WILL BE created.
 
void Render () override
 This computes the size of the render window before calling the supper classes render.
 
bool SetSwapControl (int i) override
 Set the number of vertical syncs required between frames.
 
virtual Colormap GetDesiredColormap ()
 Get the X properties of an ideal rendering window.
 
virtual Visual * GetDesiredVisual ()
 Get the X properties of an ideal rendering window.
 
virtual vtkXVisualInfo * GetDesiredVisualInfo ()
 Get the X properties of an ideal rendering window.
 
virtual int GetDesiredDepth ()
 Get the X properties of an ideal rendering window.
 
void SetDisplayId (Display *)
 Set the X display id for this RenderWindow to use to a pre-existing X display id.
 
void SetDisplayId (void *) override
 Set the X display id for this RenderWindow to use to a pre-existing X display id.
 
void SetParentId (Window)
 Sets the parent of the window that WILL BE created.
 
void SetParentId (void *) override
 Sets the parent of the window that WILL BE created.
 
void SetWindowId (Window)
 Set this RenderWindow's X window id to a pre-existing window.
 
void SetWindowId (void *) override
 Set this RenderWindow's X window id to a pre-existing window.
 
void SetPosition (int x, int y) override
 Set the position (x and y) of the rendering window in screen coordinates (in pixels).
 
void SetPosition (int a[2]) override
 Set the position (x and y) of the rendering window in screen coordinates (in pixels).
 
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.
 
void ShowCursor () 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.
 
void PushContext () override
 Ability to push and pop this window's context as the current context.
 
void PopContext () override
 Ability to push and pop this window's context as the current context.
 
- Public Member Functions inherited from vtkOpenGLRenderWindow
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkOpenGLRenderWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void Start (void) override
 Begin the rendering process.
 
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.
 
const char * GetRenderingBackend () override
 What rendering backend has the user requested.
 
void ActivateTexture (vtkTextureObject *)
 Activate a texture unit for this texture.
 
void DeactivateTexture (vtkTextureObject *)
 Deactivate a previously activated texture.
 
int GetTextureUnitForTexture (vtkTextureObject *)
 Get the texture unit for a given texture object.
 
int GetDepthBufferSize () override
 Get the size of the depth buffer.
 
bool GetUsingSRGBColorSpace ()
 Is this window/fo in sRGB colorspace.
 
int GetColorBufferSizes (int *rgba) override
 Get the size of the color buffer.
 
int GetColorBufferInternalFormat (int attachmentPoint)
 Get the internal format of current attached texture or render buffer.
 
virtual void OpenGLInit ()
 Initialize OpenGL for this window.
 
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... returns 0,0 if opengl has not been initialized yet.
 
virtual vtkMTimeType GetContextCreationTime ()
 Get the time when the OpenGL context was created.
 
vtkOpenGLShaderCacheGetShaderCache ()
 Returns an Shader Cache object.
 
vtkOpenGLVertexBufferObjectCacheGetVBOCache ()
 Returns the VBO Cache.
 
virtual vtkOpenGLFramebufferObjectGetDisplayFramebuffer ()
 Returns the display framebuffer object.
 
vtkTextureUnitManagerGetTextureUnitManager ()
 Returns its texture unit manager object.
 
void WaitForCompletion () override
 Block the thread until the actual rendering is finished().
 
virtual void DrawPixels (int x1, int y1, int x2, int y2, int numComponents, int dataType, void *data)
 Replacement for the old glDrawPixels function.
 
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.
 
virtual void DrawPixels (int srcWidth, int srcHeight, int numComponents, int dataType, void *data)
 Replacement for the old glDrawPixels function.
 
virtual float GetMaximumHardwareLineWidth ()
 Return the largest line width supported by the hardware.
 
virtual bool IsPointSpriteBugPresent ()
 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)
 
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.
 
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.
 
int SupportsOpenGL () override
 Does this render window support OpenGL? 0-false, 1-true.
 
const char * ReportCapabilities () override
 Get report of capabilities for the render window.
 
virtual void Initialize (void)
 Initialize the rendering window.
 
void RegisterGraphicsResources (vtkGenericOpenGLResourceFreeCallback *cb)
 
void UnregisterGraphicsResources (vtkGenericOpenGLResourceFreeCallback *cb)
 
virtual void PushContext ()
 Ability to push and pop this window's context as the current context.
 
virtual void PopContext ()
 
bool InitializeFromCurrentContext () override
 Initialize the render window from the information associated with the currently activated OpenGL context.
 
virtual bool SetSwapControl (int)
 Set the number of vertical syncs required between frames.
 
virtual vtkOpenGLStateGetState ()
 
vtkOpenGLBufferObjectGetTQuad2DVBO ()
 
int GetNoiseTextureUnit ()
 
void End () override
 Update the system, if needed, at end of render process.
 
void Render () override
 Handle opengl specific code and calls superclass.
 
void StereoMidpoint () override
 Intermediate method performs operations required between the rendering of the left and right eye.
 
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.
 
void BlitDisplayFramebuffer ()
 Blit a display framebuffer into a currently bound draw destination.
 
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.
 
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... front in this context indicates that the read should come from the display buffer versus the render buffer.
 
int GetPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right) override
 Set/Get the pixel data of an image, transmitted as RGBRGB... front in this context indicates that the read should come from the display buffer versus the render buffer.
 
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 RGBRGB... front in this context indicates that the read should come from the display buffer versus the render buffer.
 
int SetPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int right) override
 Set/Get the pixel data of an image, transmitted as RGBRGB... front in this context indicates that the read should come from the display buffer versus the render buffer.
 
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...
 
int GetRGBAPixelData (int x, int y, int x2, int y2, int front, vtkFloatArray *data, int right=0) override
 Set/Get the pixel data of an image, transmitted as RGBARGBA...
 
int SetRGBAPixelData (int x, int y, int x2, int y2, float *data, int front, int blend=0, int right=0) override
 Set/Get the pixel data of an image, transmitted as RGBARGBA...
 
int SetRGBAPixelData (int x, int y, int x2, int y2, vtkFloatArray *data, int front, int blend=0, int right=0) override
 Set/Get the pixel data of an image, transmitted as RGBARGBA...
 
void ReleaseRGBAPixelData (float *data) override
 Set/Get the pixel data of an image, transmitted as RGBARGBA...
 
unsigned char * GetRGBACharPixelData (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...
 
int GetRGBACharPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right=0) override
 Set/Get the pixel data of an image, transmitted as RGBARGBA...
 
int SetRGBACharPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int blend=0, int right=0) override
 Set/Get the pixel data of an image, transmitted as RGBARGBA...
 
int SetRGBACharPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int blend=0, int right=0) override
 Set/Get the pixel data of an image, transmitted as RGBARGBA...
 
float * GetZbufferData (int x1, int y1, int x2, int y2) override
 Set/Get the zbuffer data from an image.
 
int GetZbufferData (int x1, int y1, int x2, int y2, float *z) override
 Set/Get the zbuffer data from an image.
 
int GetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *buffer) override
 Set/Get the zbuffer data from an image.
 
int SetZbufferData (int x1, int y1, int x2, int y2, float *buffer) override
 Set/Get the zbuffer data from an image.
 
int SetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *buffer) override
 Set/Get the zbuffer data from an image.
 
unsigned int GetBackLeftBuffer ()
 
unsigned int GetBackRightBuffer ()
 
unsigned int GetFrontLeftBuffer ()
 
unsigned int GetFrontRightBuffer ()
 
unsigned int GetBackBuffer ()
 
unsigned int GetFrontBuffer ()
 
virtual vtkOpenGLFramebufferObjectGetRenderFramebuffer ()
 Returns the render framebuffer object.
 
vtkOpenGLFramebufferObjectGetOffScreenFramebuffer ()
 Returns the render framebuffer object.
 
void BlitToRenderFramebuffer (bool includeDepth)
 Blit the currently bound read buffer to the renderbuffer.
 
void BlitToRenderFramebuffer (int srcX, int srcY, int srcWidth, int srcHeight, int destX, int destY, int destWidth, int destHeight, int bufferMode, int interpolation)
 Blit the currently bound read buffer to the renderbuffer.
 
virtual void SetFrameBlitMode (FrameBlitModes)
 SetGet how to handle blits at the end of a Frame() call.
 
virtual FrameBlitModes GetFrameBlitMode ()
 SetGet how to handle blits at the end of a Frame() call.
 
void SetFrameBlitModeToBlitToHardware ()
 SetGet how to handle blits at the end of a Frame() call.
 
void SetFrameBlitModeToBlitToCurrent ()
 SetGet how to handle blits at the end of a Frame() call.
 
void SetFrameBlitModeToNoBlit ()
 SetGet how to handle blits at the end of a Frame() call.
 
virtual void TextureDepthBlit (vtkTextureObject *source)
 
virtual void TextureDepthBlit (vtkTextureObject *source, int srcX, int srcY, int srcX2, int srcY2)
 
virtual void TextureDepthBlit (vtkTextureObject *source, int srcX, int srcY, int srcX2, int srcY2, int destX, int destY, int destX2, int destY2)
 
- Public Member Functions inherited from vtkRenderWindow
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkRenderWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void AddRenderer (vtkRenderer *)
 Add a renderer to the list of renderers.
 
void RemoveRenderer (vtkRenderer *)
 Remove a renderer from the list of renderers.
 
int HasRenderer (vtkRenderer *)
 Query if a renderer is in the list of renderers.
 
virtual const char * GetRenderingBackend ()
 What rendering backend has the user requested.
 
 vtkGetNewMacro (RenderTimer, vtkRenderTimerLog)
 Get the render timer log for this window.
 
vtkRendererCollectionGetRenderers ()
 Return the collection of renderers in the render window.
 
void CaptureGL2PSSpecialProps (vtkCollection *specialProps)
 The GL2PS exporter must handle certain props in a special way (e.g.
 
void Render () override
 Ask each renderer owned by this RenderWindow to render its image and synchronize this process.
 
virtual void Start ()
 Start the rendering process for a frame.
 
virtual void End ()
 Update the system, if needed, at end of render process.
 
virtual void Finalize ()
 Finalize the rendering process.
 
virtual void Frame ()
 A termination method performed at the end of the rendering process to do things like swapping buffers (if necessary) or similar actions.
 
virtual void WaitForCompletion ()
 Block the thread until the actual rendering is finished().
 
virtual void CopyResultFrame ()
 Performed at the end of the rendering process to generate image.
 
virtual vtkRenderWindowInteractorMakeRenderWindowInteractor ()
 Create an interactor to control renderers in this window.
 
virtual void StereoUpdate ()
 Update the system, if needed, due to stereo rendering.
 
virtual void StereoMidpoint ()
 Intermediate method performs operations required between the rendering of the left and right eye.
 
virtual void StereoRenderComplete ()
 Handles work required once both views have been rendered when using stereo rendering.
 
virtual void WindowRemap ()
 Remap the rendering window.
 
virtual vtkTypeBool GetEventPending ()
 Check to see if a mouse button has been pressed.
 
virtual int CheckInRenderStatus ()
 Are we rendering at the moment.
 
virtual void ClearInRenderStatus ()
 Clear status (after an exception was thrown for example)
 
virtual void SetInteractor (vtkRenderWindowInteractor *)
 Set the interactor to the render window.
 
void UnRegister (vtkObjectBase *o) override
 This Method detects loops of RenderWindow<->Interactor, so objects are freed properly.
 
virtual bool InitializeFromCurrentContext ()
 Initialize the render window from the information associated with the currently activated OpenGL context.
 
virtual bool IsCurrent ()
 Tells if this window is the current graphics context for the calling thread.
 
virtual bool IsDrawable ()
 Test if the window has a valid drawable.
 
virtual void SetForceMakeCurrent ()
 If called, allow MakeCurrent() to skip cache-check when called.
 
virtual const char * ReportCapabilities ()
 Get report of capabilities for the render window.
 
virtual int SupportsOpenGL ()
 Does this render window support OpenGL? 0-false, 1-true.
 
virtual vtkTypeBool IsDirect ()
 Is this render window using hardware acceleration? 0-false, 1-true.
 
virtual int GetDepthBufferSize ()
 This method should be defined by the subclass.
 
virtual int GetColorBufferSizes (int *)
 Get the size of the color buffer.
 
virtual int GetNumberOfDevices ()
 Returns the number of devices (graphics cards) on a system.
 
virtual int GetCapturingGL2PSSpecialProps ()
 Returns true if the render process is capturing text actors.
 
virtual void SetCursorPosition (int, int)
 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.
 
virtual int GetCurrentCursor ()
 Change the shape of the cursor.
 
 vtkSetFilePathMacro (CursorFileName)
 Set/Get the full path to the custom cursor.
 
 vtkGetFilePathMacro (CursorFileName)
 Set/Get the full path to the custom cursor.
 
virtual vtkTypeBool GetFullScreen ()
 Turn on/off rendering full screen window size.
 
virtual void FullScreenOn ()
 Turn on/off rendering full screen window size.
 
virtual void FullScreenOff ()
 Turn on/off rendering full screen window size.
 
virtual void SetBorders (vtkTypeBool)
 Turn on/off window manager borders.
 
virtual vtkTypeBool GetBorders ()
 Turn on/off window manager borders.
 
virtual void BordersOn ()
 Turn on/off window manager borders.
 
virtual void BordersOff ()
 Turn on/off window manager borders.
 
virtual vtkTypeBool GetStereoCapableWindow ()
 Prescribe that the window be created in a stereo-capable mode.
 
virtual void StereoCapableWindowOn ()
 Prescribe that the window be created in a stereo-capable mode.
 
virtual void StereoCapableWindowOff ()
 Prescribe that the window be created in a stereo-capable mode.
 
virtual vtkTypeBool GetStereoRender ()
 Turn on/off stereo rendering.
 
void SetStereoRender (vtkTypeBool stereo)
 Turn on/off stereo rendering.
 
virtual void StereoRenderOn ()
 Turn on/off stereo rendering.
 
virtual void StereoRenderOff ()
 Turn on/off stereo rendering.
 
virtual void SetAlphaBitPlanes (vtkTypeBool)
 Turn on/off the use of alpha bitplanes.
 
virtual vtkTypeBool GetAlphaBitPlanes ()
 Turn on/off the use of alpha bitplanes.
 
virtual void AlphaBitPlanesOn ()
 Turn on/off the use of alpha bitplanes.
 
virtual void AlphaBitPlanesOff ()
 Turn on/off the use of alpha bitplanes.
 
virtual void SetPointSmoothing (vtkTypeBool)
 Turn on/off point smoothing.
 
virtual vtkTypeBool GetPointSmoothing ()
 Turn on/off point smoothing.
 
virtual void PointSmoothingOn ()
 Turn on/off point smoothing.
 
virtual void PointSmoothingOff ()
 Turn on/off point smoothing.
 
virtual void SetLineSmoothing (vtkTypeBool)
 Turn on/off line smoothing.
 
virtual vtkTypeBool GetLineSmoothing ()
 Turn on/off line smoothing.
 
virtual void LineSmoothingOn ()
 Turn on/off line smoothing.
 
virtual void LineSmoothingOff ()
 Turn on/off line smoothing.
 
virtual void SetPolygonSmoothing (vtkTypeBool)
 Turn on/off polygon smoothing.
 
virtual vtkTypeBool GetPolygonSmoothing ()
 Turn on/off polygon smoothing.
 
virtual void PolygonSmoothingOn ()
 Turn on/off polygon smoothing.
 
virtual void PolygonSmoothingOff ()
 Turn on/off polygon smoothing.
 
virtual int GetStereoType ()
 Set/Get what type of stereo rendering to use.
 
void SetStereoType (int)
 Set/Get what type of stereo rendering to use.
 
void SetStereoTypeToCrystalEyes ()
 Set/Get what type of stereo rendering to use.
 
void SetStereoTypeToRedBlue ()
 Set/Get what type of stereo rendering to use.
 
void SetStereoTypeToInterlaced ()
 Set/Get what type of stereo rendering to use.
 
void SetStereoTypeToLeft ()
 Set/Get what type of stereo rendering to use.
 
void SetStereoTypeToRight ()
 Set/Get what type of stereo rendering to use.
 
void SetStereoTypeToDresden ()
 Set/Get what type of stereo rendering to use.
 
void SetStereoTypeToAnaglyph ()
 Set/Get what type of stereo rendering to use.
 
void SetStereoTypeToCheckerboard ()
 Set/Get what type of stereo rendering to use.
 
void SetStereoTypeToSplitViewportHorizontal ()
 Set/Get what type of stereo rendering to use.
 
void SetStereoTypeToFake ()
 Set/Get what type of stereo rendering to use.
 
void SetStereoTypeToEmulate ()
 Set/Get what type of stereo rendering to use.
 
virtual void SetAnaglyphColorSaturation (float)
 Set/get the anaglyph color saturation factor.
 
virtual float GetAnaglyphColorSaturation ()
 Set/get the anaglyph color saturation factor.
 
virtual void SetAnaglyphColorMask (int, int)
 Set/get the anaglyph color mask values.
 
void SetAnaglyphColorMask (int[2])
 Set/get the anaglyph color mask values.
 
virtual int * GetAnaglyphColorMask ()
 Set/get the anaglyph color mask values.
 
virtual void GetAnaglyphColorMask (int data[2])
 Set/get the anaglyph color mask values.
 
virtual void SetSwapBuffers (vtkTypeBool)
 Turn on/off buffer swapping between images.
 
virtual vtkTypeBool GetSwapBuffers ()
 Turn on/off buffer swapping between images.
 
virtual void SwapBuffersOn ()
 Turn on/off buffer swapping between images.
 
virtual void SwapBuffersOff ()
 Turn on/off buffer swapping between images.
 
float GetZbufferDataAtPoint (int x, int y)
 Set/Get the zbuffer data from the frame buffer.
 
virtual int GetNeverRendered ()
 This flag is set if the window hasn't rendered since it was created.
 
virtual int GetAbortRender ()
 This is a flag that can be set to interrupt a rendering that is in progress.
 
virtual void SetAbortRender (int)
 This is a flag that can be set to interrupt a rendering that is in progress.
 
virtual int GetInAbortCheck ()
 This is a flag that can be set to interrupt a rendering that is in progress.
 
virtual void SetInAbortCheck (int)
 This is a flag that can be set to interrupt a rendering that is in progress.
 
virtual int CheckAbortStatus ()
 This is a flag that can be set to interrupt a rendering that is in progress.
 
vtkTypeBool GetIsPicking ()
 
void SetIsPicking (vtkTypeBool)
 
void IsPickingOn ()
 
void IsPickingOff ()
 
virtual void SetDesiredUpdateRate (double)
 Set/Get the desired update rate.
 
virtual double GetDesiredUpdateRate ()
 Set/Get the desired update rate.
 
virtual int GetNumberOfLayers ()
 Get the number of layers for renderers.
 
virtual void SetNumberOfLayers (int)
 Get the number of layers for renderers.
 
virtual vtkRenderWindowInteractorGetInteractor ()
 Get the interactor associated with this render window.
 
virtual void SetSharedRenderWindow (vtkRenderWindow *)
 Set/Get an already existing window that this window should share data with if possible.
 
virtual vtkRenderWindowGetSharedRenderWindow ()
 Set/Get an already existing window that this window should share data with if possible.
 
virtual void SetMultiSamples (int)
 Set / Get the number of multisamples to use for hardware antialiasing.
 
virtual int GetMultiSamples ()
 Set / Get the number of multisamples to use for hardware antialiasing.
 
virtual void SetStencilCapable (vtkTypeBool)
 Set / Get the availability of the stencil buffer.
 
virtual vtkTypeBool GetStencilCapable ()
 Set / Get the availability of the stencil buffer.
 
virtual void StencilCapableOn ()
 Set / Get the availability of the stencil buffer.
 
virtual void StencilCapableOff ()
 Set / Get the availability of the stencil buffer.
 
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.
 
virtual int GetDeviceIndex ()
 If there are several graphics card installed on a system, this index can be used to specify which card you want to render to.
 
virtual bool GetUseSRGBColorSpace ()
 Set/Get if we want this window to use the sRGB color space.
 
virtual void SetUseSRGBColorSpace (bool)
 Set/Get if we want this window to use the sRGB color space.
 
virtual void UseSRGBColorSpaceOn ()
 Set/Get if we want this window to use the sRGB color space.
 
virtual void UseSRGBColorSpaceOff ()
 Set/Get if we want this window to use the sRGB color space.
 
const char * GetStereoTypeAsString ()
 Returns the stereo type as a string.
 
- Public Member Functions inherited from vtkWindow
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
int * GetActualSize ()
 GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale.
 
virtual int * GetScreenSize ()
 Get the current size of the screen in pixels.
 
virtual void SetIcon (vtkImageData *)
 Set the icon used in title bar and task bar.
 
virtual void Render ()
 Ask each viewport owned by this Window to render its image and synchronize this process.
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 Release any graphics resources that are being consumed by this texture.
 
virtual bool DetectDPI ()
 Attempt to detect and set the DPI of the display device by querying the system.
 
vtkTypeBool GetOffScreenRendering ()
 Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead.
 
virtual void MakeCurrent ()
 Make the window current.
 
virtual void ReleaseCurrent ()
 Release the current context.
 
virtual int * GetSize ()
 Get the size (width and height) of the rendering window in screen coordinates (in pixels).
 
virtual vtkTypeBool GetMapped ()
 Keep track of whether the rendering window has been mapped to screen.
 
virtual bool GetShowWindow ()
 Show or not Show the window.
 
virtual void ShowWindowOn ()
 Show or not Show the window.
 
virtual void ShowWindowOff ()
 Show or not Show the window.
 
virtual void SetUseOffScreenBuffers (bool)
 Render to an offscreen destination such as a framebuffer.
 
virtual bool GetUseOffScreenBuffers ()
 Render to an offscreen destination such as a framebuffer.
 
virtual void UseOffScreenBuffersOn ()
 Render to an offscreen destination such as a framebuffer.
 
virtual void UseOffScreenBuffersOff ()
 Render to an offscreen destination such as a framebuffer.
 
virtual void SetErase (vtkTypeBool)
 Turn on/off erasing the screen between images.
 
virtual vtkTypeBool GetErase ()
 Turn on/off erasing the screen between images.
 
virtual void EraseOn ()
 Turn on/off erasing the screen between images.
 
virtual void EraseOff ()
 Turn on/off erasing the screen between images.
 
virtual void SetDoubleBuffer (vtkTypeBool)
 Keep track of whether double buffering is on or off.
 
virtual vtkTypeBool GetDoubleBuffer ()
 Keep track of whether double buffering is on or off.
 
virtual void DoubleBufferOn ()
 Keep track of whether double buffering is on or off.
 
virtual void DoubleBufferOff ()
 Keep track of whether double buffering is on or off.
 
virtual char * GetWindowName ()
 Get name of rendering window.
 
virtual int GetDPI ()
 Return a best estimate to the dots per inch of the display device being rendered (or printed).
 
virtual void SetDPI (int)
 Return a best estimate to the dots per inch of the display device being rendered (or printed).
 
void SetOffScreenRendering (vtkTypeBool val)
 Convenience to set SHowWindow and UseOffScreenBuffers in one call.
 
virtual void OffScreenRenderingOn ()
 Convenience to set SHowWindow and UseOffScreenBuffers in one call.
 
virtual void OffScreenRenderingOff ()
 Convenience to set SHowWindow and UseOffScreenBuffers in one call.
 
virtual void SetTileScale (int, int)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
 
void SetTileScale (int[2])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
 
virtual int * GetTileScale ()
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
 
virtual void GetTileScale (int &, int &)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
 
virtual void GetTileScale (int[2])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
 
void SetTileScale (int s)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
 
virtual void SetTileViewport (double, double, double, double)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
 
virtual void SetTileViewport (double[4])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
 
virtual double * GetTileViewport ()
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
 
virtual void GetTileViewport (double &, double &, double &, double &)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
 
virtual void GetTileViewport (double[4])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
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).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkXOpenGLRenderWindowNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkXOpenGLRenderWindowSafeDownCast (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.
 
static int GetGlobalMaximumNumberOfMultiSamples ()
 Set/Get the maximum number of multisamples.
 
- 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.
 
static const char * GetRenderLibrary ()
 What rendering library has the user requested.
 
static const char * GetStereoTypeAsString (int type)
 Returns the stereo type as a string.
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
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).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
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.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkXOpenGLRenderWindow ()
 
 ~vtkXOpenGLRenderWindow () override
 
void CreateAWindow () override
 Create a not-off-screen window.
 
void DestroyWindow () override
 Destroy a not-off-screen window.
 
void CloseDisplay ()
 
- Protected Member Functions inherited from vtkOpenGLRenderWindow
virtual vtkObjectBaseNewInstanceInternal () const
 
 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.
 
virtual void CreateAWindow ()=0
 Create a not-off-screen window.
 
virtual void DestroyWindow ()=0
 Destroy a not-off-screen window.
 
void SaveGLState ()
 Query and save OpenGL state.
 
void RestoreGLState ()
 Restore OpenGL state at end of the rendering.
 
- Protected Member Functions inherited from vtkRenderWindow
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRenderWindow ()
 
 ~vtkRenderWindow () override
 
virtual void DoStereoRender ()
 
- Protected Member Functions inherited from vtkWindow
virtual vtkObjectBaseNewInstanceInternal () const
 
 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkXOpenGLRenderWindowInternal * Internal
 
Window ParentId
 
Window WindowId
 
Window NextWindowId
 
Display * DisplayId
 
Colormap ColorMap
 
vtkTypeBool OwnWindow
 
vtkTypeBool OwnDisplay
 
vtkTypeBool CursorHidden
 
vtkTypeBool ForceMakeCurrent
 
vtkTypeBool UsingHardware
 
std::stack< Display * > DisplayStack
 
std::stack< Drawable > DrawableStack
 
std::stack< void * > ContextStack
 
Cursor XCCrosshair
 
Cursor XCArrow
 
Cursor XCSizeAll
 
Cursor XCSizeNS
 
Cursor XCSizeWE
 
Cursor XCSizeNE
 
Cursor XCSizeNW
 
Cursor XCSizeSE
 
Cursor XCSizeSW
 
Cursor XCHand
 
Cursor XCCustom
 
- Protected Attributes inherited from vtkOpenGLRenderWindow
FrameBlitModes FrameBlitMode
 
vtkOpenGLQuadHelperResolveQuad
 
vtkOpenGLQuadHelperDepthBlitQuad
 
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.
 
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
 
char * CursorFileName
 
double AbortCheckTime
 The universal time since the last abort check occurred.
 
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.

vtkXOpenGLRenderWindow is a concrete implementation of the abstract class vtkRenderWindow. vtkOpenGLRenderer interfaces to the OpenGL graphics library. Application programmers should normally use vtkRenderWindow instead of the OpenGL specific version.

Events:
vtkCommand::CursorChangedEvent vtkCommand::ExitEvent

Definition at line 40 of file vtkXOpenGLRenderWindow.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkXOpenGLRenderWindow.h.

Constructor & Destructor Documentation

◆ vtkXOpenGLRenderWindow()

vtkXOpenGLRenderWindow::vtkXOpenGLRenderWindow ( )
protected

◆ ~vtkXOpenGLRenderWindow()

vtkXOpenGLRenderWindow::~vtkXOpenGLRenderWindow ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkXOpenGLRenderWindow * vtkXOpenGLRenderWindow::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkXOpenGLRenderWindow::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 vtkXOpenGLRenderWindow * vtkXOpenGLRenderWindow::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXOpenGLRenderWindow::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkOpenGLRenderWindow.

◆ NewInstance()

vtkXOpenGLRenderWindow * vtkXOpenGLRenderWindow::NewInstance ( ) const

◆ PrintSelf()

void vtkXOpenGLRenderWindow::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 vtkOpenGLRenderWindow.

◆ Start()

void vtkXOpenGLRenderWindow::Start ( )
overridevirtual

Begin the rendering process.

Reimplemented from vtkOpenGLRenderWindow.

◆ Frame()

void vtkXOpenGLRenderWindow::Frame ( )
overridevirtual

End the rendering process and display the image.

Reimplemented from vtkOpenGLRenderWindow.

◆ WindowInitialize()

virtual void vtkXOpenGLRenderWindow::WindowInitialize ( )
virtual

Initialize the window for rendering.

◆ Initialize()

void vtkXOpenGLRenderWindow::Initialize ( )
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 vtkXOpenGLRenderWindow::Finalize ( )
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 vtkXOpenGLRenderWindow::SetFullScreen ( vtkTypeBool  )
overridevirtual

Change the window to fill the entire screen.

Reimplemented from vtkRenderWindow.

◆ WindowRemap()

void vtkXOpenGLRenderWindow::WindowRemap ( )
overridevirtual

Resize the window.

Reimplemented from vtkRenderWindow.

◆ SetShowWindow()

void vtkXOpenGLRenderWindow::SetShowWindow ( bool  )
overridevirtual

Show or not Show the window.

Reimplemented from vtkWindow.

◆ PrefFullScreen()

virtual void vtkXOpenGLRenderWindow::PrefFullScreen ( )
virtual

Set the preferred window size to full screen.

◆ SetSize() [1/2]

void vtkXOpenGLRenderWindow::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 vtkXOpenGLRenderWindow::SetSize ( int  a[2])
inlineoverridevirtual

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

Reimplemented from vtkWindow.

Definition at line 104 of file vtkXOpenGLRenderWindow.h.

◆ SetSizeNoXResize()

void vtkXOpenGLRenderWindow::SetSizeNoXResize ( int  ,
int   
)

Specify the size of the rendering window in pixels but do not resize the XWindow.

Useful when resizing is done interactively.

◆ GetDesiredColormap()

virtual Colormap vtkXOpenGLRenderWindow::GetDesiredColormap ( )
virtual

Get the X properties of an ideal rendering window.

◆ GetDesiredVisual()

virtual Visual * vtkXOpenGLRenderWindow::GetDesiredVisual ( )
virtual

Get the X properties of an ideal rendering window.

◆ GetDesiredVisualInfo()

virtual vtkXVisualInfo * vtkXOpenGLRenderWindow::GetDesiredVisualInfo ( )
virtual

Get the X properties of an ideal rendering window.

◆ GetDesiredDepth()

virtual int vtkXOpenGLRenderWindow::GetDesiredDepth ( )
virtual

Get the X properties of an ideal rendering window.

◆ SetStereoCapableWindow()

void vtkXOpenGLRenderWindow::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 vtkXOpenGLRenderWindow::MakeCurrent ( )
overridevirtual

Make this window the current OpenGL context.

Reimplemented from vtkWindow.

◆ IsCurrent()

bool vtkXOpenGLRenderWindow::IsCurrent ( )
overridevirtual

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

Reimplemented from vtkRenderWindow.

◆ ReleaseCurrent()

void vtkXOpenGLRenderWindow::ReleaseCurrent ( )
overridevirtual

Release the current context.

Reimplemented from vtkWindow.

◆ SetForceMakeCurrent()

void vtkXOpenGLRenderWindow::SetForceMakeCurrent ( )
overridevirtual

If called, allow MakeCurrent() to skip cache-check when called.

MakeCurrent() reverts to original behavior of cache-checking on the next render.

Reimplemented from vtkRenderWindow.

◆ ReportCapabilities()

const char * vtkXOpenGLRenderWindow::ReportCapabilities ( )
overridevirtual

Get report of capabilities for the render window.

Reimplemented from vtkOpenGLRenderWindow.

◆ IsDirect()

vtkTypeBool vtkXOpenGLRenderWindow::IsDirect ( )
overridevirtual

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

Reimplemented from vtkRenderWindow.

◆ GetGenericDisplayId()

void * vtkXOpenGLRenderWindow::GetGenericDisplayId ( )
inlineoverridevirtual

Xwindow get set functions.

Reimplemented from vtkRenderWindow.

Definition at line 165 of file vtkXOpenGLRenderWindow.h.

◆ GetGenericWindowId()

void * vtkXOpenGLRenderWindow::GetGenericWindowId ( )
overridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkRenderWindow.

◆ GetGenericParentId()

void * vtkXOpenGLRenderWindow::GetGenericParentId ( )
inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkRenderWindow.

Definition at line 168 of file vtkXOpenGLRenderWindow.h.

◆ GetGenericContext()

void * vtkXOpenGLRenderWindow::GetGenericContext ( )
overridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkRenderWindow.

◆ GetGenericDrawable()

void * vtkXOpenGLRenderWindow::GetGenericDrawable ( )
inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkRenderWindow.

Definition at line 171 of file vtkXOpenGLRenderWindow.h.

◆ GetScreenSize()

int * vtkXOpenGLRenderWindow::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 * vtkXOpenGLRenderWindow::GetPosition ( )
overridevirtual

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

Reimplemented from vtkWindow.

◆ GetDisplayId()

Display * vtkXOpenGLRenderWindow::GetDisplayId ( )

Get this RenderWindow's X display id.

◆ SetDisplayId() [1/2]

void vtkXOpenGLRenderWindow::SetDisplayId ( Display *  )

Set the X display id for this RenderWindow to use to a pre-existing X display id.

◆ SetDisplayId() [2/2]

void vtkXOpenGLRenderWindow::SetDisplayId ( void *  )
overridevirtual

Set the X display id for this RenderWindow to use to a pre-existing X display id.

Reimplemented from vtkRenderWindow.

◆ GetParentId()

Window vtkXOpenGLRenderWindow::GetParentId ( )

Get this RenderWindow's parent X window id.

◆ SetParentId() [1/2]

void vtkXOpenGLRenderWindow::SetParentId ( Window  )

Sets the parent of the window that WILL BE created.

◆ SetParentId() [2/2]

void vtkXOpenGLRenderWindow::SetParentId ( void *  )
overridevirtual

Sets the parent of the window that WILL BE created.

Reimplemented from vtkRenderWindow.

◆ GetWindowId()

Window vtkXOpenGLRenderWindow::GetWindowId ( )

Get this RenderWindow's X window id.

◆ SetWindowId() [1/2]

void vtkXOpenGLRenderWindow::SetWindowId ( Window  )

Set this RenderWindow's X window id to a pre-existing window.

◆ SetWindowId() [2/2]

void vtkXOpenGLRenderWindow::SetWindowId ( void *  )
overridevirtual

Set this RenderWindow's X window id to a pre-existing window.

Reimplemented from vtkRenderWindow.

◆ SetNextWindowId() [1/2]

void vtkXOpenGLRenderWindow::SetNextWindowId ( Window  )

Specify the X window id to use if a WindowRemap is done.

◆ SetNextWindowId() [2/2]

void vtkXOpenGLRenderWindow::SetNextWindowId ( void *  )
overridevirtual

Set the window id of the new window once a WindowRemap is done.

This is the generic prototype as required by the vtkRenderWindow parent.

Reimplemented from vtkRenderWindow.

◆ SetWindowName()

void vtkXOpenGLRenderWindow::SetWindowName ( const char *  )
overridevirtual

Set name of rendering window.

Reimplemented from vtkWindow.

◆ SetIcon()

void vtkXOpenGLRenderWindow::SetIcon ( vtkImageData img)
overridevirtual

For window manager that supports it, set the icon displayed in the taskbar and the title bar.

Reimplemented from vtkWindow.

◆ InitializeFromCurrentContext()

bool vtkXOpenGLRenderWindow::InitializeFromCurrentContext ( )
overridevirtual

Initialize the render window from the information associated with the currently activated OpenGL context.

Reimplemented from vtkOpenGLRenderWindow.

◆ GetPlatformSupportsRenderWindowSharing()

bool vtkXOpenGLRenderWindow::GetPlatformSupportsRenderWindowSharing ( )
inlineoverridevirtual

Does this platform support render window data sharing.

Reimplemented from vtkRenderWindow.

Definition at line 257 of file vtkXOpenGLRenderWindow.h.

◆ SetPosition() [1/2]

void vtkXOpenGLRenderWindow::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 vtkXOpenGLRenderWindow::SetPosition ( int  a[2])
inlineoverridevirtual

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.

Definition at line 266 of file vtkXOpenGLRenderWindow.h.

◆ HideCursor()

void vtkXOpenGLRenderWindow::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 vtkXOpenGLRenderWindow::ShowCursor ( )
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.

◆ SetCurrentCursor()

void vtkXOpenGLRenderWindow::SetCurrentCursor ( int  )
overridevirtual

Change the shape of the cursor.

Reimplemented from vtkRenderWindow.

◆ GetEventPending()

vtkTypeBool vtkXOpenGLRenderWindow::GetEventPending ( )
overridevirtual

Check to see if a mouse button has been pressed or mouse wheel activated.

All other events are ignored by this method. This is a useful check to abort a long render.

Reimplemented from vtkRenderWindow.

◆ SetWindowInfo()

void vtkXOpenGLRenderWindow::SetWindowInfo ( const char *  info)
overridevirtual

Set this RenderWindow's X window id to a pre-existing window.

Reimplemented from vtkRenderWindow.

◆ SetNextWindowInfo()

void vtkXOpenGLRenderWindow::SetNextWindowInfo ( const char *  info)
overridevirtual

Set the window info that will be used after WindowRemap()

Reimplemented from vtkRenderWindow.

◆ SetParentInfo()

void vtkXOpenGLRenderWindow::SetParentInfo ( const char *  info)
overridevirtual

Sets the X window id of the window that WILL BE created.

Reimplemented from vtkRenderWindow.

◆ Render()

void vtkXOpenGLRenderWindow::Render ( )
overridevirtual

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

Reimplemented from vtkOpenGLRenderWindow.

◆ PushContext()

void vtkXOpenGLRenderWindow::PushContext ( )
overridevirtual

Ability to push and pop this window's context as the current context.

The idea being to if needed make this window's context current and when done releasing resources restore the prior context

Reimplemented from vtkOpenGLRenderWindow.

◆ PopContext()

void vtkXOpenGLRenderWindow::PopContext ( )
overridevirtual

Ability to push and pop this window's context as the current context.

The idea being to if needed make this window's context current and when done releasing resources restore the prior context

Reimplemented from vtkOpenGLRenderWindow.

◆ SetSwapControl()

bool vtkXOpenGLRenderWindow::SetSwapControl ( int  i)
overridevirtual

Set the number of vertical syncs required between frames.

A value of 0 means swap buffers as quickly as possible regardless of the vertical refresh. A value of 1 means swap buffers in sync with the vertical refresh to eliminate tearing. A value of -1 means use a value of 1 unless we missed a frame in which case swap immediately. Returns true if the call succeeded.

Reimplemented from vtkOpenGLRenderWindow.

◆ CreateAWindow()

void vtkXOpenGLRenderWindow::CreateAWindow ( )
overrideprotectedvirtual

Create a not-off-screen window.

Implements vtkOpenGLRenderWindow.

◆ DestroyWindow()

void vtkXOpenGLRenderWindow::DestroyWindow ( )
overrideprotectedvirtual

Destroy a not-off-screen window.

Implements vtkOpenGLRenderWindow.

◆ CloseDisplay()

void vtkXOpenGLRenderWindow::CloseDisplay ( )
protected

Member Data Documentation

◆ Internal

vtkXOpenGLRenderWindowInternal* vtkXOpenGLRenderWindow::Internal
protected

Definition at line 338 of file vtkXOpenGLRenderWindow.h.

◆ ParentId

Window vtkXOpenGLRenderWindow::ParentId
protected

Definition at line 340 of file vtkXOpenGLRenderWindow.h.

◆ WindowId

Window vtkXOpenGLRenderWindow::WindowId
protected

Definition at line 341 of file vtkXOpenGLRenderWindow.h.

◆ NextWindowId

Window vtkXOpenGLRenderWindow::NextWindowId
protected

Definition at line 342 of file vtkXOpenGLRenderWindow.h.

◆ DisplayId

Display* vtkXOpenGLRenderWindow::DisplayId
protected

Definition at line 343 of file vtkXOpenGLRenderWindow.h.

◆ ColorMap

Colormap vtkXOpenGLRenderWindow::ColorMap
protected

Definition at line 344 of file vtkXOpenGLRenderWindow.h.

◆ OwnWindow

vtkTypeBool vtkXOpenGLRenderWindow::OwnWindow
protected

Definition at line 345 of file vtkXOpenGLRenderWindow.h.

◆ OwnDisplay

vtkTypeBool vtkXOpenGLRenderWindow::OwnDisplay
protected

Definition at line 346 of file vtkXOpenGLRenderWindow.h.

◆ CursorHidden

vtkTypeBool vtkXOpenGLRenderWindow::CursorHidden
protected

Definition at line 347 of file vtkXOpenGLRenderWindow.h.

◆ ForceMakeCurrent

vtkTypeBool vtkXOpenGLRenderWindow::ForceMakeCurrent
protected

Definition at line 348 of file vtkXOpenGLRenderWindow.h.

◆ UsingHardware

vtkTypeBool vtkXOpenGLRenderWindow::UsingHardware
protected

Definition at line 349 of file vtkXOpenGLRenderWindow.h.

◆ DisplayStack

std::stack<Display*> vtkXOpenGLRenderWindow::DisplayStack
protected

Definition at line 351 of file vtkXOpenGLRenderWindow.h.

◆ DrawableStack

std::stack<Drawable> vtkXOpenGLRenderWindow::DrawableStack
protected

Definition at line 352 of file vtkXOpenGLRenderWindow.h.

◆ ContextStack

std::stack<void*> vtkXOpenGLRenderWindow::ContextStack
protected

Definition at line 353 of file vtkXOpenGLRenderWindow.h.

◆ XCCrosshair

Cursor vtkXOpenGLRenderWindow::XCCrosshair
protected

Definition at line 356 of file vtkXOpenGLRenderWindow.h.

◆ XCArrow

Cursor vtkXOpenGLRenderWindow::XCArrow
protected

Definition at line 357 of file vtkXOpenGLRenderWindow.h.

◆ XCSizeAll

Cursor vtkXOpenGLRenderWindow::XCSizeAll
protected

Definition at line 358 of file vtkXOpenGLRenderWindow.h.

◆ XCSizeNS

Cursor vtkXOpenGLRenderWindow::XCSizeNS
protected

Definition at line 359 of file vtkXOpenGLRenderWindow.h.

◆ XCSizeWE

Cursor vtkXOpenGLRenderWindow::XCSizeWE
protected

Definition at line 360 of file vtkXOpenGLRenderWindow.h.

◆ XCSizeNE

Cursor vtkXOpenGLRenderWindow::XCSizeNE
protected

Definition at line 361 of file vtkXOpenGLRenderWindow.h.

◆ XCSizeNW

Cursor vtkXOpenGLRenderWindow::XCSizeNW
protected

Definition at line 362 of file vtkXOpenGLRenderWindow.h.

◆ XCSizeSE

Cursor vtkXOpenGLRenderWindow::XCSizeSE
protected

Definition at line 363 of file vtkXOpenGLRenderWindow.h.

◆ XCSizeSW

Cursor vtkXOpenGLRenderWindow::XCSizeSW
protected

Definition at line 364 of file vtkXOpenGLRenderWindow.h.

◆ XCHand

Cursor vtkXOpenGLRenderWindow::XCHand
protected

Definition at line 365 of file vtkXOpenGLRenderWindow.h.

◆ XCCustom

Cursor vtkXOpenGLRenderWindow::XCCustom
protected

Definition at line 366 of file vtkXOpenGLRenderWindow.h.


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