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

platform independent render window More...

#include <vtkGenericOpenGLRenderWindow.h>

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

Public Types

typedef vtkOpenGLRenderWindow Superclass
 
- Public Types inherited from vtkOpenGLRenderWindow
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...
 
vtkGenericOpenGLRenderWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Finalize () override
 Cleans up graphics resources allocated in the context for this VTK scene. More...
 
void Frame () override
 flush the pending drawing operations Class user may to watch for WindowFrameEvent and act on it More...
 
void MakeCurrent () override
 Makes the context current. More...
 
bool IsCurrent () override
 Returns if the context is current. More...
 
int SupportsOpenGL () override
 Returns if OpenGL is supported. More...
 
int IsDirect () override
 Returns if the context is direct. More...
 
void SetFrontLeftBuffer (unsigned int)
 set the drawing buffers to use More...
 
void SetFrontRightBuffer (unsigned int)
 
void SetBackLeftBuffer (unsigned int)
 
void SetBackRightBuffer (unsigned int)
 
void SetDefaultFrameBufferId (unsigned int)
 
void SetOwnContext (int)
 
void PushState ()
 no-op (for API compat with OpenGL1). More...
 
void PopState ()
 no-op (for API compat with OpenGL1). More...
 
void SetWindowId (void *) override
 does nothing More...
 
void * GetGenericWindowId () override
 
void SetDisplayId (void *) override
 Dummy stubs for vtkWindow API. More...
 
void SetParentId (void *) override
 
void * GetGenericDisplayId () override
 
void * GetGenericParentId () override
 
void * GetGenericContext () override
 
void * GetGenericDrawable () override
 
void SetWindowInfo (const char *) override
 
void SetParentInfo (const char *) override
 
intGetScreenSize () override
 Get the current size of the screen in pixels. More...
 
void HideCursor () override
 Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead. More...
 
void ShowCursor () override
 
void SetFullScreen (vtkTypeBool) override
 Turn on/off rendering full screen window size. More...
 
void WindowRemap () override
 Remap the rendering window. More...
 
int GetEventPending () override
 Check to see if a mouse button has been pressed. More...
 
void SetNextWindowId (void *) override
 
void SetNextWindowInfo (const char *) override
 
void CreateAWindow () override
 Create a not-off-screen window. More...
 
void DestroyWindow () override
 Destroy a not-off-screen window. More...
 
void SetIsDirect (int newValue)
 Allow to update state within observer callback without changing data argument and MTime. More...
 
void SetSupportsOpenGL (int newValue)
 
void SetIsCurrent (bool newValue)
 
void Render () override
 Override the Render method to do some state management. More...
 
float GetMaximumHardwareLineWidth () override
 Overridden to pass explicitly specified MaximumHardwareLineWidth, if any. More...
 
virtual void SetForceMaximumHardwareLineWidth (float)
 Specify a non-zero line width to force the hardware line width determined by the window. More...
 
virtual float GetForceMaximumHardwareLineWidth ()
 
virtual void SetReadyForRendering (bool)
 Set this to true to indicate that the context is now ready. More...
 
virtual bool GetReadyForRendering ()
 
virtual void SetScreenSize (int, int)
 Set the size of the screen in pixels. More...
 
void SetScreenSize (int[2])
 
void SetCurrentCursor (int cShape) override
 Overridden to invoke vtkCommand::CursorChangedEvent. More...
 
virtual void SetMapped (vtkTypeBool)
 
bool IsDrawable () override
 Overridden to simply call GetReadyForRendering More...
 
- Public Member Functions inherited from vtkOpenGLRenderWindow
vtkOpenGLRenderWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Start (void) override
 Begin the rendering process. More...
 
void Frame () override
 A termination method performed at the end of the rendering process to do things like swapping buffers (if necessary) or similar actions. More...
 
const char * GetRenderingBackend () override
 What rendering backend has the user requested. More...
 
unsigned char * GetPixelData (int x, int y, int x2, int y2, int front, int right) override
 Set/Get the pixel data of an image, transmitted as RGBRGB... More...
 
int GetPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right) override
 
int SetPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int right) override
 Set/Get the pixel data of an image, transmitted as RGBRGBRGB. More...
 
int SetPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int right) override
 
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
 
int SetRGBAPixelData (int x, int y, int x2, int y2, float *data, int front, int blend=0, int right=0) override
 
int SetRGBAPixelData (int x, int y, int x2, int y2, vtkFloatArray *data, int front, int blend=0, int right=0) override
 
void ReleaseRGBAPixelData (float *data) override
 
unsigned char * GetRGBACharPixelData (int x, int y, int x2, int y2, int front, int right=0) override
 
int GetRGBACharPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right=0) override
 
int SetRGBACharPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int blend=0, int right=0) override
 
int SetRGBACharPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int blend=0, int right=0) override
 
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
 
int GetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *z) override
 
int SetZbufferData (int x1, int y1, int x2, int y2, float *buffer) override
 
int SetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *buffer) override
 
void ActivateTexture (vtkTextureObject *)
 Activate a texture unit for this texture. More...
 
void DeactivateTexture (vtkTextureObject *)
 Deactivate a previously activated texture. More...
 
int GetTextureUnitForTexture (vtkTextureObject *)
 Get the texture unit for a given texture object. More...
 
int GetDepthBufferSize () override
 Get the size of the depth buffer. More...
 
bool GetUsingSRGBColorSpace ()
 Is this window/fo in sRGB colorspace. More...
 
int GetColorBufferSizes (int *rgba) override
 Get the size of the color buffer. More...
 
int GetColorBufferInternalFormat (int attachmentPoint)
 Get the internal format of current attached texture or render buffer. More...
 
void SetSize (int a[2]) override
 Set the size of the window in screen coordinates in pixels. More...
 
void SetSize (int, int) override
 
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...
 
vtkOpenGLShaderCacheGetShaderCache ()
 Returns an Shader Cache object. More...
 
vtkOpenGLVertexBufferObjectCacheGetVBOCache ()
 Returns the VBO Cache. More...
 
virtual vtkOpenGLFramebufferObjectGetOffScreenFramebuffer ()
 Returns the offscreen framebuffer object if any. More...
 
void SetUseOffScreenBuffers (bool) override
 Render to an offscreen destination such as a framebuffer. 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 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 ()
 
- 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 int GetCapturingGL2PSSpecialProps ()
 Returns true if the render process is capturing text actors. More...
 
virtual void CopyResultFrame ()
 Performed at the end of the rendering process to generate image. More...
 
virtual vtkRenderWindowInteractorMakeRenderWindowInteractor ()
 Create an interactor to control renderers in this window. More...
 
virtual void SetCursorPosition (int, int)
 
virtual int GetCurrentCursor ()
 
virtual vtkTypeBool GetFullScreen ()
 
virtual void FullScreenOn ()
 
virtual void FullScreenOff ()
 
virtual void SetBorders (vtkTypeBool)
 Turn on/off window manager borders. More...
 
virtual vtkTypeBool GetBorders ()
 
virtual void BordersOn ()
 
virtual void BordersOff ()
 
virtual vtkTypeBool GetStereoCapableWindow ()
 Prescribe that the window be created in a stereo-capable mode. More...
 
virtual void StereoCapableWindowOn ()
 
virtual void StereoCapableWindowOff ()
 
virtual void SetStereoCapableWindow (vtkTypeBool capable)
 
virtual vtkTypeBool GetStereoRender ()
 Turn on/off stereo rendering. More...
 
void SetStereoRender (vtkTypeBool stereo)
 
virtual void StereoRenderOn ()
 
virtual void StereoRenderOff ()
 
virtual void SetAlphaBitPlanes (vtkTypeBool)
 Turn on/off the use of alpha bitplanes. More...
 
virtual vtkTypeBool GetAlphaBitPlanes ()
 
virtual void AlphaBitPlanesOn ()
 
virtual void AlphaBitPlanesOff ()
 
virtual void SetPointSmoothing (vtkTypeBool)
 Turn on/off point smoothing. More...
 
virtual vtkTypeBool GetPointSmoothing ()
 
virtual void PointSmoothingOn ()
 
virtual void PointSmoothingOff ()
 
virtual void SetLineSmoothing (vtkTypeBool)
 Turn on/off line smoothing. More...
 
virtual vtkTypeBool GetLineSmoothing ()
 
virtual void LineSmoothingOn ()
 
virtual void LineSmoothingOff ()
 
virtual void SetPolygonSmoothing (vtkTypeBool)
 Turn on/off polygon smoothing. More...
 
virtual vtkTypeBool GetPolygonSmoothing ()
 
virtual void PolygonSmoothingOn ()
 
virtual void PolygonSmoothingOff ()
 
virtual int GetStereoType ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoType (int)
 
void SetStereoTypeToCrystalEyes ()
 
void SetStereoTypeToRedBlue ()
 
void SetStereoTypeToInterlaced ()
 
void SetStereoTypeToLeft ()
 
void SetStereoTypeToRight ()
 
void SetStereoTypeToDresden ()
 
void SetStereoTypeToAnaglyph ()
 
void SetStereoTypeToCheckerboard ()
 
void SetStereoTypeToSplitViewportHorizontal ()
 
void SetStereoTypeToFake ()
 
void SetStereoTypeToEmulate ()
 
const char * GetStereoTypeAsString ()
 Returns the stereo type as a string. More...
 
virtual void StereoRenderComplete ()
 Handles work required once both views have been rendered when using stereo rendering. More...
 
virtual void SetAnaglyphColorSaturation (float)
 Set/get the anaglyph color saturation factor. More...
 
virtual float GetAnaglyphColorSaturation ()
 
virtual void SetAnaglyphColorMask (int, int)
 Set/get the anaglyph color mask values. More...
 
void SetAnaglyphColorMask (int[2])
 
virtual intGetAnaglyphColorMask ()
 
virtual void GetAnaglyphColorMask (int data[2])
 
virtual void SetSwapBuffers (vtkTypeBool)
 Turn on/off buffer swapping between images. More...
 
virtual vtkTypeBool GetSwapBuffers ()
 
virtual void SwapBuffersOn ()
 
virtual void SwapBuffersOff ()
 
float GetZbufferDataAtPoint (int x, int y)
 
virtual int GetNeverRendered ()
 This flag is set if the window hasn't rendered since it was created. More...
 
virtual int GetAbortRender ()
 This is a flag that can be set to interrupt a rendering that is in progress. More...
 
virtual void SetAbortRender (int)
 
virtual int GetInAbortCheck ()
 
virtual void SetInAbortCheck (int)
 
virtual int CheckAbortStatus ()
 
vtkTypeBool GetIsPicking ()
 
void SetIsPicking (vtkTypeBool)
 
void IsPickingOn ()
 
void IsPickingOff ()
 
virtual int CheckInRenderStatus ()
 Are we rendering at the moment. More...
 
virtual void ClearInRenderStatus ()
 Clear status (after an exception was thrown for example) More...
 
virtual void SetDesiredUpdateRate (double)
 Set/Get the desired update rate. More...
 
virtual double GetDesiredUpdateRate ()
 
virtual int GetNumberOfLayers ()
 Get the number of layers for renderers. More...
 
virtual void SetNumberOfLayers (int)
 
virtual vtkRenderWindowInteractorGetInteractor ()
 Get the interactor associated with this render window. More...
 
void SetInteractor (vtkRenderWindowInteractor *)
 Set the interactor to the render window. More...
 
void UnRegister (vtkObjectBase *o) override
 This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. More...
 
virtual void SetSharedRenderWindow (vtkRenderWindow *)
 Set/Get an already existing window that this window should share data with if possible. More...
 
virtual vtkRenderWindowGetSharedRenderWindow ()
 
virtual bool GetPlatformSupportsRenderWindowSharing ()
 
virtual void SetForceMakeCurrent ()
 If called, allow MakeCurrent() to skip cache-check when called. More...
 
virtual void SetMultiSamples (int)
 Set / Get the number of multisamples to use for hardware antialiasing. More...
 
virtual int GetMultiSamples ()
 
virtual void SetStencilCapable (vtkTypeBool)
 Set / Get the availability of the stencil buffer. More...
 
virtual vtkTypeBool GetStencilCapable ()
 
virtual void StencilCapableOn ()
 
virtual void StencilCapableOff ()
 
virtual void SetDeviceIndex (int)
 If there are several graphics card installed on a system, this index can be used to specify which card you want to render to. More...
 
virtual int GetDeviceIndex ()
 
virtual int GetNumberOfDevices ()
 Returns the number of devices (graphics cards) on a system. More...
 
virtual bool GetUseSRGBColorSpace ()
 Set/Get if we want this window to use the sRGB color space. More...
 
virtual void SetUseSRGBColorSpace (bool)
 
virtual void UseSRGBColorSpaceOn ()
 
virtual void UseSRGBColorSpaceOff ()
 
- Public Member Functions inherited from vtkWindow
vtkWindowNewInstance () const
 
virtual intGetPosition ()
 Set/Get the position in screen coordinates of the rendering window. More...
 
virtual void SetPosition (int, int)
 
virtual void SetPosition (int a[2])
 
virtual intGetSize ()
 Set/Get the size of the window in screen coordinates in pixels. More...
 
intGetActualSize ()
 GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale. More...
 
virtual vtkTypeBool GetMapped ()
 Keep track of whether the rendering window has been mapped to screen. More...
 
virtual bool GetShowWindow ()
 Show or not Show the window. More...
 
virtual void SetShowWindow (bool)
 
virtual void ShowWindowOn ()
 
virtual void ShowWindowOff ()
 
virtual bool GetUseOffScreenBuffers ()
 
virtual void UseOffScreenBuffersOn ()
 
virtual void UseOffScreenBuffersOff ()
 
virtual void SetErase (vtkTypeBool)
 Turn on/off erasing the screen between images. More...
 
virtual vtkTypeBool GetErase ()
 
virtual void EraseOn ()
 
virtual void EraseOff ()
 
virtual void SetDoubleBuffer (vtkTypeBool)
 Keep track of whether double buffering is on or off. More...
 
virtual vtkTypeBool GetDoubleBuffer ()
 
virtual void DoubleBufferOn ()
 
virtual void DoubleBufferOff ()
 
virtual char * GetWindowName ()
 Get name of rendering window. More...
 
virtual void SetWindowName (const char *)
 
virtual int GetDPI ()
 Return a best estimate to the dots per inch of the display device being rendered (or printed). More...
 
virtual void SetDPI (int)
 
virtual bool DetectDPI ()
 Attempt to detect and set the DPI of the display device by querying the system. More...
 
void SetOffScreenRendering (vtkTypeBool val)
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOn ()
 
virtual void OffScreenRenderingOff ()
 
vtkTypeBool GetOffScreenRendering ()
 Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead. More...
 
virtual void SetTileScale (int, int)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
void SetTileScale (int[2])
 
virtual intGetTileScale ()
 
virtual void GetTileScale (int &, int &)
 
virtual void GetTileScale (int[2])
 
void SetTileScale (int s)
 
virtual void SetTileViewport (double, double, double, double)
 
virtual void SetTileViewport (double[4])
 
virtual doubleGetTileViewport ()
 
virtual void GetTileViewport (double &, double &, double &, double &)
 
virtual void GetTileViewport (double[4])
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkGenericOpenGLRenderWindowNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGenericOpenGLRenderWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkOpenGLRenderWindow
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOpenGLRenderWindowSafeDownCast (vtkObjectBase *o)
 
static void SetGlobalMaximumNumberOfMultiSamples (int val)
 Set/Get the maximum number of multisamples. More...
 
static int GetGlobalMaximumNumberOfMultiSamples ()
 
- Static Public Member Functions inherited from vtkRenderWindow
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderWindowSafeDownCast (vtkObjectBase *o)
 
static vtkRenderWindowNew ()
 Construct an instance of vtkRenderWindow with its screen size set to 300x300, borders turned on, positioned at (0,0), double buffering turned on. More...
 
static const char * GetRenderLibrary ()
 What rendering library has the user requested. More...
 
static const char * GetStereoTypeAsString (int type)
 
- Static Public Member Functions inherited from vtkWindow
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGenericOpenGLRenderWindow ()
 
 ~vtkGenericOpenGLRenderWindow () override
 
int ReadPixels (const vtkRecti &rect, int front, int glFormat, int glType, void *data, int right) override
 Overridden to not attempt to read pixels if this->ReadyForRendering is false. More...
 
int SetRGBACharPixelData (int x1, int y1, int x2, int y2, unsigned char *data, int front, int blend, int right) override
 
int SetRGBACharPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int blend=0, int right=0) override
 
- Protected Member Functions inherited from vtkOpenGLRenderWindow
 vtkOpenGLRenderWindow ()
 
 ~vtkOpenGLRenderWindow () override
 
int CreateOffScreenFramebuffer (int width, int height)
 Create the offScreen framebuffer Return if the creation was successful or not. 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 SaveGLState ()
 Query and save OpenGL state. More...
 
void RestoreGLState ()
 Restore OpenGL state at end of the rendering. More...
 
- Protected Member Functions inherited from vtkRenderWindow
 vtkRenderWindow ()
 
 ~vtkRenderWindow () override
 
virtual void DoStereoRender ()
 
- Protected Member Functions inherited from vtkWindow
 vtkWindow ()
 
 ~vtkWindow () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

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

Additional Inherited Members

- Public Attributes inherited from vtkOpenGLRenderWindow
std::set< vtkGenericOpenGLResourceFreeCallback * > Resources
 

Detailed Description

platform independent render window

vtkGenericOpenGLRenderWindow provides a skeleton for implementing a render window using one's own OpenGL context and drawable. To be effective, one must register an observer for WindowMakeCurrentEvent, WindowIsCurrentEvent and WindowFrameEvent. When this class sends a WindowIsCurrentEvent, the call data is an bool* which one can use to return whether the context is current.

Examples:
vtkGenericOpenGLRenderWindow (Examples)
Tests:
vtkGenericOpenGLRenderWindow (Tests)

Definition at line 39 of file vtkGenericOpenGLRenderWindow.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkGenericOpenGLRenderWindow.h.

Constructor & Destructor Documentation

◆ vtkGenericOpenGLRenderWindow()

vtkGenericOpenGLRenderWindow::vtkGenericOpenGLRenderWindow ( )
protected

◆ ~vtkGenericOpenGLRenderWindow()

vtkGenericOpenGLRenderWindow::~vtkGenericOpenGLRenderWindow ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGenericOpenGLRenderWindow* vtkGenericOpenGLRenderWindow::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkGenericOpenGLRenderWindow::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.

Reimplemented in vtkExternalOpenGLRenderWindow.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGenericOpenGLRenderWindow::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkOpenGLRenderWindow.

Reimplemented in vtkExternalOpenGLRenderWindow.

◆ NewInstance()

vtkGenericOpenGLRenderWindow* vtkGenericOpenGLRenderWindow::NewInstance ( ) const

◆ PrintSelf()

void vtkGenericOpenGLRenderWindow::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.

◆ Finalize()

void vtkGenericOpenGLRenderWindow::Finalize ( )
overridevirtual

Cleans up graphics resources allocated in the context for this VTK scene.

Implements vtkRenderWindow.

◆ Frame()

void vtkGenericOpenGLRenderWindow::Frame ( )
overridevirtual

flush the pending drawing operations Class user may to watch for WindowFrameEvent and act on it

Implements vtkRenderWindow.

◆ MakeCurrent()

void vtkGenericOpenGLRenderWindow::MakeCurrent ( )
overridevirtual

Makes the context current.

It is the class user's responsibility to watch for WindowMakeCurrentEvent and set it current.

Implements vtkRenderWindow.

◆ IsCurrent()

bool vtkGenericOpenGLRenderWindow::IsCurrent ( )
overridevirtual

Returns if the context is current.

It is the class user's responsibility to watch for WindowIsCurrentEvent and set the bool* flag passed through the call data parameter.

Implements vtkRenderWindow.

◆ SupportsOpenGL()

int vtkGenericOpenGLRenderWindow::SupportsOpenGL ( )
overridevirtual

Returns if OpenGL is supported.

It is the class user's responsibility to watch for WindowSupportsOpenGLEvent and set the int* flag passed through the call data parameter.

Reimplemented from vtkRenderWindow.

◆ IsDirect()

int vtkGenericOpenGLRenderWindow::IsDirect ( )
overridevirtual

Returns if the context is direct.

It is the class user's responsibility to watch for WindowIsDirectEvent and set the int* flag passed through the call data parameter.

Reimplemented from vtkRenderWindow.

◆ SetFrontLeftBuffer()

void vtkGenericOpenGLRenderWindow::SetFrontLeftBuffer ( unsigned int  )

set the drawing buffers to use

◆ SetFrontRightBuffer()

void vtkGenericOpenGLRenderWindow::SetFrontRightBuffer ( unsigned int  )

◆ SetBackLeftBuffer()

void vtkGenericOpenGLRenderWindow::SetBackLeftBuffer ( unsigned int  )

◆ SetBackRightBuffer()

void vtkGenericOpenGLRenderWindow::SetBackRightBuffer ( unsigned int  )

◆ SetDefaultFrameBufferId()

void vtkGenericOpenGLRenderWindow::SetDefaultFrameBufferId ( unsigned int  )

◆ SetOwnContext()

void vtkGenericOpenGLRenderWindow::SetOwnContext ( int  )

◆ PushState()

void vtkGenericOpenGLRenderWindow::PushState ( )
inline

no-op (for API compat with OpenGL1).

Definition at line 90 of file vtkGenericOpenGLRenderWindow.h.

◆ PopState()

void vtkGenericOpenGLRenderWindow::PopState ( )
inline

no-op (for API compat with OpenGL1).

Definition at line 92 of file vtkGenericOpenGLRenderWindow.h.

◆ SetWindowId()

void vtkGenericOpenGLRenderWindow::SetWindowId ( void *  )
overridevirtual

does nothing

Implements vtkRenderWindow.

◆ GetGenericWindowId()

void* vtkGenericOpenGLRenderWindow::GetGenericWindowId ( )
overridevirtual

Implements vtkRenderWindow.

◆ SetDisplayId()

void vtkGenericOpenGLRenderWindow::SetDisplayId ( void *  )
overridevirtual

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

◆ SetParentId()

void vtkGenericOpenGLRenderWindow::SetParentId ( void *  )
overridevirtual

Implements vtkRenderWindow.

◆ GetGenericDisplayId()

void* vtkGenericOpenGLRenderWindow::GetGenericDisplayId ( )
overridevirtual

Implements vtkRenderWindow.

◆ GetGenericParentId()

void* vtkGenericOpenGLRenderWindow::GetGenericParentId ( )
overridevirtual

Implements vtkRenderWindow.

◆ GetGenericContext()

void* vtkGenericOpenGLRenderWindow::GetGenericContext ( )
overridevirtual

Implements vtkRenderWindow.

◆ GetGenericDrawable()

void* vtkGenericOpenGLRenderWindow::GetGenericDrawable ( )
overridevirtual

Implements vtkRenderWindow.

◆ SetWindowInfo()

void vtkGenericOpenGLRenderWindow::SetWindowInfo ( const char *  )
overridevirtual

Implements vtkRenderWindow.

◆ SetParentInfo()

void vtkGenericOpenGLRenderWindow::SetParentInfo ( const char *  )
overridevirtual

Implements vtkRenderWindow.

◆ GetScreenSize()

int* vtkGenericOpenGLRenderWindow::GetScreenSize ( )
overridevirtual

Get the current size of the screen in pixels.

Implements vtkWindow.

◆ HideCursor()

void vtkGenericOpenGLRenderWindow::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.

Set cursor position in window (note that (0,0) is the lower left corner).

Implements vtkRenderWindow.

◆ ShowCursor()

void vtkGenericOpenGLRenderWindow::ShowCursor ( )
overridevirtual

Implements vtkRenderWindow.

◆ SetFullScreen()

void vtkGenericOpenGLRenderWindow::SetFullScreen ( vtkTypeBool  )
overridevirtual

Turn on/off rendering full screen window size.

Implements vtkRenderWindow.

◆ WindowRemap()

void vtkGenericOpenGLRenderWindow::WindowRemap ( )
overridevirtual

Remap the rendering window.

This probably only works on UNIX right now. It is useful for changing properties that can't normally be changed once the window is up.

Implements vtkRenderWindow.

◆ GetEventPending()

int vtkGenericOpenGLRenderWindow::GetEventPending ( )
overridevirtual

Check to see if a mouse button has been pressed.

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

Implements vtkRenderWindow.

◆ SetNextWindowId()

void vtkGenericOpenGLRenderWindow::SetNextWindowId ( void *  )
overridevirtual

Implements vtkRenderWindow.

◆ SetNextWindowInfo()

void vtkGenericOpenGLRenderWindow::SetNextWindowInfo ( const char *  )
overridevirtual

Implements vtkRenderWindow.

◆ CreateAWindow()

void vtkGenericOpenGLRenderWindow::CreateAWindow ( )
overridevirtual

Create a not-off-screen window.

Implements vtkOpenGLRenderWindow.

◆ DestroyWindow()

void vtkGenericOpenGLRenderWindow::DestroyWindow ( )
overridevirtual

Destroy a not-off-screen window.

Implements vtkOpenGLRenderWindow.

◆ SetIsDirect()

void vtkGenericOpenGLRenderWindow::SetIsDirect ( int  newValue)

Allow to update state within observer callback without changing data argument and MTime.

◆ SetSupportsOpenGL()

void vtkGenericOpenGLRenderWindow::SetSupportsOpenGL ( int  newValue)

◆ SetIsCurrent()

void vtkGenericOpenGLRenderWindow::SetIsCurrent ( bool  newValue)

◆ Render()

void vtkGenericOpenGLRenderWindow::Render ( )
overridevirtual

Override the Render method to do some state management.

This method saves the OpenGL state before asking its child renderers to render their image. Once this is done, the OpenGL state is restored.

See also
vtkOpenGLRenderWindow::SaveGLState()
vtkOpenGLRenderWindow::RestoreGLState()

Reimplemented from vtkRenderWindow.

◆ GetMaximumHardwareLineWidth()

float vtkGenericOpenGLRenderWindow::GetMaximumHardwareLineWidth ( )
overridevirtual

Overridden to pass explicitly specified MaximumHardwareLineWidth, if any.

Reimplemented from vtkOpenGLRenderWindow.

◆ SetForceMaximumHardwareLineWidth()

virtual void vtkGenericOpenGLRenderWindow::SetForceMaximumHardwareLineWidth ( float  )
virtual

Specify a non-zero line width to force the hardware line width determined by the window.

◆ GetForceMaximumHardwareLineWidth()

virtual float vtkGenericOpenGLRenderWindow::GetForceMaximumHardwareLineWidth ( )
virtual

◆ SetReadyForRendering()

virtual void vtkGenericOpenGLRenderWindow::SetReadyForRendering ( bool  )
virtual

Set this to true to indicate that the context is now ready.

For backwards compatibility reasons, it's set to true by default. If set to false, the Render call will be skipped entirely.

◆ GetReadyForRendering()

virtual bool vtkGenericOpenGLRenderWindow::GetReadyForRendering ( )
virtual

◆ SetScreenSize() [1/2]

virtual void vtkGenericOpenGLRenderWindow::SetScreenSize ( int  ,
int   
)
virtual

Set the size of the screen in pixels.

◆ SetScreenSize() [2/2]

void vtkGenericOpenGLRenderWindow::SetScreenSize ( int  [2])

◆ SetCurrentCursor()

void vtkGenericOpenGLRenderWindow::SetCurrentCursor ( int  cShape)
overridevirtual

Overridden to invoke vtkCommand::CursorChangedEvent.

Reimplemented from vtkRenderWindow.

◆ SetMapped()

virtual void vtkGenericOpenGLRenderWindow::SetMapped ( vtkTypeBool  )
virtual

◆ IsDrawable()

bool vtkGenericOpenGLRenderWindow::IsDrawable ( )
inlineoverridevirtual

Overridden to simply call GetReadyForRendering

Reimplemented from vtkRenderWindow.

Definition at line 177 of file vtkGenericOpenGLRenderWindow.h.

◆ ReadPixels()

int vtkGenericOpenGLRenderWindow::ReadPixels ( const vtkRecti rect,
int  front,
int  glFormat,
int  glType,
void *  data,
int  right 
)
overrideprotectedvirtual

Overridden to not attempt to read pixels if this->ReadyForRendering is false.

In that case, this method will simply return VTK_ERROR. Otherwise, the superclass' implementation will be called.

Reimplemented from vtkOpenGLRenderWindow.

◆ SetRGBACharPixelData() [1/2]

int vtkGenericOpenGLRenderWindow::SetRGBACharPixelData ( int  x1,
int  y1,
int  x2,
int  y2,
unsigned char *  data,
int  front,
int  blend,
int  right 
)
overrideprotectedvirtual

Implements vtkRenderWindow.

◆ SetRGBACharPixelData() [2/2]

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

Implements vtkRenderWindow.

Member Data Documentation

◆ DirectStatus

int vtkGenericOpenGLRenderWindow::DirectStatus
protected

Definition at line 195 of file vtkGenericOpenGLRenderWindow.h.

◆ SupportsOpenGLStatus

int vtkGenericOpenGLRenderWindow::SupportsOpenGLStatus
protected

Definition at line 196 of file vtkGenericOpenGLRenderWindow.h.

◆ CurrentStatus

bool vtkGenericOpenGLRenderWindow::CurrentStatus
protected

Definition at line 197 of file vtkGenericOpenGLRenderWindow.h.

◆ ForceMaximumHardwareLineWidth

float vtkGenericOpenGLRenderWindow::ForceMaximumHardwareLineWidth
protected

Definition at line 198 of file vtkGenericOpenGLRenderWindow.h.

◆ ReadyForRendering

bool vtkGenericOpenGLRenderWindow::ReadyForRendering
protected

Definition at line 199 of file vtkGenericOpenGLRenderWindow.h.

◆ ScreenSize

int vtkGenericOpenGLRenderWindow::ScreenSize[2]
protected

Definition at line 200 of file vtkGenericOpenGLRenderWindow.h.


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