VTK
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
vtkOpenGLRenderWindow Class Referenceabstract

OpenGL rendering window. More...

#include <vtkOpenGLRenderWindow.h>

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

Public Types

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...
 
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...
 
const char * GetRenderingBackend () override
 What rendering backend has the user requested. More...
 
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 ()
 Return the OpenGL name of the back left buffer. More...
 
unsigned int GetBackRightBuffer ()
 Return the OpenGL name of the back right buffer. More...
 
unsigned int GetFrontLeftBuffer ()
 Return the OpenGL name of the front left buffer. More...
 
unsigned int GetFrontRightBuffer ()
 Return the OpenGL name of the front right buffer. More...
 
unsigned int GetBackBuffer ()
 Return the OpenGL name of the back left buffer. More...
 
unsigned int GetFrontBuffer ()
 Return the OpenGL name of the front left buffer. More...
 
virtual vtkMTimeType GetContextCreationTime ()
 Get the time when the OpenGL context was created. More...
 
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...
 
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) 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...
 
virtual void Initialize (void)
 Initialize the rendering 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 unsigned int GetDefaultFrameBufferId ()
 Returns the id for the frame buffer object, if any, used by the render window in which the window does all its rendering. More...
 
virtual bool SetSwapControl (int)
 Set the number of vertical syncs required between frames. More...
 
virtual vtkOpenGLStateGetState ()
 
vtkOpenGLBufferObjectGetTQuad2DVBO ()
 
int GetNoiseTextureUnit ()
 
void StereoUpdate () override
 Update the system, if needed, due to stereo rendering. More...
 
void StereoMidpoint () override
 Intermediate method performs operations required between the rendering of the left and right eye. More...
 
void Render () override
 Handle opengl specific code and calls superclass. More...
 
bool GetCurrentBufferNeedsResolving ()
 
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
 Set/Get the pixel data of an image, transmitted as RGBRGB... More...
 
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... More...
 
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... More...
 
floatGetRGBAPixelData (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
 Set/Get the pixel data of an image, transmitted as RGBARGBA... More...
 
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... More...
 
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... More...
 
void ReleaseRGBAPixelData (float *data) override
 Set/Get the pixel data of an image, transmitted as RGBARGBA... More...
 
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... More...
 
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... More...
 
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... More...
 
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... More...
 
floatGetZbufferData (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
 Set/Get the zbuffer data from an image. More...
 
int GetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *z) override
 Set/Get the zbuffer data from an image. More...
 
int SetZbufferData (int x1, int y1, int x2, int y2, float *buffer) override
 Set/Get the zbuffer data from an image. More...
 
int SetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *buffer) override
 Set/Get the zbuffer data from an image. More...
 
void SetSize (int a[2]) override
 Set the size of the window in screen coordinates in pixels. More...
 
void SetSize (int, int) override
 Set the size of the window in screen coordinates in pixels. More...
 
virtual vtkOpenGLShaderCacheGetShaderCache ()
 Returns an Shader Cache object. More...
 
virtual vtkOpenGLVertexBufferObjectCacheGetVBOCache ()
 Returns an Shader Cache object. More...
 
virtual vtkOpenGLFramebufferObjectGetOffScreenFramebuffer ()
 Returns the offscreen framebuffer object if any. More...
 
- 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) vtkRendererCollection *GetRenderers()
 Get the render timer log for this window. More...
 
void CaptureGL2PSSpecialProps (vtkCollection *specialProps)
 The GL2PS exporter must handle certain props in a special way (e.g. More...
 
virtual void Finalize ()=0
 Finalize the rendering process. More...
 
virtual void Frame ()=0
 A termination method performed at the end of the rendering process to do things like swapping buffers (if necessary) or similar actions. 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 StereoRenderComplete ()
 Handles work required once both views have been rendered when using stereo rendering. More...
 
virtual void WindowRemap ()=0
 Remap the rendering window. More...
 
virtual int GetEventPending ()=0
 Check to see if a mouse button has been pressed. More...
 
virtual int CheckInRenderStatus ()
 Are we rendering at the moment. More...
 
virtual void ClearInRenderStatus ()
 Clear status (after an exception was thrown for example) More...
 
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...
 
void MakeCurrent () override=0
 Attempt to make this window the current graphics context for the calling thread. More...
 
virtual bool IsCurrent ()=0
 Tells if this window is the current graphics context for the calling thread. More...
 
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 int IsDirect ()
 Is this render window using hardware acceleration? 0-false, 1-true. More...
 
virtual int GetNumberOfDevices ()
 Returns the number of devices (graphics cards) on a system. More...
 
virtual int GetCapturingGL2PSSpecialProps ()
 Returns true if the render process is capturing text actors. More...
 
virtual void HideCursor ()=0
 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...
 
virtual void ShowCursor ()=0
 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...
 
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. More...
 
virtual void SetCurrentCursor (int)
 Change the shape of the cursor. More...
 
virtual int GetCurrentCursor ()
 Change the shape of the cursor. More...
 
virtual void SetFullScreen (vtkTypeBool)=0
 Turn on/off rendering full screen window size. More...
 
virtual vtkTypeBool GetFullScreen ()
 Turn on/off rendering full screen window size. More...
 
virtual void FullScreenOn ()
 Turn on/off rendering full screen window size. More...
 
virtual void FullScreenOff ()
 Turn on/off rendering full screen window size. More...
 
virtual void SetBorders (vtkTypeBool)
 Turn on/off window manager borders. More...
 
virtual vtkTypeBool GetBorders ()
 Turn on/off window manager borders. More...
 
virtual void BordersOn ()
 Turn on/off window manager borders. More...
 
virtual void BordersOff ()
 Turn on/off window manager borders. More...
 
virtual vtkTypeBool GetStereoCapableWindow ()
 Prescribe that the window be created in a stereo-capable mode. More...
 
virtual void StereoCapableWindowOn ()
 Prescribe that the window be created in a stereo-capable mode. More...
 
virtual void StereoCapableWindowOff ()
 Prescribe that the window be created in a stereo-capable mode. More...
 
virtual void SetStereoCapableWindow (vtkTypeBool capable)
 Prescribe that the window be created in a stereo-capable mode. More...
 
virtual vtkTypeBool GetStereoRender ()
 Turn on/off stereo rendering. More...
 
void SetStereoRender (vtkTypeBool stereo)
 Turn on/off stereo rendering. More...
 
virtual void StereoRenderOn ()
 Turn on/off stereo rendering. More...
 
virtual void StereoRenderOff ()
 Turn on/off stereo rendering. More...
 
virtual void SetAlphaBitPlanes (vtkTypeBool)
 Turn on/off the use of alpha bitplanes. More...
 
virtual vtkTypeBool GetAlphaBitPlanes ()
 Turn on/off the use of alpha bitplanes. More...
 
virtual void AlphaBitPlanesOn ()
 Turn on/off the use of alpha bitplanes. More...
 
virtual void AlphaBitPlanesOff ()
 Turn on/off the use of alpha bitplanes. More...
 
virtual void SetPointSmoothing (vtkTypeBool)
 Turn on/off point smoothing. More...
 
virtual vtkTypeBool GetPointSmoothing ()
 Turn on/off point smoothing. More...
 
virtual void PointSmoothingOn ()
 Turn on/off point smoothing. More...
 
virtual void PointSmoothingOff ()
 Turn on/off point smoothing. More...
 
virtual void SetLineSmoothing (vtkTypeBool)
 Turn on/off line smoothing. More...
 
virtual vtkTypeBool GetLineSmoothing ()
 Turn on/off line smoothing. More...
 
virtual void LineSmoothingOn ()
 Turn on/off line smoothing. More...
 
virtual void LineSmoothingOff ()
 Turn on/off line smoothing. More...
 
virtual void SetPolygonSmoothing (vtkTypeBool)
 Turn on/off polygon smoothing. More...
 
virtual vtkTypeBool GetPolygonSmoothing ()
 Turn on/off polygon smoothing. More...
 
virtual void PolygonSmoothingOn ()
 Turn on/off polygon smoothing. More...
 
virtual void PolygonSmoothingOff ()
 Turn on/off polygon smoothing. More...
 
virtual int GetStereoType ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoType (int)
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToCrystalEyes ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToRedBlue ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToInterlaced ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToLeft ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToRight ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToDresden ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToAnaglyph ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToCheckerboard ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToSplitViewportHorizontal ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToFake ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToEmulate ()
 Set/Get what type of stereo rendering to use. More...
 
virtual void SetAnaglyphColorSaturation (float)
 Set/get the anaglyph color saturation factor. More...
 
virtual float GetAnaglyphColorSaturation ()
 Set/get the anaglyph color saturation factor. More...
 
virtual void SetAnaglyphColorMask (int, int)
 Set/get the anaglyph color mask values. More...
 
void SetAnaglyphColorMask (int[2])
 Set/get the anaglyph color mask values. More...
 
virtual intGetAnaglyphColorMask ()
 Set/get the anaglyph color mask values. More...
 
virtual void GetAnaglyphColorMask (int data[2])
 Set/get the anaglyph color mask values. More...
 
virtual void SetSwapBuffers (vtkTypeBool)
 Turn on/off buffer swapping between images. More...
 
virtual vtkTypeBool GetSwapBuffers ()
 Turn on/off buffer swapping between images. More...
 
virtual void SwapBuffersOn ()
 Turn on/off buffer swapping between images. More...
 
virtual void SwapBuffersOff ()
 Turn on/off buffer swapping between images. More...
 
float GetZbufferDataAtPoint (int x, int y)
 Set/Get the zbuffer data from the frame buffer. More...
 
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)
 This is a flag that can be set to interrupt a rendering that is in progress. More...
 
virtual int GetInAbortCheck ()
 This is a flag that can be set to interrupt a rendering that is in progress. More...
 
virtual void SetInAbortCheck (int)
 This is a flag that can be set to interrupt a rendering that is in progress. More...
 
virtual int CheckAbortStatus ()
 This is a flag that can be set to interrupt a rendering that is in progress. More...
 
vtkTypeBool GetIsPicking ()
 
void SetIsPicking (vtkTypeBool)
 
void IsPickingOn ()
 
void IsPickingOff ()
 
virtual void SetDesiredUpdateRate (double)
 Set/Get the desired update rate. More...
 
virtual double GetDesiredUpdateRate ()
 Set/Get the desired update rate. More...
 
virtual int GetNumberOfLayers ()
 Get the number of layers for renderers. More...
 
virtual void SetNumberOfLayers (int)
 Get the number of layers for renderers. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 Get the interactor associated with this render window. More...
 
void SetDisplayId (void *) override=0
 Dummy stubs for vtkWindow API. More...
 
void SetWindowId (void *) override=0
 Dummy stubs for vtkWindow API. More...
 
virtual void SetNextWindowId (void *)=0
 Dummy stubs for vtkWindow API. More...
 
void SetParentId (void *) override=0
 Dummy stubs for vtkWindow API. More...
 
void * GetGenericDisplayId () override=0
 Dummy stubs for vtkWindow API. More...
 
void * GetGenericWindowId () override=0
 Dummy stubs for vtkWindow API. More...
 
void * GetGenericParentId () override=0
 Dummy stubs for vtkWindow API. More...
 
void * GetGenericContext () override=0
 Dummy stubs for vtkWindow API. More...
 
void * GetGenericDrawable () override=0
 Dummy stubs for vtkWindow API. More...
 
void SetWindowInfo (const char *) override=0
 Dummy stubs for vtkWindow API. More...
 
virtual void SetNextWindowInfo (const char *)=0
 Dummy stubs for vtkWindow API. More...
 
void SetParentInfo (const char *) override=0
 Dummy stubs for vtkWindow API. More...
 
virtual void SetSharedRenderWindow (vtkRenderWindow *)
 Set/Get an already existing window that this window should share data with if possible. More...
 
virtual vtkRenderWindowGetSharedRenderWindow ()
 Set/Get an already existing window that this window should share data with if possible. More...
 
virtual bool GetPlatformSupportsRenderWindowSharing ()
 Set/Get an already existing window that this window should share data with if possible. More...
 
virtual void SetMultiSamples (int)
 Set / Get the number of multisamples to use for hardware antialiasing. More...
 
virtual int GetMultiSamples ()
 Set / Get the number of multisamples to use for hardware antialiasing. More...
 
virtual void SetStencilCapable (vtkTypeBool)
 Set / Get the availability of the stencil buffer. More...
 
virtual vtkTypeBool GetStencilCapable ()
 Set / Get the availability of the stencil buffer. More...
 
virtual void StencilCapableOn ()
 Set / Get the availability of the stencil buffer. More...
 
virtual void StencilCapableOff ()
 Set / Get the availability of the stencil buffer. More...
 
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 ()
 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 bool GetUseSRGBColorSpace ()
 Set/Get if we want this window to use the sRGB color space. More...
 
virtual void SetUseSRGBColorSpace (bool)
 Set/Get if we want this window to use the sRGB color space. More...
 
virtual void UseSRGBColorSpaceOn ()
 Set/Get if we want this window to use the sRGB color space. More...
 
virtual void UseSRGBColorSpaceOff ()
 Set/Get if we want this window to use the sRGB color space. More...
 
const char * GetStereoTypeAsString ()
 Returns the stereo type as a string. More...
 
- Public Member Functions inherited from vtkWindow
vtkWindowNewInstance () const
 
intGetActualSize ()
 GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale. More...
 
virtual intGetScreenSize ()=0
 Get the current size of the screen in pixels. More...
 
virtual bool DetectDPI ()
 Attempt to detect and set the DPI of the display device by querying the system. More...
 
vtkTypeBool GetOffScreenRendering ()
 Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead. More...
 
virtual intGetPosition ()
 Set/Get the position in screen coordinates of the rendering window. More...
 
virtual void SetPosition (int, int)
 Set/Get the position in screen coordinates of the rendering window. More...
 
virtual void SetPosition (int a[2])
 Set/Get the position in screen coordinates of the rendering window. More...
 
virtual intGetSize ()
 Set/Get the size of the window in screen coordinates in pixels. 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 SetShowWindow (bool)
 Show or not Show the window. More...
 
virtual void ShowWindowOn ()
 Show or not Show the window. More...
 
virtual void ShowWindowOff ()
 Show or not Show the window. More...
 
virtual void SetUseOffScreenBuffers (bool)
 Render to an offscreen destination such as a framebuffer. More...
 
virtual bool GetUseOffScreenBuffers ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void UseOffScreenBuffersOn ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void UseOffScreenBuffersOff ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void SetErase (vtkTypeBool)
 Turn on/off erasing the screen between images. More...
 
virtual vtkTypeBool GetErase ()
 Turn on/off erasing the screen between images. More...
 
virtual void EraseOn ()
 Turn on/off erasing the screen between images. More...
 
virtual void EraseOff ()
 Turn on/off erasing the screen between images. More...
 
virtual void SetDoubleBuffer (vtkTypeBool)
 Keep track of whether double buffering is on or off. More...
 
virtual vtkTypeBool GetDoubleBuffer ()
 Keep track of whether double buffering is on or off. More...
 
virtual void DoubleBufferOn ()
 Keep track of whether double buffering is on or off. More...
 
virtual void DoubleBufferOff ()
 Keep track of whether double buffering is on or off. More...
 
virtual char * GetWindowName ()
 Get name of rendering window. More...
 
virtual void SetWindowName (const char *)
 Get name of rendering window. 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)
 Return a best estimate to the dots per inch of the display device being rendered (or printed). More...
 
void SetOffScreenRendering (vtkTypeBool val)
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOn ()
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOff ()
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. 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])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual intGetTileScale ()
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void GetTileScale (int &, int &)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void GetTileScale (int[2])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
void SetTileScale (int s)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
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. More...
 
virtual void SetTileViewport (double[4])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual doubleGetTileViewport ()
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
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. More...
 
virtual void GetTileViewport (double[4])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
- 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...
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

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 ()
 Set/Get the maximum number of multisamples. More...
 
- 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)
 Returns the stereo type as a string. More...
 
- 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Public Attributes

std::set< vtkGenericOpenGLResourceFreeCallback * > Resources
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkOpenGLRenderWindow ()
 
 ~vtkOpenGLRenderWindow () override
 
void InitializeTextureInternalFormats ()
 
virtual int ReadPixels (const vtkRecti &rect, int front, int glFormat, int glType, void *data, int right=0)
 
int CreateOffScreenFramebuffer (int width, int height)
 Create the offScreen framebuffer Return if the creation was successful or not. More...
 
virtual void CreateAWindow ()=0
 Create a not-off-screen window. More...
 
virtual void DestroyWindow ()=0
 Destroy a not-off-screen window. More...
 
virtual void ReleaseGraphicsResources (vtkRenderWindow *)
 Free up any graphics resources associated with this window a value of NULL means the context may already be destroyed. More...
 
void SetTextureUnitManager (vtkTextureUnitManager *textureUnitManager)
 Set the texture unit manager. 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkOpenGLShaderCacheShaderCache
 
vtkOpenGLVertexBufferObjectCacheVBOCache
 
bool OpenGLSupportTested
 
int OpenGLSupportResult
 
std::string OpenGLSupportMessage
 
int TextureInternalFormats [VTK_UNICODE_STRING][3][5]
 
std::map< const vtkTextureObject *, intTextureResourceIds
 
vtkOpenGLFramebufferObjectOffScreenFramebuffer
 
bool OffScreenFramebufferBound
 
std::map< std::string, intGLStateIntegers
 
unsigned int BackLeftBuffer
 
unsigned int BackRightBuffer
 
unsigned int FrontLeftBuffer
 
unsigned int FrontRightBuffer
 
unsigned int FrontBuffer
 
unsigned int BackBuffer
 
unsigned int DefaultFrameBufferId
 
int OwnContext
 Flag telling if the context has been created here or was inherited. More...
 
vtkTimeStamp ContextCreationTime
 
vtkTextureUnitManagerTextureUnitManager
 
vtkTextureObjectDrawPixelsTextureObject
 
bool Initialized
 
bool GlewInitValid
 
float MaximumHardwareLineWidth
 
char * Capabilities
 
vtkOpenGLBufferObjectTQuad2DVBO
 
vtkTextureObjectNoiseTextureObject
 
- 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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

OpenGL rendering window.

vtkOpenGLRenderWindow 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.

Tests:
vtkOpenGLRenderWindow (Tests)

Definition at line 54 of file vtkOpenGLRenderWindow.h.

Member Typedef Documentation

Definition at line 57 of file vtkOpenGLRenderWindow.h.

Constructor & Destructor Documentation

vtkOpenGLRenderWindow::vtkOpenGLRenderWindow ( )
protected
vtkOpenGLRenderWindow::~vtkOpenGLRenderWindow ( )
overrideprotected

Member Function Documentation

static vtkTypeBool vtkOpenGLRenderWindow::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkOpenGLRenderWindow::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 vtkRenderWindow.

Reimplemented in vtkOpenVRRenderWindow, vtkCocoaRenderWindow, vtkExternalOpenGLRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

static vtkOpenGLRenderWindow* vtkOpenGLRenderWindow::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkOpenGLRenderWindow::NewInstanceInternal ( ) const
protectedvirtual
vtkOpenGLRenderWindow* vtkOpenGLRenderWindow::NewInstance ( ) const
void vtkOpenGLRenderWindow::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.

Reimplemented in vtkOpenVRRenderWindow, vtkOSOpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

void vtkOpenGLRenderWindow::Start ( void  )
overridevirtual

Begin the rendering process.

Implements vtkRenderWindow.

Reimplemented in vtkOpenVRRenderWindow, and vtkXOpenGLRenderWindow.

const char* vtkOpenGLRenderWindow::GetRenderingBackend ( )
overridevirtual

What rendering backend has the user requested.

Reimplemented from vtkRenderWindow.

static void vtkOpenGLRenderWindow::SetGlobalMaximumNumberOfMultiSamples ( int  val)
static

Set/Get the maximum number of multisamples.

static int vtkOpenGLRenderWindow::GetGlobalMaximumNumberOfMultiSamples ( )
static

Set/Get the maximum number of multisamples.

unsigned char* vtkOpenGLRenderWindow::GetPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
int  right 
)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBRGB...

Implements vtkWindow.

int vtkOpenGLRenderWindow::GetPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
vtkUnsignedCharArray data,
int  right 
)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBRGB...

Implements vtkWindow.

int vtkOpenGLRenderWindow::SetPixelData ( int  x,
int  y,
int  x2,
int  y2,
unsigned char *  data,
int  front,
int  right 
)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBRGB...

Implements vtkRenderWindow.

int vtkOpenGLRenderWindow::SetPixelData ( int  x,
int  y,
int  x2,
int  y2,
vtkUnsignedCharArray data,
int  front,
int  right 
)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBRGB...

Implements vtkRenderWindow.

float* vtkOpenGLRenderWindow::GetRGBAPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
int  right = 0 
)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBARGBA...

Implements vtkRenderWindow.

int vtkOpenGLRenderWindow::GetRGBAPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
vtkFloatArray data,
int  right = 0 
)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBARGBA...

Implements vtkRenderWindow.

int vtkOpenGLRenderWindow::SetRGBAPixelData ( int  x,
int  y,
int  x2,
int  y2,
float data,
int  front,
int  blend = 0,
int  right = 0 
)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBARGBA...

Implements vtkRenderWindow.

int vtkOpenGLRenderWindow::SetRGBAPixelData ( int  x,
int  y,
int  x2,
int  y2,
vtkFloatArray data,
int  front,
int  blend = 0,
int  right = 0 
)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBARGBA...

Implements vtkRenderWindow.

void vtkOpenGLRenderWindow::ReleaseRGBAPixelData ( float data)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBARGBA...

Implements vtkRenderWindow.

unsigned char* vtkOpenGLRenderWindow::GetRGBACharPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
int  right = 0 
)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBARGBA...

Implements vtkRenderWindow.

int vtkOpenGLRenderWindow::GetRGBACharPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
vtkUnsignedCharArray data,
int  right = 0 
)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBARGBA...

Implements vtkRenderWindow.

int vtkOpenGLRenderWindow::SetRGBACharPixelData ( int  x,
int  y,
int  x2,
int  y2,
unsigned char *  data,
int  front,
int  blend = 0,
int  right = 0 
)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBARGBA...

Implements vtkRenderWindow.

int vtkOpenGLRenderWindow::SetRGBACharPixelData ( int  x,
int  y,
int  x2,
int  y2,
vtkUnsignedCharArray data,
int  front,
int  blend = 0,
int  right = 0 
)
overridevirtual

Set/Get the pixel data of an image, transmitted as RGBARGBA...

Implements vtkRenderWindow.

float* vtkOpenGLRenderWindow::GetZbufferData ( int  x1,
int  y1,
int  x2,
int  y2 
)
overridevirtual

Set/Get the zbuffer data from an image.

Implements vtkRenderWindow.

int vtkOpenGLRenderWindow::GetZbufferData ( int  x1,
int  y1,
int  x2,
int  y2,
float z 
)
overridevirtual

Set/Get the zbuffer data from an image.

Implements vtkRenderWindow.

int vtkOpenGLRenderWindow::GetZbufferData ( int  x1,
int  y1,
int  x2,
int  y2,
vtkFloatArray z 
)
overridevirtual

Set/Get the zbuffer data from an image.

Implements vtkRenderWindow.

int vtkOpenGLRenderWindow::SetZbufferData ( int  x1,
int  y1,
int  x2,
int  y2,
float buffer 
)
overridevirtual

Set/Get the zbuffer data from an image.

Implements vtkRenderWindow.

int vtkOpenGLRenderWindow::SetZbufferData ( int  x1,
int  y1,
int  x2,
int  y2,
vtkFloatArray buffer 
)
overridevirtual

Set/Get the zbuffer data from an image.

Implements vtkRenderWindow.

void vtkOpenGLRenderWindow::ActivateTexture ( vtkTextureObject )

Activate a texture unit for this texture.

void vtkOpenGLRenderWindow::DeactivateTexture ( vtkTextureObject )

Deactivate a previously activated texture.

int vtkOpenGLRenderWindow::GetTextureUnitForTexture ( vtkTextureObject )

Get the texture unit for a given texture object.

int vtkOpenGLRenderWindow::GetDepthBufferSize ( )
overridevirtual

Get the size of the depth buffer.

Implements vtkRenderWindow.

bool vtkOpenGLRenderWindow::GetUsingSRGBColorSpace ( )

Is this window/fo in sRGB colorspace.

int vtkOpenGLRenderWindow::GetColorBufferSizes ( int rgba)
overridevirtual

Get the size of the color buffer.

Returns 0 if not able to determine otherwise sets R G B and A into buffer.

Implements vtkRenderWindow.

int vtkOpenGLRenderWindow::GetColorBufferInternalFormat ( int  attachmentPoint)

Get the internal format of current attached texture or render buffer.

attachmentPoint is the index of attachment. Returns 0 if not able to determine.

void vtkOpenGLRenderWindow::SetSize ( int  a[2])
overridevirtual

Set the size of the window in screen coordinates in pixels.

Reimplemented from vtkWindow.

Reimplemented in vtkOpenVRRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, and vtkOSOpenGLRenderWindow.

void vtkOpenGLRenderWindow::SetSize ( int  ,
int   
)
overridevirtual

Set the size of the window in screen coordinates in pixels.

Reimplemented from vtkWindow.

Reimplemented in vtkOpenVRRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, and vtkOSOpenGLRenderWindow.

virtual void vtkOpenGLRenderWindow::OpenGLInit ( )
virtual

Initialize OpenGL for this window.

virtual void vtkOpenGLRenderWindow::OpenGLInitState ( )
virtual
virtual void vtkOpenGLRenderWindow::OpenGLInitContext ( )
virtual
void vtkOpenGLRenderWindow::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

unsigned int vtkOpenGLRenderWindow::GetBackLeftBuffer ( )

Return the OpenGL name of the back left buffer.

It is GL_BACK_LEFT if GL is bound to the window-system-provided framebuffer. It is vtkgl::COLOR_ATTACHMENT0_EXT if GL is bound to an application-created framebuffer object (GPU-based offscreen rendering) It is used by vtkOpenGLCamera.

unsigned int vtkOpenGLRenderWindow::GetBackRightBuffer ( )

Return the OpenGL name of the back right buffer.

It is GL_BACK_RIGHT if GL is bound to the window-system-provided framebuffer. It is vtkgl::COLOR_ATTACHMENT0_EXT+1 if GL is bound to an application-created framebuffer object (GPU-based offscreen rendering) It is used by vtkOpenGLCamera.

unsigned int vtkOpenGLRenderWindow::GetFrontLeftBuffer ( )

Return the OpenGL name of the front left buffer.

It is GL_FRONT_LEFT if GL is bound to the window-system-provided framebuffer. It is vtkgl::COLOR_ATTACHMENT0_EXT if GL is bound to an application-created framebuffer object (GPU-based offscreen rendering) It is used by vtkOpenGLCamera.

unsigned int vtkOpenGLRenderWindow::GetFrontRightBuffer ( )

Return the OpenGL name of the front right buffer.

It is GL_FRONT_RIGHT if GL is bound to the window-system-provided framebuffer. It is vtkgl::COLOR_ATTACHMENT0_EXT+1 if GL is bound to an application-created framebuffer object (GPU-based offscreen rendering) It is used by vtkOpenGLCamera.

unsigned int vtkOpenGLRenderWindow::GetBackBuffer ( )

Return the OpenGL name of the back left buffer.

It is GL_BACK if GL is bound to the window-system-provided framebuffer. It is vtkgl::COLOR_ATTACHMENT0_EXT if GL is bound to an application-created framebuffer object (GPU-based offscreen rendering) It is used by vtkOpenGLCamera.

unsigned int vtkOpenGLRenderWindow::GetFrontBuffer ( )

Return the OpenGL name of the front left buffer.

It is GL_FRONT if GL is bound to the window-system-provided framebuffer. It is vtkgl::COLOR_ATTACHMENT0_EXT if GL is bound to an application-created framebuffer object (GPU-based offscreen rendering) It is used by vtkOpenGLCamera.

virtual vtkMTimeType vtkOpenGLRenderWindow::GetContextCreationTime ( )
virtual

Get the time when the OpenGL context was created.

virtual vtkOpenGLShaderCache* vtkOpenGLRenderWindow::GetShaderCache ( )
virtual

Returns an Shader Cache object.

virtual vtkOpenGLVertexBufferObjectCache* vtkOpenGLRenderWindow::GetVBOCache ( )
virtual

Returns an Shader Cache object.

virtual vtkOpenGLFramebufferObject* vtkOpenGLRenderWindow::GetOffScreenFramebuffer ( )
virtual

Returns the offscreen framebuffer object if any.

vtkTextureUnitManager* vtkOpenGLRenderWindow::GetTextureUnitManager ( )

Returns its texture unit manager object.

A new one will be created if one hasn't already been set up.

void vtkOpenGLRenderWindow::WaitForCompletion ( )
overridevirtual

Block the thread until the actual rendering is finished().

Useful for measurement only.

Implements vtkRenderWindow.

virtual void vtkOpenGLRenderWindow::DrawPixels ( int  x1,
int  y1,
int  x2,
int  y2,
int  numComponents,
int  dataType,
void *  data 
)
virtual

Replacement for the old glDrawPixels function.

virtual void vtkOpenGLRenderWindow::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 
)
virtual

Replacement for the old glDrawPixels function, but it allows for scaling the data and using only part of the texture.

virtual void vtkOpenGLRenderWindow::DrawPixels ( int  srcWidth,
int  srcHeight,
int  numComponents,
int  dataType,
void *  data 
)
virtual

Replacement for the old glDrawPixels function.

This simple version draws all the data to the entire current viewport scaling as needed.

virtual float vtkOpenGLRenderWindow::GetMaximumHardwareLineWidth ( )
inlinevirtual

Return the largest line width supported by the hardware.

Reimplemented in vtkGenericOpenGLRenderWindow.

Definition at line 314 of file vtkOpenGLRenderWindow.h.

virtual bool vtkOpenGLRenderWindow::IsPointSpriteBugPresent ( )
inlinevirtual

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 in vtkEGLRenderWindow.

Definition at line 323 of file vtkOpenGLRenderWindow.h.

int vtkOpenGLRenderWindow::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 vtkOpenGLRenderWindow::GetOpenGLSupportMessage ( )
inline

Return a message profiding additional details about the results of calling SupportsOpenGL() This can be used to retrieve more specifics about what failed.

Definition at line 342 of file vtkOpenGLRenderWindow.h.

int vtkOpenGLRenderWindow::SupportsOpenGL ( )
overridevirtual

Does this render window support OpenGL? 0-false, 1-true.

Reimplemented from vtkRenderWindow.

Reimplemented in vtkOpenVRRenderWindow, and vtkOSOpenGLRenderWindow.

const char* vtkOpenGLRenderWindow::ReportCapabilities ( )
overridevirtual

Get report of capabilities for the render window.

Reimplemented from vtkRenderWindow.

Reimplemented in vtkOpenVRRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkOSOpenGLRenderWindow.

virtual void vtkOpenGLRenderWindow::Initialize ( void   )
inlinevirtual

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 in vtkOpenVRRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, vtkXOpenGLRenderWindow, vtkOSOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 363 of file vtkOpenGLRenderWindow.h.

void vtkOpenGLRenderWindow::RegisterGraphicsResources ( vtkGenericOpenGLResourceFreeCallback cb)
inline

Definition at line 367 of file vtkOpenGLRenderWindow.h.

void vtkOpenGLRenderWindow::UnregisterGraphicsResources ( vtkGenericOpenGLResourceFreeCallback cb)
inline

Definition at line 376 of file vtkOpenGLRenderWindow.h.

virtual void vtkOpenGLRenderWindow::PushContext ( )
inlinevirtual

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. The default implementation here is only meant as a backup for subclasses that lack a proper implementation.

Reimplemented in vtkCocoaRenderWindow, vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 394 of file vtkOpenGLRenderWindow.h.

virtual void vtkOpenGLRenderWindow::PopContext ( )
inlinevirtual
bool vtkOpenGLRenderWindow::InitializeFromCurrentContext ( )
overridevirtual

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

Reimplemented from vtkRenderWindow.

Reimplemented in vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

virtual unsigned int vtkOpenGLRenderWindow::GetDefaultFrameBufferId ( )
virtual

Returns the id for the frame buffer object, if any, used by the render window in which the window does all its rendering.

This may be 0, in which case the render window is rendering to the default OpenGL render buffers.

Returns
the name (or id) of the frame buffer object to render to.
virtual bool vtkOpenGLRenderWindow::SetSwapControl ( int  )
inlinevirtual

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 in vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 421 of file vtkOpenGLRenderWindow.h.

virtual vtkOpenGLState* vtkOpenGLRenderWindow::GetState ( )
inlinevirtual

Reimplemented in vtkOpenVRRenderWindow.

Definition at line 425 of file vtkOpenGLRenderWindow.h.

vtkOpenGLBufferObject* vtkOpenGLRenderWindow::GetTQuad2DVBO ( )
int vtkOpenGLRenderWindow::GetNoiseTextureUnit ( )
void vtkOpenGLRenderWindow::StereoUpdate ( )
overridevirtual

Update the system, if needed, due to stereo rendering.

For some stereo methods, subclasses might need to switch some hardware settings here.

Reimplemented from vtkRenderWindow.

Reimplemented in vtkOpenVRRenderWindow.

void vtkOpenGLRenderWindow::StereoMidpoint ( )
overridevirtual

Intermediate method performs operations required between the rendering of the left and right eye.

Reimplemented from vtkRenderWindow.

Reimplemented in vtkOpenVRRenderWindow.

void vtkOpenGLRenderWindow::Render ( )
overridevirtual

Handle opengl specific code and calls superclass.

Reimplemented from vtkRenderWindow.

Reimplemented in vtkOpenVRRenderWindow, and vtkXOpenGLRenderWindow.

bool vtkOpenGLRenderWindow::GetCurrentBufferNeedsResolving ( )
void vtkOpenGLRenderWindow::InitializeTextureInternalFormats ( )
protected
virtual int vtkOpenGLRenderWindow::ReadPixels ( const vtkRecti rect,
int  front,
int  glFormat,
int  glType,
void *  data,
int  right = 0 
)
protectedvirtual
int vtkOpenGLRenderWindow::CreateOffScreenFramebuffer ( int  width,
int  height 
)
protected

Create the offScreen framebuffer Return if the creation was successful or not.

Precondition
positive_width: width>0
positive_height: height>0
not_initialized: !OffScreenUseFrameBuffer
Postcondition
valid_result: (result==0 || result==1)
virtual void vtkOpenGLRenderWindow::CreateAWindow ( )
protectedpure virtual
virtual void vtkOpenGLRenderWindow::DestroyWindow ( )
protectedpure virtual
virtual void vtkOpenGLRenderWindow::ReleaseGraphicsResources ( vtkRenderWindow )
protectedvirtual

Free up any graphics resources associated with this window a value of NULL means the context may already be destroyed.

Reimplemented in vtkOpenVRRenderWindow.

void vtkOpenGLRenderWindow::SetTextureUnitManager ( vtkTextureUnitManager textureUnitManager)
protected

Set the texture unit manager.

void vtkOpenGLRenderWindow::SaveGLState ( )
protected

Query and save OpenGL state.

void vtkOpenGLRenderWindow::RestoreGLState ( )
protected

Restore OpenGL state at end of the rendering.

Member Data Documentation

std::set<vtkGenericOpenGLResourceFreeCallback *> vtkOpenGLRenderWindow::Resources

Definition at line 363 of file vtkOpenGLRenderWindow.h.

vtkOpenGLShaderCache* vtkOpenGLRenderWindow::ShaderCache
protected

Definition at line 463 of file vtkOpenGLRenderWindow.h.

vtkOpenGLVertexBufferObjectCache* vtkOpenGLRenderWindow::VBOCache
protected

Definition at line 464 of file vtkOpenGLRenderWindow.h.

bool vtkOpenGLRenderWindow::OpenGLSupportTested
protected

Definition at line 468 of file vtkOpenGLRenderWindow.h.

int vtkOpenGLRenderWindow::OpenGLSupportResult
protected

Definition at line 469 of file vtkOpenGLRenderWindow.h.

std::string vtkOpenGLRenderWindow::OpenGLSupportMessage
protected

Definition at line 470 of file vtkOpenGLRenderWindow.h.

int vtkOpenGLRenderWindow::TextureInternalFormats[VTK_UNICODE_STRING][3][5]
protected

Definition at line 472 of file vtkOpenGLRenderWindow.h.

std::map<const vtkTextureObject *, int> vtkOpenGLRenderWindow::TextureResourceIds
protected

Definition at line 475 of file vtkOpenGLRenderWindow.h.

vtkOpenGLFramebufferObject* vtkOpenGLRenderWindow::OffScreenFramebuffer
protected

Definition at line 488 of file vtkOpenGLRenderWindow.h.

bool vtkOpenGLRenderWindow::OffScreenFramebufferBound
protected

Definition at line 489 of file vtkOpenGLRenderWindow.h.

std::map<std::string, int> vtkOpenGLRenderWindow::GLStateIntegers
protected

Definition at line 523 of file vtkOpenGLRenderWindow.h.

unsigned int vtkOpenGLRenderWindow::BackLeftBuffer
protected

Definition at line 525 of file vtkOpenGLRenderWindow.h.

unsigned int vtkOpenGLRenderWindow::BackRightBuffer
protected

Definition at line 526 of file vtkOpenGLRenderWindow.h.

unsigned int vtkOpenGLRenderWindow::FrontLeftBuffer
protected

Definition at line 527 of file vtkOpenGLRenderWindow.h.

unsigned int vtkOpenGLRenderWindow::FrontRightBuffer
protected

Definition at line 528 of file vtkOpenGLRenderWindow.h.

unsigned int vtkOpenGLRenderWindow::FrontBuffer
protected

Definition at line 529 of file vtkOpenGLRenderWindow.h.

unsigned int vtkOpenGLRenderWindow::BackBuffer
protected

Definition at line 530 of file vtkOpenGLRenderWindow.h.

unsigned int vtkOpenGLRenderWindow::DefaultFrameBufferId
protected

Definition at line 531 of file vtkOpenGLRenderWindow.h.

int vtkOpenGLRenderWindow::OwnContext
protected

Flag telling if the context has been created here or was inherited.

Definition at line 536 of file vtkOpenGLRenderWindow.h.

vtkTimeStamp vtkOpenGLRenderWindow::ContextCreationTime
protected

Definition at line 538 of file vtkOpenGLRenderWindow.h.

vtkTextureUnitManager* vtkOpenGLRenderWindow::TextureUnitManager
protected

Definition at line 540 of file vtkOpenGLRenderWindow.h.

vtkTextureObject* vtkOpenGLRenderWindow::DrawPixelsTextureObject
protected

Definition at line 542 of file vtkOpenGLRenderWindow.h.

bool vtkOpenGLRenderWindow::Initialized
protected

Definition at line 544 of file vtkOpenGLRenderWindow.h.

bool vtkOpenGLRenderWindow::GlewInitValid
protected

Definition at line 545 of file vtkOpenGLRenderWindow.h.

float vtkOpenGLRenderWindow::MaximumHardwareLineWidth
protected

Definition at line 547 of file vtkOpenGLRenderWindow.h.

char* vtkOpenGLRenderWindow::Capabilities
protected

Definition at line 549 of file vtkOpenGLRenderWindow.h.

vtkOpenGLBufferObject* vtkOpenGLRenderWindow::TQuad2DVBO
protected

Definition at line 552 of file vtkOpenGLRenderWindow.h.

vtkTextureObject* vtkOpenGLRenderWindow::NoiseTextureObject
protected

Definition at line 555 of file vtkOpenGLRenderWindow.h.


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