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

create a window for renderers to draw into More...

#include <vtkRenderWindow.h>

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

Public Types

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...
 
vtkRenderWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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...
 
virtual const char * GetRenderingBackend ()
 What rendering backend has the user requested. More...
 
 vtkGetNewMacro (RenderTimer, vtkRenderTimerLog)
 Get the render timer log for this window. More...
 
vtkRendererCollectionGetRenderers ()
 Return the collection of renderers in the render window. More...
 
void CaptureGL2PSSpecialProps (vtkCollection *specialProps)
 The GL2PS exporter must handle certain props in a special way (e.g. More...
 
virtual int GetCapturingGL2PSSpecialProps ()
 Returns true if the render process is capturing text actors. More...
 
void Render () override
 Ask each renderer owned by this RenderWindow to render its image and synchronize this process. More...
 
virtual void Start ()=0
 Start the rendering process for a frame. More...
 
virtual void End ()
 Update the system, if needed, at end of render process. 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 WaitForCompletion ()=0
 Block the thread until the actual rendering is finished(). 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 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
 
virtual void SetCursorPosition (int, int)
 
virtual void SetCurrentCursor (int)
 Change the shape of the cursor. More...
 
virtual int GetCurrentCursor ()
 
virtual void SetFullScreen (vtkTypeBool)=0
 Turn on/off rendering full screen window size. More...
 
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 StereoUpdate ()
 Update the system, if needed, due to stereo rendering. More...
 
virtual void StereoMidpoint ()
 Intermediate method performs operations required between the rendering of the left and right eye. More...
 
virtual void StereoRenderComplete ()
 Handles work required once both views have been rendered when using stereo rendering. More...
 
virtual void SetAnaglyphColorSaturation (float)
 Set/get the anaglyph color saturation factor. More...
 
virtual float GetAnaglyphColorSaturation ()
 
virtual void SetAnaglyphColorMask (int, int)
 Set/get the anaglyph color mask values. More...
 
void SetAnaglyphColorMask (int[2])
 
virtual int * GetAnaglyphColorMask ()
 
virtual void GetAnaglyphColorMask (int data[2])
 
virtual void WindowRemap ()=0
 Remap the rendering window. More...
 
virtual void SetSwapBuffers (vtkTypeBool)
 Turn on/off buffer swapping between images. More...
 
virtual vtkTypeBool GetSwapBuffers ()
 
virtual void SwapBuffersOn ()
 
virtual void SwapBuffersOff ()
 
virtual int SetPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int right=0)=0
 Set/Get the pixel data of an image, transmitted as RGBRGBRGB. More...
 
virtual int SetPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int right=0)=0
 
virtual float * GetRGBAPixelData (int x, int y, int x2, int y2, int front, int right=0)=0
 Same as Get/SetPixelData except that the image also contains an alpha component. More...
 
virtual int GetRGBAPixelData (int x, int y, int x2, int y2, int front, vtkFloatArray *data, int right=0)=0
 
virtual int SetRGBAPixelData (int x, int y, int x2, int y2, float *, int front, int blend=0, int right=0)=0
 
virtual int SetRGBAPixelData (int, int, int, int, vtkFloatArray *, int, int blend=0, int right=0)=0
 
virtual void ReleaseRGBAPixelData (float *data)=0
 
virtual unsigned char * GetRGBACharPixelData (int x, int y, int x2, int y2, int front, int right=0)=0
 
virtual int GetRGBACharPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right=0)=0
 
virtual int SetRGBACharPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int blend=0, int right=0)=0
 
virtual int SetRGBACharPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int blend=0, int right=0)=0
 
virtual float * GetZbufferData (int x, int y, int x2, int y2)=0
 Set/Get the zbuffer data from the frame buffer. More...
 
virtual int GetZbufferData (int x, int y, int x2, int y2, float *z)=0
 
virtual int GetZbufferData (int x, int y, int x2, int y2, vtkFloatArray *z)=0
 
virtual int SetZbufferData (int x, int y, int x2, int y2, float *z)=0
 
virtual int SetZbufferData (int x, int y, int x2, int y2, vtkFloatArray *z)=0
 
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 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...
 
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...
 
void SetDisplayId (void *) override=0
 Dummy stubs for vtkWindow API. More...
 
void SetWindowId (void *) override=0
 
virtual void SetNextWindowId (void *)=0
 
void SetParentId (void *) override=0
 
void * GetGenericDisplayId () override=0
 
void * GetGenericWindowId () override=0
 
void * GetGenericParentId () override=0
 
void * GetGenericContext () override=0
 
void * GetGenericDrawable () override=0
 
void SetWindowInfo (const char *) override=0
 
virtual void SetNextWindowInfo (const char *)=0
 
void SetParentInfo (const char *) override=0
 
virtual bool InitializeFromCurrentContext ()
 Initialize the render window from the information associated with the currently activated OpenGL context. 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 ()
 
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 const char * ReportCapabilities ()
 Get report of capabilities for the render window. More...
 
virtual int SupportsOpenGL ()
 Does this render window support OpenGL? 0-false, 1-true. More...
 
virtual int IsDirect ()
 Is this render window using hardware acceleration? 0-false, 1-true. More...
 
virtual int GetDepthBufferSize ()=0
 This method should be defined by the subclass. More...
 
virtual int GetColorBufferSizes (int *rgba)=0
 Get the size of the color buffer. 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 int * GetPosition ()
 Set/Get the position in screen coordinates of the rendering window. More...
 
virtual void SetPosition (int, int)
 
virtual void SetPosition (int a[2])
 
virtual int * GetSize ()
 Set/Get the size of the window in screen coordinates in pixels. More...
 
virtual void SetSize (int, int)
 
virtual void SetSize (int a[2])
 
int * GetActualSize ()
 GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale. More...
 
virtual int * GetScreenSize ()=0
 Get the current size of the screen 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)
 
virtual void ShowWindowOn ()
 
virtual void ShowWindowOff ()
 
virtual void SetUseOffScreenBuffers (bool)
 Render to an offscreen destination such as a framebuffer. More...
 
virtual bool GetUseOffScreenBuffers ()
 
virtual void UseOffScreenBuffersOn ()
 
virtual void UseOffScreenBuffersOff ()
 
virtual void SetErase (vtkTypeBool)
 Turn on/off erasing the screen between images. More...
 
virtual vtkTypeBool GetErase ()
 
virtual void EraseOn ()
 
virtual void EraseOff ()
 
virtual void SetDoubleBuffer (vtkTypeBool)
 Keep track of whether double buffering is on or off. More...
 
virtual vtkTypeBool GetDoubleBuffer ()
 
virtual void DoubleBufferOn ()
 
virtual void DoubleBufferOff ()
 
virtual char * GetWindowName ()
 Get name of rendering window. More...
 
virtual void SetWindowName (const char *)
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 Release any graphics resources that are being consumed by this texture. More...
 
virtual unsigned char * GetPixelData (int x, int y, int x2, int y2, int front, int right=0)=0
 Get the pixel data of an image, transmitted as RGBRGBRGB. More...
 
virtual int GetPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right=0)=0
 
virtual int GetDPI ()
 Return a best estimate to the dots per inch of the display device being rendered (or printed). More...
 
virtual void SetDPI (int)
 
virtual bool DetectDPI ()
 Attempt to detect and set the DPI of the display device by querying the system. More...
 
void SetOffScreenRendering (vtkTypeBool val)
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOn ()
 
virtual void OffScreenRenderingOff ()
 
vtkTypeBool GetOffScreenRendering ()
 Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead. More...
 
virtual void SetTileScale (int, int)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
void SetTileScale (int[2])
 
virtual int * GetTileScale ()
 
virtual void GetTileScale (int &, int &)
 
virtual void GetTileScale (int[2])
 
void SetTileScale (int s)
 
virtual void SetTileViewport (double, double, double, double)
 
virtual void SetTileViewport (double[4])
 
virtual double * GetTileViewport ()
 
virtual void GetTileViewport (double &, double &, double &, double &)
 
virtual void GetTileViewport (double[4])
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual 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 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
 
 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

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
 

Detailed Description

create a window for renderers to draw into

vtkRenderWindow is an abstract object to specify the behavior of a rendering window. A rendering window is a window in a graphical user interface where renderers draw their images. Methods are provided to synchronize the rendering process, set window size, and control double buffering. The window also allows rendering in stereo. The interlaced render stereo type is for output to a VRex stereo projector. All of the odd horizontal lines are from the left eye, and the even lines are from the right eye. The user has to make the render window aligned with the VRex projector, or the eye will be swapped.

Warning
In VTK versions 4 and later, the vtkWindowToImageFilter class is part of the canonical way to output an image of a window to a file (replacing the obsolete SaveImageAsPPM method for vtkRenderWindows that existed in 3.2 and earlier). Connect one of these filters to the output of the window, and filter's output to a writer such as vtkPNGWriter.
See also
vtkRenderer vtkRenderWindowInteractor vtkWindowToImageFilter

Definition at line 84 of file vtkRenderWindow.h.

Member Typedef Documentation

◆ Superclass

Definition at line 87 of file vtkRenderWindow.h.

Constructor & Destructor Documentation

◆ vtkRenderWindow()

vtkRenderWindow::vtkRenderWindow ( )
protected

◆ ~vtkRenderWindow()

vtkRenderWindow::~vtkRenderWindow ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRenderWindow::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkRenderWindow* vtkRenderWindow::NewInstance ( ) const

◆ PrintSelf()

void vtkRenderWindow::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 vtkWindow.

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

◆ New()

static vtkRenderWindow* vtkRenderWindow::New ( )
static

Construct an instance of vtkRenderWindow with its screen size set to 300x300, borders turned on, positioned at (0,0), double buffering turned on.

◆ AddRenderer()

virtual void vtkRenderWindow::AddRenderer ( vtkRenderer )
virtual

Add a renderer to the list of renderers.

Reimplemented in vtkOpenVRRenderWindow.

◆ RemoveRenderer()

void vtkRenderWindow::RemoveRenderer ( vtkRenderer )

Remove a renderer from the list of renderers.

◆ HasRenderer()

int vtkRenderWindow::HasRenderer ( vtkRenderer )

Query if a renderer is in the list of renderers.

◆ GetRenderLibrary()

static const char* vtkRenderWindow::GetRenderLibrary ( )
static

What rendering library has the user requested.

◆ GetRenderingBackend()

virtual const char* vtkRenderWindow::GetRenderingBackend ( )
virtual

What rendering backend has the user requested.

Reimplemented in vtkOpenGLRenderWindow.

◆ vtkGetNewMacro()

vtkRenderWindow::vtkGetNewMacro ( RenderTimer  ,
vtkRenderTimerLog   
)

Get the render timer log for this window.

◆ GetRenderers()

vtkRendererCollection* vtkRenderWindow::GetRenderers ( )
inline

Return the collection of renderers in the render window.

Definition at line 130 of file vtkRenderWindow.h.

◆ CaptureGL2PSSpecialProps()

void vtkRenderWindow::CaptureGL2PSSpecialProps ( vtkCollection specialProps)

The GL2PS exporter must handle certain props in a special way (e.g.

text). This method performs a render and captures all "GL2PS-special" props in the specified collection. The collection will contain a vtkPropCollection for each vtkRenderer in this->GetRenderers(), each containing the special props rendered by the corresponding renderer.

◆ GetCapturingGL2PSSpecialProps()

virtual int vtkRenderWindow::GetCapturingGL2PSSpecialProps ( )
virtual

Returns true if the render process is capturing text actors.

◆ Render()

void vtkRenderWindow::Render ( )
overridevirtual

Ask each renderer owned by this RenderWindow to render its image and synchronize this process.

Implements vtkWindow.

Reimplemented in vtkOpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, and vtkOpenVRRenderWindow.

◆ Start()

virtual void vtkRenderWindow::Start ( )
pure virtual

◆ End()

virtual void vtkRenderWindow::End ( )
inlinevirtual

Update the system, if needed, at end of render process.

Reimplemented in vtkOpenGLRenderWindow.

Definition at line 162 of file vtkRenderWindow.h.

◆ Finalize()

virtual void vtkRenderWindow::Finalize ( )
pure virtual

◆ Frame()

virtual void vtkRenderWindow::Frame ( )
pure virtual

A termination method performed at the end of the rendering process to do things like swapping buffers (if necessary) or similar actions.

Implemented in vtkEGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkXOpenGLRenderWindow, and vtkGenericOpenGLRenderWindow.

◆ WaitForCompletion()

virtual void vtkRenderWindow::WaitForCompletion ( )
pure virtual

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

Useful for measurement only.

Implemented in vtkOpenGLRenderWindow.

◆ CopyResultFrame()

virtual void vtkRenderWindow::CopyResultFrame ( )
virtual

Performed at the end of the rendering process to generate image.

This is typically done right before swapping buffers.

◆ MakeRenderWindowInteractor()

virtual vtkRenderWindowInteractor* vtkRenderWindow::MakeRenderWindowInteractor ( )
virtual

Create an interactor to control renderers in this window.

We need to know what type of interactor to create, because we might be in X Windows or MS Windows.

Reimplemented in vtkOpenVRRenderWindow.

◆ HideCursor()

virtual void vtkRenderWindow::HideCursor ( )
pure virtual

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

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

◆ ShowCursor()

virtual void vtkRenderWindow::ShowCursor ( )
pure virtual

◆ SetCursorPosition()

virtual void vtkRenderWindow::SetCursorPosition ( int  ,
int   
)
inlinevirtual

Reimplemented in vtkCocoaRenderWindow, vtkIOSRenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 203 of file vtkRenderWindow.h.

◆ SetCurrentCursor()

virtual void vtkRenderWindow::SetCurrentCursor ( int  )
virtual

◆ GetCurrentCursor()

virtual int vtkRenderWindow::GetCurrentCursor ( )
virtual

◆ SetFullScreen()

virtual void vtkRenderWindow::SetFullScreen ( vtkTypeBool  )
pure virtual

◆ GetFullScreen()

virtual vtkTypeBool vtkRenderWindow::GetFullScreen ( )
virtual

◆ FullScreenOn()

virtual void vtkRenderWindow::FullScreenOn ( )
virtual

◆ FullScreenOff()

virtual void vtkRenderWindow::FullScreenOff ( )
virtual

◆ SetBorders()

virtual void vtkRenderWindow::SetBorders ( vtkTypeBool  )
virtual

Turn on/off window manager borders.

Typically, you shouldn't turn the borders off, because that bypasses the window manager and can cause undesirable behavior.

◆ GetBorders()

virtual vtkTypeBool vtkRenderWindow::GetBorders ( )
virtual

◆ BordersOn()

virtual void vtkRenderWindow::BordersOn ( )
virtual

◆ BordersOff()

virtual void vtkRenderWindow::BordersOff ( )
virtual

◆ GetStereoCapableWindow()

virtual vtkTypeBool vtkRenderWindow::GetStereoCapableWindow ( )
virtual

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

This method must be called before the window is realized. Default is off.

◆ StereoCapableWindowOn()

virtual void vtkRenderWindow::StereoCapableWindowOn ( )
virtual

◆ StereoCapableWindowOff()

virtual void vtkRenderWindow::StereoCapableWindowOff ( )
virtual

◆ SetStereoCapableWindow()

virtual void vtkRenderWindow::SetStereoCapableWindow ( vtkTypeBool  capable)
virtual

◆ GetStereoRender()

virtual vtkTypeBool vtkRenderWindow::GetStereoRender ( )
virtual

Turn on/off stereo rendering.

◆ SetStereoRender()

void vtkRenderWindow::SetStereoRender ( vtkTypeBool  stereo)

◆ StereoRenderOn()

virtual void vtkRenderWindow::StereoRenderOn ( )
virtual

◆ StereoRenderOff()

virtual void vtkRenderWindow::StereoRenderOff ( )
virtual

◆ SetAlphaBitPlanes()

virtual void vtkRenderWindow::SetAlphaBitPlanes ( vtkTypeBool  )
virtual

Turn on/off the use of alpha bitplanes.

◆ GetAlphaBitPlanes()

virtual vtkTypeBool vtkRenderWindow::GetAlphaBitPlanes ( )
virtual

◆ AlphaBitPlanesOn()

virtual void vtkRenderWindow::AlphaBitPlanesOn ( )
virtual

◆ AlphaBitPlanesOff()

virtual void vtkRenderWindow::AlphaBitPlanesOff ( )
virtual

◆ SetPointSmoothing()

virtual void vtkRenderWindow::SetPointSmoothing ( vtkTypeBool  )
virtual

Turn on/off point smoothing.

Default is off. This must be applied before the first Render.

◆ GetPointSmoothing()

virtual vtkTypeBool vtkRenderWindow::GetPointSmoothing ( )
virtual

◆ PointSmoothingOn()

virtual void vtkRenderWindow::PointSmoothingOn ( )
virtual

◆ PointSmoothingOff()

virtual void vtkRenderWindow::PointSmoothingOff ( )
virtual

◆ SetLineSmoothing()

virtual void vtkRenderWindow::SetLineSmoothing ( vtkTypeBool  )
virtual

Turn on/off line smoothing.

Default is off. This must be applied before the first Render.

◆ GetLineSmoothing()

virtual vtkTypeBool vtkRenderWindow::GetLineSmoothing ( )
virtual

◆ LineSmoothingOn()

virtual void vtkRenderWindow::LineSmoothingOn ( )
virtual

◆ LineSmoothingOff()

virtual void vtkRenderWindow::LineSmoothingOff ( )
virtual

◆ SetPolygonSmoothing()

virtual void vtkRenderWindow::SetPolygonSmoothing ( vtkTypeBool  )
virtual

Turn on/off polygon smoothing.

Default is off. This must be applied before the first Render.

◆ GetPolygonSmoothing()

virtual vtkTypeBool vtkRenderWindow::GetPolygonSmoothing ( )
virtual

◆ PolygonSmoothingOn()

virtual void vtkRenderWindow::PolygonSmoothingOn ( )
virtual

◆ PolygonSmoothingOff()

virtual void vtkRenderWindow::PolygonSmoothingOff ( )
virtual

◆ GetStereoType()

virtual int vtkRenderWindow::GetStereoType ( )
virtual

Set/Get what type of stereo rendering to use.

CrystalEyes mode uses frame-sequential capabilities available in OpenGL to drive LCD shutter glasses and stereo projectors. RedBlue mode is a simple type of stereo for use with red-blue glasses. Anaglyph mode is a superset of RedBlue mode, but the color output channels can be configured using the AnaglyphColorMask and the color of the original image can be (somewhat) maintained using AnaglyphColorSaturation; the default colors for Anaglyph mode is red-cyan. Interlaced stereo mode produces a composite image where horizontal lines alternate between left and right views. StereoLeft and StereoRight modes choose one or the other stereo view. Dresden mode is yet another stereoscopic interleaving. Fake simply causes the window to render twice without actually swapping the camera from left eye to right eye. This is useful in certain applications that want to emulate the rendering passes without actually rendering in stereo mode. Emulate is similar to Fake, except that it does render left and right eye. There is no compositing of the resulting images from the two eyes at the end of each render in this mode, hence the result onscreen will be the right eye.

◆ SetStereoType()

void vtkRenderWindow::SetStereoType ( int  )

◆ SetStereoTypeToCrystalEyes()

void vtkRenderWindow::SetStereoTypeToCrystalEyes ( )
inline

Definition at line 316 of file vtkRenderWindow.h.

◆ SetStereoTypeToRedBlue()

void vtkRenderWindow::SetStereoTypeToRedBlue ( )
inline

Definition at line 317 of file vtkRenderWindow.h.

◆ SetStereoTypeToInterlaced()

void vtkRenderWindow::SetStereoTypeToInterlaced ( )
inline

Definition at line 318 of file vtkRenderWindow.h.

◆ SetStereoTypeToLeft()

void vtkRenderWindow::SetStereoTypeToLeft ( )
inline

Definition at line 319 of file vtkRenderWindow.h.

◆ SetStereoTypeToRight()

void vtkRenderWindow::SetStereoTypeToRight ( )
inline

Definition at line 320 of file vtkRenderWindow.h.

◆ SetStereoTypeToDresden()

void vtkRenderWindow::SetStereoTypeToDresden ( )
inline

Definition at line 321 of file vtkRenderWindow.h.

◆ SetStereoTypeToAnaglyph()

void vtkRenderWindow::SetStereoTypeToAnaglyph ( )
inline

Definition at line 322 of file vtkRenderWindow.h.

◆ SetStereoTypeToCheckerboard()

void vtkRenderWindow::SetStereoTypeToCheckerboard ( )
inline

Definition at line 323 of file vtkRenderWindow.h.

◆ SetStereoTypeToSplitViewportHorizontal()

void vtkRenderWindow::SetStereoTypeToSplitViewportHorizontal ( )
inline

Definition at line 324 of file vtkRenderWindow.h.

◆ SetStereoTypeToFake()

void vtkRenderWindow::SetStereoTypeToFake ( )
inline

Definition at line 328 of file vtkRenderWindow.h.

◆ SetStereoTypeToEmulate()

void vtkRenderWindow::SetStereoTypeToEmulate ( )
inline

Definition at line 329 of file vtkRenderWindow.h.

◆ GetStereoTypeAsString() [1/2]

const char* vtkRenderWindow::GetStereoTypeAsString ( )

Returns the stereo type as a string.

◆ GetStereoTypeAsString() [2/2]

static const char* vtkRenderWindow::GetStereoTypeAsString ( int  type)
static

◆ StereoUpdate()

virtual void vtkRenderWindow::StereoUpdate ( )
virtual

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

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

Reimplemented in vtkOpenVRRenderWindow.

◆ StereoMidpoint()

virtual void vtkRenderWindow::StereoMidpoint ( )
virtual

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

Reimplemented in vtkOpenGLRenderWindow, and vtkOpenVRRenderWindow.

◆ StereoRenderComplete()

virtual void vtkRenderWindow::StereoRenderComplete ( )
virtual

Handles work required once both views have been rendered when using stereo rendering.

Reimplemented in vtkOpenVRRenderWindow.

◆ SetAnaglyphColorSaturation()

virtual void vtkRenderWindow::SetAnaglyphColorSaturation ( float  )
virtual

Set/get the anaglyph color saturation factor.

This number ranges from 0.0 to 1.0: 0.0 means that no color from the original object is maintained, 1.0 means all of the color is maintained. The default value is 0.65. Too much saturation can produce uncomfortable 3D viewing because anaglyphs also use color to encode 3D.

◆ GetAnaglyphColorSaturation()

virtual float vtkRenderWindow::GetAnaglyphColorSaturation ( )
virtual

◆ SetAnaglyphColorMask() [1/2]

virtual void vtkRenderWindow::SetAnaglyphColorMask ( int  ,
int   
)
virtual

Set/get the anaglyph color mask values.

These two numbers are bits mask that control which color channels of the original stereo images are used to produce the final anaglyph image. The first value is the color mask for the left view, the second the mask for the right view. If a bit in the mask is on for a particular color for a view, that color is passed on to the final view; if it is not set, that channel for that view is ignored. The bits are arranged as r, g, and b, so r = 4, g = 2, and b = 1. By default, the first value (the left view) is set to 4, and the second value is set to 3. That means that the red output channel comes from the left view, and the green and blue values come from the right view.

◆ SetAnaglyphColorMask() [2/2]

void vtkRenderWindow::SetAnaglyphColorMask ( int  [2])

◆ GetAnaglyphColorMask() [1/2]

virtual int* vtkRenderWindow::GetAnaglyphColorMask ( )
virtual

◆ GetAnaglyphColorMask() [2/2]

virtual void vtkRenderWindow::GetAnaglyphColorMask ( int  data[2])
virtual

◆ WindowRemap()

virtual void vtkRenderWindow::WindowRemap ( )
pure virtual

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.

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

◆ SetSwapBuffers()

virtual void vtkRenderWindow::SetSwapBuffers ( vtkTypeBool  )
virtual

Turn on/off buffer swapping between images.

◆ GetSwapBuffers()

virtual vtkTypeBool vtkRenderWindow::GetSwapBuffers ( )
virtual

◆ SwapBuffersOn()

virtual void vtkRenderWindow::SwapBuffersOn ( )
virtual

◆ SwapBuffersOff()

virtual void vtkRenderWindow::SwapBuffersOff ( )
virtual

◆ SetPixelData() [1/2]

virtual int vtkRenderWindow::SetPixelData ( int  x,
int  y,
int  x2,
int  y2,
unsigned char *  data,
int  front,
int  right = 0 
)
pure virtual

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

The front argument indicates if the front buffer should be used or the back buffer. It is the caller's responsibility to delete the resulting array. It is very important to realize that the memory in this array is organized from the bottom of the window to the top. The origin of the screen is in the lower left corner. The y axis increases as you go up the screen. So the storage of pixels is from left to right and from bottom to top. (x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.

Implemented in vtkOpenGLRenderWindow.

◆ SetPixelData() [2/2]

virtual int vtkRenderWindow::SetPixelData ( int  x,
int  y,
int  x2,
int  y2,
vtkUnsignedCharArray data,
int  front,
int  right = 0 
)
pure virtual

Implemented in vtkOpenGLRenderWindow.

◆ GetRGBAPixelData() [1/2]

virtual float* vtkRenderWindow::GetRGBAPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
int  right = 0 
)
pure virtual

Same as Get/SetPixelData except that the image also contains an alpha component.

The image is transmitted as RGBARGBARGBA... each of which is a float value. The "blend" parameter controls whether the SetRGBAPixelData method blends the data with the previous contents of the frame buffer or completely replaces the frame buffer data.

Implemented in vtkOpenGLRenderWindow.

◆ GetRGBAPixelData() [2/2]

virtual int vtkRenderWindow::GetRGBAPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
vtkFloatArray data,
int  right = 0 
)
pure virtual

Implemented in vtkOpenGLRenderWindow.

◆ SetRGBAPixelData() [1/2]

virtual int vtkRenderWindow::SetRGBAPixelData ( int  x,
int  y,
int  x2,
int  y2,
float *  ,
int  front,
int  blend = 0,
int  right = 0 
)
pure virtual

Implemented in vtkOpenGLRenderWindow.

◆ SetRGBAPixelData() [2/2]

virtual int vtkRenderWindow::SetRGBAPixelData ( int  ,
int  ,
int  ,
int  ,
vtkFloatArray ,
int  ,
int  blend = 0,
int  right = 0 
)
pure virtual

Implemented in vtkOpenGLRenderWindow.

◆ ReleaseRGBAPixelData()

virtual void vtkRenderWindow::ReleaseRGBAPixelData ( float *  data)
pure virtual

Implemented in vtkOpenGLRenderWindow.

◆ GetRGBACharPixelData() [1/2]

virtual unsigned char* vtkRenderWindow::GetRGBACharPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
int  right = 0 
)
pure virtual

Implemented in vtkOpenGLRenderWindow.

◆ GetRGBACharPixelData() [2/2]

virtual int vtkRenderWindow::GetRGBACharPixelData ( int  x,
int  y,
int  x2,
int  y2,
int  front,
vtkUnsignedCharArray data,
int  right = 0 
)
pure virtual

Implemented in vtkOpenGLRenderWindow.

◆ SetRGBACharPixelData() [1/2]

virtual int vtkRenderWindow::SetRGBACharPixelData ( int  x,
int  y,
int  x2,
int  y2,
unsigned char *  data,
int  front,
int  blend = 0,
int  right = 0 
)
pure virtual

◆ SetRGBACharPixelData() [2/2]

virtual int vtkRenderWindow::SetRGBACharPixelData ( int  x,
int  y,
int  x2,
int  y2,
vtkUnsignedCharArray data,
int  front,
int  blend = 0,
int  right = 0 
)
pure virtual

◆ GetZbufferData() [1/3]

virtual float* vtkRenderWindow::GetZbufferData ( int  x,
int  y,
int  x2,
int  y2 
)
pure virtual

Set/Get the zbuffer data from the frame buffer.

(x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.

Implemented in vtkOpenGLRenderWindow.

◆ GetZbufferData() [2/3]

virtual int vtkRenderWindow::GetZbufferData ( int  x,
int  y,
int  x2,
int  y2,
float *  z 
)
pure virtual

Implemented in vtkOpenGLRenderWindow.

◆ GetZbufferData() [3/3]

virtual int vtkRenderWindow::GetZbufferData ( int  x,
int  y,
int  x2,
int  y2,
vtkFloatArray z 
)
pure virtual

Implemented in vtkOpenGLRenderWindow.

◆ SetZbufferData() [1/2]

virtual int vtkRenderWindow::SetZbufferData ( int  x,
int  y,
int  x2,
int  y2,
float *  z 
)
pure virtual

Implemented in vtkOpenGLRenderWindow.

◆ SetZbufferData() [2/2]

virtual int vtkRenderWindow::SetZbufferData ( int  x,
int  y,
int  x2,
int  y2,
vtkFloatArray z 
)
pure virtual

Implemented in vtkOpenGLRenderWindow.

◆ GetZbufferDataAtPoint()

float vtkRenderWindow::GetZbufferDataAtPoint ( int  x,
int  y 
)
inline

Definition at line 461 of file vtkRenderWindow.h.

◆ GetNeverRendered()

virtual int vtkRenderWindow::GetNeverRendered ( )
virtual

This flag is set if the window hasn't rendered since it was created.

◆ GetAbortRender()

virtual int vtkRenderWindow::GetAbortRender ( )
virtual

This is a flag that can be set to interrupt a rendering that is in progress.

◆ SetAbortRender()

virtual void vtkRenderWindow::SetAbortRender ( int  )
virtual

◆ GetInAbortCheck()

virtual int vtkRenderWindow::GetInAbortCheck ( )
virtual

◆ SetInAbortCheck()

virtual void vtkRenderWindow::SetInAbortCheck ( int  )
virtual

◆ CheckAbortStatus()

virtual int vtkRenderWindow::CheckAbortStatus ( )
virtual

◆ GetIsPicking()

vtkTypeBool vtkRenderWindow::GetIsPicking ( )
Deprecated:
in VTK 8.3

◆ SetIsPicking()

void vtkRenderWindow::SetIsPicking ( vtkTypeBool  )

◆ IsPickingOn()

void vtkRenderWindow::IsPickingOn ( )

◆ IsPickingOff()

void vtkRenderWindow::IsPickingOff ( )

◆ GetEventPending()

virtual int vtkRenderWindow::GetEventPending ( )
pure virtual

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.

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

◆ CheckInRenderStatus()

virtual int vtkRenderWindow::CheckInRenderStatus ( )
inlinevirtual

Are we rendering at the moment.

Definition at line 509 of file vtkRenderWindow.h.

◆ ClearInRenderStatus()

virtual void vtkRenderWindow::ClearInRenderStatus ( )
inlinevirtual

Clear status (after an exception was thrown for example)

Definition at line 514 of file vtkRenderWindow.h.

◆ SetDesiredUpdateRate()

virtual void vtkRenderWindow::SetDesiredUpdateRate ( double  )
virtual

Set/Get the desired update rate.

This is used with the vtkLODActor class. When using level of detail actors you need to specify what update rate you require. The LODActors then will pick the correct resolution to meet your desired update rate in frames per second. A value of zero indicates that they can use all the time they want to.

◆ GetDesiredUpdateRate()

virtual double vtkRenderWindow::GetDesiredUpdateRate ( )
virtual

◆ GetNumberOfLayers()

virtual int vtkRenderWindow::GetNumberOfLayers ( )
virtual

Get the number of layers for renderers.

Each renderer should have its layer set individually. Some algorithms iterate through all layers, so it is not wise to set the number of layers to be exorbitantly large (say bigger than 100).

◆ SetNumberOfLayers()

virtual void vtkRenderWindow::SetNumberOfLayers ( int  )
virtual

◆ GetInteractor()

virtual vtkRenderWindowInteractor* vtkRenderWindow::GetInteractor ( )
virtual

Get the interactor associated with this render window.

◆ SetInteractor()

void vtkRenderWindow::SetInteractor ( vtkRenderWindowInteractor )

Set the interactor to the render window.

◆ UnRegister()

void vtkRenderWindow::UnRegister ( vtkObjectBase o)
overridevirtual

This Method detects loops of RenderWindow<->Interactor, so objects are freed properly.

Reimplemented from vtkObjectBase.

◆ SetDisplayId()

void vtkRenderWindow::SetDisplayId ( void *  )
overridepure virtual

◆ SetWindowId()

void vtkRenderWindow::SetWindowId ( void *  )
overridepure virtual

◆ SetNextWindowId()

virtual void vtkRenderWindow::SetNextWindowId ( void *  )
pure virtual

◆ SetParentId()

void vtkRenderWindow::SetParentId ( void *  )
overridepure virtual

◆ GetGenericDisplayId()

void* vtkRenderWindow::GetGenericDisplayId ( )
overridepure virtual

◆ GetGenericWindowId()

void* vtkRenderWindow::GetGenericWindowId ( )
overridepure virtual

◆ GetGenericParentId()

void* vtkRenderWindow::GetGenericParentId ( )
overridepure virtual

◆ GetGenericContext()

void* vtkRenderWindow::GetGenericContext ( )
overridepure virtual

◆ GetGenericDrawable()

void* vtkRenderWindow::GetGenericDrawable ( )
overridepure virtual

◆ SetWindowInfo()

void vtkRenderWindow::SetWindowInfo ( const char *  )
overridepure virtual

◆ SetNextWindowInfo()

virtual void vtkRenderWindow::SetNextWindowInfo ( const char *  )
pure virtual

◆ SetParentInfo()

void vtkRenderWindow::SetParentInfo ( const char *  )
overridepure virtual

◆ InitializeFromCurrentContext()

virtual bool vtkRenderWindow::InitializeFromCurrentContext ( )
inlinevirtual

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

Reimplemented in vtkOpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 580 of file vtkRenderWindow.h.

◆ SetSharedRenderWindow()

virtual void vtkRenderWindow::SetSharedRenderWindow ( vtkRenderWindow )
virtual

Set/Get an already existing window that this window should share data with if possible.

This must be set after the shared render window has been created and initialized but before this window has been initialized. Not all platforms support data sharing.

◆ GetSharedRenderWindow()

virtual vtkRenderWindow* vtkRenderWindow::GetSharedRenderWindow ( )
virtual

◆ GetPlatformSupportsRenderWindowSharing()

virtual bool vtkRenderWindow::GetPlatformSupportsRenderWindowSharing ( )
inlinevirtual

◆ MakeCurrent()

void vtkRenderWindow::MakeCurrent ( )
overridepure virtual

Attempt to make this window the current graphics context for the calling thread.

Reimplemented from vtkWindow.

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

◆ IsCurrent()

virtual bool vtkRenderWindow::IsCurrent ( )
pure virtual

◆ IsDrawable()

virtual bool vtkRenderWindow::IsDrawable ( )
inlinevirtual

Test if the window has a valid drawable.

This is currently only an issue on Mac OS X Cocoa where rendering to an invalid drawable results in all OpenGL calls to fail with "invalid framebuffer operation".

Reimplemented in vtkCocoaRenderWindow, vtkIOSRenderWindow, and vtkGenericOpenGLRenderWindow.

Definition at line 613 of file vtkRenderWindow.h.

◆ SetForceMakeCurrent()

virtual void vtkRenderWindow::SetForceMakeCurrent ( )
inlinevirtual

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

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

Reimplemented in vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkXOpenGLRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 620 of file vtkRenderWindow.h.

◆ ReportCapabilities()

virtual const char* vtkRenderWindow::ReportCapabilities ( )
inlinevirtual

Get report of capabilities for the render window.

Reimplemented in vtkOpenGLRenderWindow, vtkCocoaRenderWindow, vtkWin32OpenGLRenderWindow, vtkIOSRenderWindow, vtkXOpenGLRenderWindow, vtkOpenVRRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 625 of file vtkRenderWindow.h.

◆ SupportsOpenGL()

virtual int vtkRenderWindow::SupportsOpenGL ( )
inlinevirtual

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

Reimplemented in vtkOpenGLRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkOpenVRRenderWindow, and vtkOSOpenGLRenderWindow.

Definition at line 630 of file vtkRenderWindow.h.

◆ IsDirect()

virtual int vtkRenderWindow::IsDirect ( )
inlinevirtual

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

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

Definition at line 635 of file vtkRenderWindow.h.

◆ GetDepthBufferSize()

virtual int vtkRenderWindow::GetDepthBufferSize ( )
pure virtual

This method should be defined by the subclass.

How many bits of precision are there in the zbuffer?

Implemented in vtkIOSRenderWindow, and vtkOpenGLRenderWindow.

◆ GetColorBufferSizes()

virtual int vtkRenderWindow::GetColorBufferSizes ( int *  rgba)
pure virtual

Get the size of the color buffer.

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

Implemented in vtkOpenGLRenderWindow.

◆ SetMultiSamples()

virtual void vtkRenderWindow::SetMultiSamples ( int  )
virtual

Set / Get the number of multisamples to use for hardware antialiasing.

A value of 1 will be set to 0.

◆ GetMultiSamples()

virtual int vtkRenderWindow::GetMultiSamples ( )
virtual

◆ SetStencilCapable()

virtual void vtkRenderWindow::SetStencilCapable ( vtkTypeBool  )
virtual

Set / Get the availability of the stencil buffer.

◆ GetStencilCapable()

virtual vtkTypeBool vtkRenderWindow::GetStencilCapable ( )
virtual

◆ StencilCapableOn()

virtual void vtkRenderWindow::StencilCapableOn ( )
virtual

◆ StencilCapableOff()

virtual void vtkRenderWindow::StencilCapableOff ( )
virtual

◆ SetDeviceIndex()

virtual void vtkRenderWindow::SetDeviceIndex ( int  )
virtual

If there are several graphics card installed on a system, this index can be used to specify which card you want to render to.

the default is 0. This may not work on all derived render window and it may need to be set before the first render.

◆ GetDeviceIndex()

virtual int vtkRenderWindow::GetDeviceIndex ( )
virtual

◆ GetNumberOfDevices()

virtual int vtkRenderWindow::GetNumberOfDevices ( )
inlinevirtual

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

This may not work on all derived render windows.

Reimplemented in vtkEGLRenderWindow.

Definition at line 681 of file vtkRenderWindow.h.

◆ GetUseSRGBColorSpace()

virtual bool vtkRenderWindow::GetUseSRGBColorSpace ( )
virtual

Set/Get if we want this window to use the sRGB color space.

Some hardware/drivers do not fully support this.

◆ SetUseSRGBColorSpace()

virtual void vtkRenderWindow::SetUseSRGBColorSpace ( bool  )
virtual

◆ UseSRGBColorSpaceOn()

virtual void vtkRenderWindow::UseSRGBColorSpaceOn ( )
virtual

◆ UseSRGBColorSpaceOff()

virtual void vtkRenderWindow::UseSRGBColorSpaceOff ( )
virtual

◆ DoStereoRender()

virtual void vtkRenderWindow::DoStereoRender ( )
protectedvirtual

Member Data Documentation

◆ Renderers

vtkRendererCollection* vtkRenderWindow::Renderers
protected

Definition at line 699 of file vtkRenderWindow.h.

◆ RenderTimer

vtkNew<vtkRenderTimerLog> vtkRenderWindow::RenderTimer
protected

Definition at line 700 of file vtkRenderWindow.h.

◆ Borders

vtkTypeBool vtkRenderWindow::Borders
protected

Definition at line 701 of file vtkRenderWindow.h.

◆ FullScreen

vtkTypeBool vtkRenderWindow::FullScreen
protected

Definition at line 702 of file vtkRenderWindow.h.

◆ OldScreen

int vtkRenderWindow::OldScreen[5]
protected

Definition at line 703 of file vtkRenderWindow.h.

◆ PointSmoothing

vtkTypeBool vtkRenderWindow::PointSmoothing
protected

Definition at line 704 of file vtkRenderWindow.h.

◆ LineSmoothing

vtkTypeBool vtkRenderWindow::LineSmoothing
protected

Definition at line 705 of file vtkRenderWindow.h.

◆ PolygonSmoothing

vtkTypeBool vtkRenderWindow::PolygonSmoothing
protected

Definition at line 706 of file vtkRenderWindow.h.

◆ StereoRender

vtkTypeBool vtkRenderWindow::StereoRender
protected

Definition at line 707 of file vtkRenderWindow.h.

◆ StereoType

int vtkRenderWindow::StereoType
protected

Definition at line 708 of file vtkRenderWindow.h.

◆ StereoCapableWindow

vtkTypeBool vtkRenderWindow::StereoCapableWindow
protected

Definition at line 709 of file vtkRenderWindow.h.

◆ AlphaBitPlanes

vtkTypeBool vtkRenderWindow::AlphaBitPlanes
protected

Definition at line 710 of file vtkRenderWindow.h.

◆ Interactor

vtkRenderWindowInteractor* vtkRenderWindow::Interactor
protected

Definition at line 711 of file vtkRenderWindow.h.

◆ StereoBuffer

vtkSmartPointer<vtkUnsignedCharArray> vtkRenderWindow::StereoBuffer
protected

Definition at line 712 of file vtkRenderWindow.h.

◆ ResultFrame

vtkSmartPointer<vtkUnsignedCharArray> vtkRenderWindow::ResultFrame
protected

Definition at line 713 of file vtkRenderWindow.h.

◆ SwapBuffers

vtkTypeBool vtkRenderWindow::SwapBuffers
protected

Definition at line 714 of file vtkRenderWindow.h.

◆ DesiredUpdateRate

double vtkRenderWindow::DesiredUpdateRate
protected

Definition at line 715 of file vtkRenderWindow.h.

◆ AbortRender

int vtkRenderWindow::AbortRender
protected

Definition at line 716 of file vtkRenderWindow.h.

◆ InAbortCheck

int vtkRenderWindow::InAbortCheck
protected

Definition at line 717 of file vtkRenderWindow.h.

◆ InRender

int vtkRenderWindow::InRender
protected

Definition at line 718 of file vtkRenderWindow.h.

◆ NeverRendered

int vtkRenderWindow::NeverRendered
protected

Definition at line 719 of file vtkRenderWindow.h.

◆ NumberOfLayers

int vtkRenderWindow::NumberOfLayers
protected

Definition at line 720 of file vtkRenderWindow.h.

◆ CurrentCursor

int vtkRenderWindow::CurrentCursor
protected

Definition at line 721 of file vtkRenderWindow.h.

◆ AnaglyphColorSaturation

float vtkRenderWindow::AnaglyphColorSaturation
protected

Definition at line 722 of file vtkRenderWindow.h.

◆ AnaglyphColorMask

int vtkRenderWindow::AnaglyphColorMask[2]
protected

Definition at line 723 of file vtkRenderWindow.h.

◆ MultiSamples

int vtkRenderWindow::MultiSamples
protected

Definition at line 724 of file vtkRenderWindow.h.

◆ StencilCapable

vtkTypeBool vtkRenderWindow::StencilCapable
protected

Definition at line 725 of file vtkRenderWindow.h.

◆ CapturingGL2PSSpecialProps

int vtkRenderWindow::CapturingGL2PSSpecialProps
protected

Definition at line 726 of file vtkRenderWindow.h.

◆ DeviceIndex

int vtkRenderWindow::DeviceIndex
protected

Definition at line 727 of file vtkRenderWindow.h.

◆ UseSRGBColorSpace

bool vtkRenderWindow::UseSRGBColorSpace
protected

Definition at line 729 of file vtkRenderWindow.h.

◆ AbortCheckTime

double vtkRenderWindow::AbortCheckTime
protected

The universal time since the last abort check occurred.

Definition at line 734 of file vtkRenderWindow.h.

◆ SharedRenderWindow

vtkRenderWindow* vtkRenderWindow::SharedRenderWindow
protected

Definition at line 736 of file vtkRenderWindow.h.


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