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

#include <vtkRenderWindow.h>

Inheritance diagram for vtkRenderWindow:

Collaboration diagram for vtkRenderWindow:

Public Types
enum	{ PhysicalToWorldMatrixModified = vtkCommand::UserEvent + 200 }

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.

vtkRenderWindow *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	AddRenderer (vtkRenderer *)
	Add a renderer to the list of renderers.

void	RemoveRenderer (vtkRenderer *)
	Remove a renderer from the list of renderers.

vtkTypeBool	HasRenderer (vtkRenderer *)
	Query if a renderer is in the list of renderers.

virtual const char *	GetRenderingBackend ()
	What rendering backend has the user requested.

	vtkGetNewMacro (RenderTimer, vtkRenderTimerLog)
	Get the render timer log for this window.

vtkRendererCollection *	GetRenderers ()
	Return the collection of renderers in the render window.

void	CaptureGL2PSSpecialProps (vtkCollection *specialProps)
	The GL2PS exporter must handle certain props in a special way (e.g.

void	Render () override
	Ask each renderer owned by this RenderWindow to render its image and synchronize this process.

virtual void	Start ()
	Start the rendering process for a frame.

virtual void	End ()
	Update the system, if needed, at end of render process.

virtual void	Initialize ()
	Initializes the rendering process.

virtual void	Finalize ()
	Finalize the rendering process.

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

virtual void	WaitForCompletion ()
	Block the thread until the actual rendering is finished().

virtual void	CopyResultFrame ()
	Performed at the end of the rendering process to generate image.

virtual vtkRenderWindowInteractor *	MakeRenderWindowInteractor ()
	Create an interactor to control renderers in this window.

virtual void	StereoUpdate ()
	Update the system, if needed, due to stereo rendering.

virtual void	StereoMidpoint ()
	Intermediate method performs operations required between the rendering of the left and right eye.

virtual void	StereoRenderComplete ()
	Handles work required once both views have been rendered when using stereo rendering.

virtual void	WindowRemap ()
	Remap the rendering window.

virtual vtkTypeBool	GetEventPending ()
	Check to see if a mouse button has been pressed.

virtual int	CheckInRenderStatus ()
	Are we rendering at the moment.

virtual void	ClearInRenderStatus ()
	Clear status (after an exception was thrown for example)

virtual void	SetInteractor (vtkRenderWindowInteractor *)
	Set the interactor to the render window.

void	UnRegister (vtkObjectBase *o) override
	This Method detects loops of RenderWindow<->Interactor, so objects are freed properly.

virtual bool	InitializeFromCurrentContext ()
	Initialize the render window from the information associated with the currently activated OpenGL context.

virtual bool	IsCurrent ()
	Tells if this window is the current graphics context for the calling thread.

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

virtual const char *	ReportCapabilities ()
	Get report of capabilities for the render window.

virtual int	SupportsOpenGL ()
	Does this render window support OpenGL? 0-false, 1-true.

virtual vtkTypeBool	IsDirect ()
	Is this render window using hardware acceleration? 0-false, 1-true.

virtual int	GetDepthBufferSize ()
	This method should be defined by the subclass.

virtual int	GetColorBufferSizes (int *)
	Get the size of the color buffer.

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

virtual void	SetPhysicalToWorldMatrix (vtkMatrix4x4 *matrix)
	Set physical to world transform matrix.

virtual void	GetPhysicalToWorldMatrix (vtkMatrix4x4 *matrix)
	Get physical to world transform matrix.

virtual bool	GetDeviceToWorldMatrixForDevice (vtkEventDataDevice device, vtkMatrix4x4 *deviceToWorldMatrix)
	Store in `deviceToWorldMatrix` the matrix that goes from device coordinates to world coordinates.


virtual int	GetCapturingGL2PSSpecialProps ()
	Returns true if the render process is capturing text actors.


virtual bool	GetInitialized ()
	Get/set whether or not the window has been initilized yet.


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

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

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


virtual void	SetCurrentCursor (int)
	Change the shape of the cursor.

virtual int	GetCurrentCursor ()
	Change the shape of the cursor.


	vtkSetFilePathMacro (CursorFileName)
	Set/Get the full path to the custom cursor.

	vtkGetFilePathMacro (CursorFileName)
	Set/Get the full path to the custom cursor.


virtual void	SetFullScreen (vtkTypeBool)
	Turn on/off rendering full screen window size.

virtual vtkTypeBool	GetFullScreen ()
	Turn on/off rendering full screen window size.

virtual void	FullScreenOn ()
	Turn on/off rendering full screen window size.

virtual void	FullScreenOff ()
	Turn on/off rendering full screen window size.


virtual void	SetBorders (vtkTypeBool)
	Turn on/off window manager borders.

virtual vtkTypeBool	GetBorders ()
	Turn on/off window manager borders.

virtual void	BordersOn ()
	Turn on/off window manager borders.

virtual void	BordersOff ()
	Turn on/off window manager borders.


virtual vtkTypeBool	GetCoverable ()
	Set/Get whether windows should be coverable (as opposed to always on top).

virtual void	CoverableOn ()
	Set/Get whether windows should be coverable (as opposed to always on top).

virtual void	CoverableOff ()
	Set/Get whether windows should be coverable (as opposed to always on top).

virtual void	SetCoverable (vtkTypeBool coverable)
	Set/Get whether windows should be coverable (as opposed to always on top).


virtual vtkTypeBool	GetStereoCapableWindow ()
	Prescribe that the window be created in a stereo-capable mode.

virtual void	StereoCapableWindowOn ()
	Prescribe that the window be created in a stereo-capable mode.

virtual void	StereoCapableWindowOff ()
	Prescribe that the window be created in a stereo-capable mode.

virtual void	SetStereoCapableWindow (vtkTypeBool capable)
	Prescribe that the window be created in a stereo-capable mode.


virtual vtkTypeBool	GetStereoRender ()
	Turn on/off stereo rendering.

void	SetStereoRender (vtkTypeBool stereo)
	Turn on/off stereo rendering.

virtual void	StereoRenderOn ()
	Turn on/off stereo rendering.

virtual void	StereoRenderOff ()
	Turn on/off stereo rendering.


virtual void	SetAlphaBitPlanes (vtkTypeBool)
	Turn on/off the use of alpha bitplanes.

virtual vtkTypeBool	GetAlphaBitPlanes ()
	Turn on/off the use of alpha bitplanes.

virtual void	AlphaBitPlanesOn ()
	Turn on/off the use of alpha bitplanes.

virtual void	AlphaBitPlanesOff ()
	Turn on/off the use of alpha bitplanes.


virtual void	SetPointSmoothing (vtkTypeBool)
	Turn on/off point smoothing.

virtual vtkTypeBool	GetPointSmoothing ()
	Turn on/off point smoothing.

virtual void	PointSmoothingOn ()
	Turn on/off point smoothing.

virtual void	PointSmoothingOff ()
	Turn on/off point smoothing.


virtual void	SetLineSmoothing (vtkTypeBool)
	Turn on/off line smoothing.

virtual vtkTypeBool	GetLineSmoothing ()
	Turn on/off line smoothing.

virtual void	LineSmoothingOn ()
	Turn on/off line smoothing.

virtual void	LineSmoothingOff ()
	Turn on/off line smoothing.


virtual void	SetPolygonSmoothing (vtkTypeBool)
	Turn on/off polygon smoothing.

virtual vtkTypeBool	GetPolygonSmoothing ()
	Turn on/off polygon smoothing.

virtual void	PolygonSmoothingOn ()
	Turn on/off polygon smoothing.

virtual void	PolygonSmoothingOff ()
	Turn on/off polygon smoothing.


virtual int	GetStereoType ()
	Set/Get what type of stereo rendering to use.

void	SetStereoType (int)
	Set/Get what type of stereo rendering to use.

void	SetStereoTypeToCrystalEyes ()
	Set/Get what type of stereo rendering to use.

void	SetStereoTypeToRedBlue ()
	Set/Get what type of stereo rendering to use.

void	SetStereoTypeToInterlaced ()
	Set/Get what type of stereo rendering to use.

void	SetStereoTypeToLeft ()
	Set/Get what type of stereo rendering to use.

void	SetStereoTypeToRight ()
	Set/Get what type of stereo rendering to use.

void	SetStereoTypeToDresden ()
	Set/Get what type of stereo rendering to use.

void	SetStereoTypeToAnaglyph ()
	Set/Get what type of stereo rendering to use.

void	SetStereoTypeToCheckerboard ()
	Set/Get what type of stereo rendering to use.

void	SetStereoTypeToSplitViewportHorizontal ()
	Set/Get what type of stereo rendering to use.

void	SetStereoTypeToFake ()
	Set/Get what type of stereo rendering to use.

void	SetStereoTypeToEmulate ()
	Set/Get what type of stereo rendering to use.


virtual void	SetAnaglyphColorSaturation (float)
	Set/get the anaglyph color saturation factor.

virtual float	GetAnaglyphColorSaturation ()
	Set/get the anaglyph color saturation factor.


virtual void	SetAnaglyphColorMask (int, int)
	Set/get the anaglyph color mask values.

void	SetAnaglyphColorMask (int[2])
	Set/get the anaglyph color mask values.

virtual int *	GetAnaglyphColorMask ()
	Set/get the anaglyph color mask values.

virtual void	GetAnaglyphColorMask (int data[2])
	Set/get the anaglyph color mask values.


virtual void	SetSwapBuffers (vtkTypeBool)
	Turn on/off buffer swapping between images.

virtual vtkTypeBool	GetSwapBuffers ()
	Turn on/off buffer swapping between images.

virtual void	SwapBuffersOn ()
	Turn on/off buffer swapping between images.

virtual void	SwapBuffersOff ()
	Turn on/off buffer swapping between images.


virtual int	SetPixelData (int, int, int, int, unsigned char *, int, int=0)
	Set/Get the pixel data of an image, transmitted as RGBRGBRGB.

virtual int	SetPixelData (int, int, int, int, vtkUnsignedCharArray *, int, int=0)
	Set/Get the pixel data of an image, transmitted as RGBRGBRGB.


virtual float *	GetRGBAPixelData (int, int, int, int, int, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.

virtual int	GetRGBAPixelData (int, int, int, int, int, vtkFloatArray *, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.

virtual int	SetRGBAPixelData (int, int, int, int, float *, int, int=0, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.

virtual int	SetRGBAPixelData (int, int, int, int, vtkFloatArray *, int, int=0, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.

virtual void	ReleaseRGBAPixelData (float *)
	Same as Get/SetPixelData except that the image also contains an alpha component.

virtual unsigned char *	GetRGBACharPixelData (int, int, int, int, int, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.

virtual int	GetRGBACharPixelData (int, int, int, int, int, vtkUnsignedCharArray *, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.

virtual int	SetRGBACharPixelData (int, int, int, int, unsigned char *, int, int=0, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.

virtual int	SetRGBACharPixelData (int, int, int, int, vtkUnsignedCharArray *, int, int=0, int=0)
	Same as Get/SetPixelData except that the image also contains an alpha component.


virtual float *	GetZbufferData (int, int, int, int)
	Set/Get the zbuffer data from the frame buffer.

virtual int	GetZbufferData (int, int, int, int, float *)
	Set/Get the zbuffer data from the frame buffer.

virtual int	GetZbufferData (int, int, int, int, vtkFloatArray *)
	Set/Get the zbuffer data from the frame buffer.

virtual int	SetZbufferData (int, int, int, int, float *)
	Set/Get the zbuffer data from the frame buffer.

virtual int	SetZbufferData (int, int, int, int, vtkFloatArray *)
	Set/Get the zbuffer data from the frame buffer.

float	GetZbufferDataAtPoint (int x, int y)
	Set/Get the zbuffer data from the frame buffer.


virtual int	GetNeverRendered ()
	This flag is set if the window hasn't rendered since it was created.


virtual int	GetAbortRender ()
	This is a flag that can be set to interrupt a rendering that is in progress.

virtual void	SetAbortRender (int)
	This is a flag that can be set to interrupt a rendering that is in progress.

virtual int	GetInAbortCheck ()
	This is a flag that can be set to interrupt a rendering that is in progress.

virtual void	SetInAbortCheck (int)
	This is a flag that can be set to interrupt a rendering that is in progress.

virtual int	CheckAbortStatus ()
	This is a flag that can be set to interrupt a rendering that is in progress.


virtual void	SetDesiredUpdateRate (double)
	Set/Get the desired update rate.

virtual double	GetDesiredUpdateRate ()
	Set/Get the desired update rate.


virtual int	GetNumberOfLayers ()
	Get the number of layers for renderers.

virtual void	SetNumberOfLayers (int)
	Get the number of layers for renderers.


virtual vtkRenderWindowInteractor *	GetInteractor ()
	Get the interactor associated with this render window.


void	SetDisplayId (void *) override
	Dummy stubs for vtkWindow API.

void	SetWindowId (void *) override
	Dummy stubs for vtkWindow API.

virtual void	SetNextWindowId (void *)
	Dummy stubs for vtkWindow API.

void	SetParentId (void *) override
	Dummy stubs for vtkWindow API.

void *	GetGenericDisplayId () override
	Dummy stubs for vtkWindow API.

void *	GetGenericWindowId () override
	Dummy stubs for vtkWindow API.

void *	GetGenericParentId () override
	Dummy stubs for vtkWindow API.

void *	GetGenericContext () override
	Dummy stubs for vtkWindow API.

void *	GetGenericDrawable () override
	Dummy stubs for vtkWindow API.

void	SetWindowInfo (const char *) override
	Dummy stubs for vtkWindow API.

virtual void	SetNextWindowInfo (const char *)
	Dummy stubs for vtkWindow API.

void	SetParentInfo (const char *) override
	Dummy stubs for vtkWindow API.


virtual void	SetSharedRenderWindow (vtkRenderWindow *)
	Set/Get an already existing window that this window should share data with if possible.

virtual vtkRenderWindow *	GetSharedRenderWindow ()
	Set/Get an already existing window that this window should share data with if possible.

virtual bool	GetPlatformSupportsRenderWindowSharing ()
	Set/Get an already existing window that this window should share data with if possible.


virtual void	SetMultiSamples (int)
	Set / Get the number of multisamples to use for hardware antialiasing.

virtual int	GetMultiSamples ()
	Set / Get the number of multisamples to use for hardware antialiasing.


virtual void	SetStencilCapable (vtkTypeBool)
	Set / Get the availability of the stencil buffer.

virtual vtkTypeBool	GetStencilCapable ()
	Set / Get the availability of the stencil buffer.

virtual void	StencilCapableOn ()
	Set / Get the availability of the stencil buffer.

virtual void	StencilCapableOff ()
	Set / Get the availability of the stencil buffer.


virtual void	SetDeviceIndex (int)
	If there are several graphics card installed on a system, this index can be used to specify which card you want to render to.

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


virtual bool	GetUseSRGBColorSpace ()
	Set/Get if we want this window to use the sRGB color space.

virtual void	SetUseSRGBColorSpace (bool)
	Set/Get if we want this window to use the sRGB color space.

virtual void	UseSRGBColorSpaceOn ()
	Set/Get if we want this window to use the sRGB color space.

virtual void	UseSRGBColorSpaceOff ()
	Set/Get if we want this window to use the sRGB color space.


virtual void	SetPhysicalViewDirection (double, double, double)
	Set/get physical coordinate system in world coordinate system.

virtual void	SetPhysicalViewDirection (double[3])
	Set/get physical coordinate system in world coordinate system.

virtual double *	GetPhysicalViewDirection ()
	Set/get physical coordinate system in world coordinate system.

virtual void	GetPhysicalViewDirection (double &, double &, double &)
	Set/get physical coordinate system in world coordinate system.

virtual void	GetPhysicalViewDirection (double[3])
	Set/get physical coordinate system in world coordinate system.


virtual void	SetPhysicalViewUp (double, double, double)
	Set/get physical coordinate system in world coordinate system.

virtual void	SetPhysicalViewUp (double[3])
	Set/get physical coordinate system in world coordinate system.

virtual double *	GetPhysicalViewUp ()
	Set/get physical coordinate system in world coordinate system.

virtual void	GetPhysicalViewUp (double &, double &, double &)
	Set/get physical coordinate system in world coordinate system.

virtual void	GetPhysicalViewUp (double[3])
	Set/get physical coordinate system in world coordinate system.


virtual void	SetPhysicalTranslation (double, double, double)
	Set/get physical coordinate system in world coordinate system.

virtual void	SetPhysicalTranslation (double[3])
	Set/get physical coordinate system in world coordinate system.

virtual double *	GetPhysicalTranslation ()
	Set/get physical coordinate system in world coordinate system.

virtual void	GetPhysicalTranslation (double &, double &, double &)
	Set/get physical coordinate system in world coordinate system.

virtual void	GetPhysicalTranslation (double[3])
	Set/get physical coordinate system in world coordinate system.


virtual void	SetPhysicalScale (double)
	Set/get physical coordinate system in world coordinate system.

virtual double	GetPhysicalScale ()
	Set/get physical coordinate system in world coordinate system.


virtual bool	GetEnableTranslucentSurface ()
	Set/Get if we want this window to use a translucent surface with alpha channel support.

virtual void	SetEnableTranslucentSurface (bool)
	Set/Get if we want this window to use a translucent surface with alpha channel support.

virtual void	EnableTranslucentSurfaceOn ()
	Set/Get if we want this window to use a translucent surface with alpha channel support.

virtual void	EnableTranslucentSurfaceOff ()
	Set/Get if we want this window to use a translucent surface with alpha channel support.

Public Member Functions inherited from vtkWindow
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkWindow *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

int *	GetActualSize ()
	GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale.

virtual int *	GetScreenSize ()
	Get the current size of the screen in pixels.

virtual void	SetIcon (vtkImageData *)
	Set the icon used in title bar and task bar.

virtual VTK_UNBLOCKTHREADS void	Render ()
	Ask each viewport owned by this Window to render its image and synchronize this process.

virtual void	ReleaseGraphicsResources (vtkWindow *)
	Release any graphics resources that are being consumed by this texture.

virtual bool	DetectDPI ()
	Attempt to detect and set the DPI of the display device by querying the system.

vtkTypeBool	GetOffScreenRendering ()
	Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead.

virtual void	MakeCurrent ()
	Make the window current.

virtual void	ReleaseCurrent ()
	Release the current context.

virtual bool	EnsureDisplay ()
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

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

virtual void	SetPosition (int x, int y)
	Set the position (x and y) of the rendering window in screen coordinates (in pixels).

virtual void	SetPosition (int a[2])
	Get the position (x and y) of the rendering window in screen coordinates (in pixels).

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

virtual void	SetSize (int width, int height)
	Set the size (width and height) of the rendering window in screen coordinates (in pixels).

virtual void	SetSize (int a[2])
	Get the size (width and height) of the rendering window in screen coordinates (in pixels).

virtual vtkTypeBool	GetMapped ()
	Keep track of whether the rendering window has been mapped to screen.

virtual bool	GetShowWindow ()
	Show or not Show the window.

virtual void	SetShowWindow (bool)
	Show or not Show the window.

virtual void	ShowWindowOn ()
	Show or not Show the window.

virtual void	ShowWindowOff ()
	Show or not Show the window.

virtual void	SetUseOffScreenBuffers (bool)
	Render to an offscreen destination such as a framebuffer.

virtual bool	GetUseOffScreenBuffers ()
	Render to an offscreen destination such as a framebuffer.

virtual void	UseOffScreenBuffersOn ()
	Render to an offscreen destination such as a framebuffer.

virtual void	UseOffScreenBuffersOff ()
	Render to an offscreen destination such as a framebuffer.

virtual void	SetErase (vtkTypeBool)
	Turn on/off erasing the screen between images.

virtual vtkTypeBool	GetErase ()
	Turn on/off erasing the screen between images.

virtual void	EraseOn ()
	Turn on/off erasing the screen between images.

virtual void	EraseOff ()
	Turn on/off erasing the screen between images.

virtual void	SetDoubleBuffer (vtkTypeBool)
	Keep track of whether double buffering is on or off.

virtual vtkTypeBool	GetDoubleBuffer ()
	Keep track of whether double buffering is on or off.

virtual void	DoubleBufferOn ()
	Keep track of whether double buffering is on or off.

virtual void	DoubleBufferOff ()
	Keep track of whether double buffering is on or off.

virtual char *	GetWindowName ()
	Get name of rendering window.

virtual void	SetWindowName (const char *)
	Get name of rendering window.

virtual unsigned char *	GetPixelData (int, int, int, int, int, int=0)
	Get the pixel data of an image, transmitted as RGBRGBRGB.

virtual int	GetPixelData (int, int, int, int, int, vtkUnsignedCharArray *, int=0)
	Get the pixel data of an image, transmitted as RGBRGBRGB.

virtual int	GetDPI ()
	Return a best estimate to the dots per inch of the display device being rendered (or printed).

virtual void	SetDPI (int)
	Return a best estimate to the dots per inch of the display device being rendered (or printed).

void	SetOffScreenRendering (vtkTypeBool val)
	Convenience to set SHowWindow and UseOffScreenBuffers in one call.

virtual void	OffScreenRenderingOn ()
	Convenience to set SHowWindow and UseOffScreenBuffers in one call.

virtual void	OffScreenRenderingOff ()
	Convenience to set SHowWindow and UseOffScreenBuffers in one call.

virtual void	SetTileScale (int, int)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

void	SetTileScale (int[2])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual int *	GetTileScale ()
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual void	GetTileScale (int &, int &)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual void	GetTileScale (int[2])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

void	SetTileScale (int s)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual void	SetTileViewport (double, double, double, double)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual void	SetTileViewport (double[4])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual double *	GetTileViewport ()
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual void	GetTileViewport (double &, double &, double &, double &)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual void	GetTileViewport (double[4])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkRenderWindow *	SafeDownCast (vtkObjectBase *o)

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

static const char *	GetRenderLibrary ()
	What rendering library has the user requested.

Static Public Member Functions inherited from vtkWindow
static vtkTypeBool	IsTypeOf (const char *type)

static vtkWindow *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkRenderWindow ()

	~vtkRenderWindow () override

virtual void	DoStereoRender ()

Protected Member Functions inherited from vtkWindow
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkWindow ()

	~vtkWindow () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkRendererCollection *	Renderers

vtkNew< vtkRenderTimerLog >	RenderTimer

vtkTypeBool	Borders

vtkTypeBool	Coverable

vtkTypeBool	FullScreen

int	OldScreen [5]

vtkTypeBool	PointSmoothing

vtkTypeBool	LineSmoothing

vtkTypeBool	PolygonSmoothing

vtkTypeBool	StereoRender

int	StereoType

vtkTypeBool	StereoCapableWindow

vtkTypeBool	AlphaBitPlanes

vtkRenderWindowInteractor *	Interactor

vtkSmartPointer< vtkUnsignedCharArray >	StereoBuffer

vtkSmartPointer< vtkUnsignedCharArray >	ResultFrame

vtkTypeBool	SwapBuffers

double	DesiredUpdateRate

int	AbortRender

int	InAbortCheck

int	InRender

int	NeverRendered

int	NumberOfLayers

int	CurrentCursor

float	AnaglyphColorSaturation

int	AnaglyphColorMask [2]

int	MultiSamples

vtkTypeBool	StencilCapable

int	CapturingGL2PSSpecialProps

int	DeviceIndex

bool	UseSRGBColorSpace

char *	CursorFileName

double	AbortCheckTime
	The universal time since the last abort check occurred.

vtkRenderWindow *	SharedRenderWindow

double	PhysicalViewDirection [3] = { 0.0, 0.0, -1.0 }

double	PhysicalViewUp [3] = { 0.0, 1.0, 0.0 }

double	PhysicalTranslation [3] = { 0.0, 0.0, 0.0 }

double	PhysicalScale = 1.0

bool	EnableTranslucentSurface = false

bool	Initialized = false

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

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

static const char *	GetStereoTypeAsString (int type)
	Returns the stereo type as a string.

const char *	GetStereoTypeAsString ()
	Returns the stereo type as a string.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Events:: vtkCommand::AbortCheckEvent vtkCommand::EndEvent vtkCommand::StartEvent

Examples:: vtkRenderWindow (Examples)

Online Examples:

ImageToStructuredPoints

QuantizePolyDataPoints

SideBySideViewports

BandedPolyDataContourFilter

FlyingHeadSlice

LOxSeeds

Tests:: vtkRenderWindow (Tests)

Definition at line 196 of file vtkRenderWindow.h.

Member Typedef Documentation

◆ Superclass

typedef vtkWindow vtkRenderWindow::Superclass

Definition at line 199 of file vtkRenderWindow.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
PhysicalToWorldMatrixModified

Definition at line 858 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.

◆ 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 vtkObject.

Reimplemented in vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkWin32OpenGLDXRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkVRRenderWindow, vtkSDL2WebGPURenderWindow, vtkWebAssemblyWebGPURenderWindow, vtkWebGPURenderWindow, vtkXWebGPURenderWindow, vtkZSpaceGenericRenderWindow, and vtkZSpaceWin32RenderWindow.

◆ 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 vtkOpenXRRenderWindow, and vtkVRRenderWindow.

◆ RemoveRenderer()

void vtkRenderWindow::RemoveRenderer ( vtkRenderer * )

Remove a renderer from the list of renderers.

◆ HasRenderer()

vtkTypeBool 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, and vtkWebGPURenderWindow.

◆ 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 242 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.

Reimplemented from vtkWindow.

Reimplemented in vtkXOpenGLRenderWindow, vtkVRRenderWindow, vtkWebGPURenderWindow, and vtkXWebGPURenderWindow.

◆ Start()

virtual void vtkRenderWindow::Start ( )

inlinevirtual

Start the rendering process for a frame.

Reimplemented in vtkExternalOpenGLRenderWindow, vtkCocoaRenderWindow, vtkOpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkWebGPURenderWindow, vtkZSpaceGenericRenderWindow, and vtkZSpaceWin32RenderWindow.

Definition at line 269 of file vtkRenderWindow.h.

◆ End()

virtual void vtkRenderWindow::End ( )

inlinevirtual

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

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 274 of file vtkRenderWindow.h.

◆ Initialize()

virtual void vtkRenderWindow::Initialize ( )

inlinevirtual

Initializes the rendering process.

The responsibility to set the Initialized boolean to true is left to the subclass.

Reimplemented in vtkCocoaRenderWindow, vtkEGLRenderWindow, vtkIOSRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkWin32OpenGLDXRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkOpenVRRenderWindow, vtkOpenXRRenderWindow, vtkOpenXRRemotingRenderWindow, vtkSDL2WebGPURenderWindow, vtkWebGPURenderWindow, and vtkZSpaceWin32RenderWindow.

Definition at line 281 of file vtkRenderWindow.h.

◆ GetInitialized()

virtual bool vtkRenderWindow::GetInitialized ( )

virtual

Get/set whether or not the window has been initilized yet.

◆ Finalize()

virtual void vtkRenderWindow::Finalize ( )

inlinevirtual

Finalize the rendering process.

Reimplemented in vtkCocoaRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkIOSRenderWindow, vtkOSOpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkOpenVRRenderWindow, vtkOpenXRRenderWindow, vtkSDL2WebGPURenderWindow, vtkWebAssemblyWebGPURenderWindow, and vtkXWebGPURenderWindow.

Definition at line 293 of file vtkRenderWindow.h.

◆ Frame()

virtual void vtkRenderWindow::Frame ( )

inlinevirtual

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

Reimplemented in vtkCocoaRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkIOSRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkSDL2WebGPURenderWindow, vtkWebAssemblyWebGPURenderWindow, vtkWebGPURenderWindow, vtkXWebGPURenderWindow, vtkZSpaceGenericRenderWindow, and vtkZSpaceWin32RenderWindow.

Definition at line 299 of file vtkRenderWindow.h.

◆ WaitForCompletion()

virtual void vtkRenderWindow::WaitForCompletion ( )

inlinevirtual

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

Useful for measurement only.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 305 of file vtkRenderWindow.h.

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

Reimplemented in vtkOpenXRRemotingRenderWindow.

◆ 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, vtkOpenXRRenderWindow, and vtkVRRenderWindow.

◆ HideCursor()

virtual void vtkRenderWindow::HideCursor ( )

inlinevirtual

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

Reimplemented in vtkCocoaRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkIOSRenderWindow, vtkOSOpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkSDL2WebGPURenderWindow, vtkWebAssemblyWebGPURenderWindow, and vtkXWebGPURenderWindow.

Definition at line 327 of file vtkRenderWindow.h.

◆ ShowCursor()

virtual void vtkRenderWindow::ShowCursor ( )

inlinevirtual

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

Reimplemented in vtkCocoaRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkIOSRenderWindow, vtkOSOpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkSDL2WebGPURenderWindow, vtkWebAssemblyWebGPURenderWindow, and vtkXWebGPURenderWindow.

Definition at line 328 of file vtkRenderWindow.h.

◆ SetCursorPosition()

virtual void vtkRenderWindow::SetCursorPosition	(	int	,
		int
	)

inlinevirtual

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

Reimplemented in vtkCocoaRenderWindow, vtkIOSRenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 329 of file vtkRenderWindow.h.

◆ SetCurrentCursor()

virtual void vtkRenderWindow::SetCurrentCursor ( int )

virtual

Change the shape of the cursor.

Reimplemented in vtkGenericOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkXWebGPURenderWindow.

◆ GetCurrentCursor()

virtual int vtkRenderWindow::GetCurrentCursor ( )

virtual

Change the shape of the cursor.

◆ vtkSetFilePathMacro()

vtkRenderWindow::vtkSetFilePathMacro ( CursorFileName )

Set/Get the full path to the custom cursor.

This is used when the current cursor is set to VTK_CURSOR_CUSTOM.

◆ vtkGetFilePathMacro()

vtkRenderWindow::vtkGetFilePathMacro ( CursorFileName )

Set/Get the full path to the custom cursor.

This is used when the current cursor is set to VTK_CURSOR_CUSTOM.

◆ SetFullScreen()

virtual void vtkRenderWindow::SetFullScreen ( vtkTypeBool )

inlinevirtual

Turn on/off rendering full screen window size.

Reimplemented in vtkCocoaRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkIOSRenderWindow, vtkOSOpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkSDL2WebGPURenderWindow, vtkWebAssemblyWebGPURenderWindow, and vtkXWebGPURenderWindow.

Definition at line 353 of file vtkRenderWindow.h.

◆ GetFullScreen()

virtual vtkTypeBool vtkRenderWindow::GetFullScreen ( )

virtual

Turn on/off rendering full screen window size.

◆ FullScreenOn()

virtual void vtkRenderWindow::FullScreenOn ( )

virtual

Turn on/off rendering full screen window size.

◆ FullScreenOff()

virtual void vtkRenderWindow::FullScreenOff ( )

virtual

Turn on/off rendering full screen window size.

◆ 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

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.

◆ BordersOn()

virtual void vtkRenderWindow::BordersOn ( )

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.

◆ BordersOff()

virtual void vtkRenderWindow::BordersOff ( )

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.

◆ GetCoverable()

virtual vtkTypeBool vtkRenderWindow::GetCoverable ( )

virtual

Set/Get whether windows should be coverable (as opposed to always on top).

◆ CoverableOn()

virtual void vtkRenderWindow::CoverableOn ( )

virtual

Set/Get whether windows should be coverable (as opposed to always on top).

◆ CoverableOff()

virtual void vtkRenderWindow::CoverableOff ( )

virtual

Set/Get whether windows should be coverable (as opposed to always on top).

◆ SetCoverable()

virtual void vtkRenderWindow::SetCoverable ( vtkTypeBool coverable )

virtual

Set/Get whether windows should be coverable (as opposed to always on top).

Reimplemented in vtkXOpenGLRenderWindow.

◆ 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

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

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

◆ StereoCapableWindowOff()

virtual void vtkRenderWindow::StereoCapableWindowOff ( )

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.

◆ SetStereoCapableWindow()

virtual void vtkRenderWindow::SetStereoCapableWindow ( vtkTypeBool capable )

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.

Reimplemented in vtkCocoaRenderWindow, vtkEGLRenderWindow, vtkIOSRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkXWebGPURenderWindow.

◆ GetStereoRender()

virtual vtkTypeBool vtkRenderWindow::GetStereoRender ( )

virtual

Turn on/off stereo rendering.

◆ SetStereoRender()

void vtkRenderWindow::SetStereoRender ( vtkTypeBool stereo )

Turn on/off stereo rendering.

◆ StereoRenderOn()

virtual void vtkRenderWindow::StereoRenderOn ( )

virtual

Turn on/off stereo rendering.

◆ StereoRenderOff()

virtual void vtkRenderWindow::StereoRenderOff ( )

virtual

Turn on/off stereo rendering.

◆ SetAlphaBitPlanes()

virtual void vtkRenderWindow::SetAlphaBitPlanes ( vtkTypeBool )

virtual

Turn on/off the use of alpha bitplanes.

◆ GetAlphaBitPlanes()

virtual vtkTypeBool vtkRenderWindow::GetAlphaBitPlanes ( )

virtual

Turn on/off the use of alpha bitplanes.

◆ AlphaBitPlanesOn()

virtual void vtkRenderWindow::AlphaBitPlanesOn ( )

virtual

Turn on/off the use of alpha bitplanes.

◆ AlphaBitPlanesOff()

virtual void vtkRenderWindow::AlphaBitPlanesOff ( )

virtual

Turn on/off the use of alpha bitplanes.

◆ 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

Turn on/off point smoothing.

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

◆ PointSmoothingOn()

virtual void vtkRenderWindow::PointSmoothingOn ( )

virtual

Turn on/off point smoothing.

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

◆ PointSmoothingOff()

virtual void vtkRenderWindow::PointSmoothingOff ( )

virtual

Turn on/off point smoothing.

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

◆ 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

Turn on/off line smoothing.

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

◆ LineSmoothingOn()

virtual void vtkRenderWindow::LineSmoothingOn ( )

virtual

Turn on/off line smoothing.

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

◆ LineSmoothingOff()

virtual void vtkRenderWindow::LineSmoothingOff ( )

virtual

Turn on/off line smoothing.

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

◆ 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

Turn on/off polygon smoothing.

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

◆ PolygonSmoothingOn()

virtual void vtkRenderWindow::PolygonSmoothingOn ( )

virtual

Turn on/off polygon smoothing.

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

◆ PolygonSmoothingOff()

virtual void vtkRenderWindow::PolygonSmoothingOff ( )

virtual

Turn on/off polygon smoothing.

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

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

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.

◆ SetStereoTypeToCrystalEyes()

void vtkRenderWindow::SetStereoTypeToCrystalEyes ( )

inline

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.

Definition at line 461 of file vtkRenderWindow.h.

◆ SetStereoTypeToRedBlue()

void vtkRenderWindow::SetStereoTypeToRedBlue ( )

inline

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.

Definition at line 462 of file vtkRenderWindow.h.

◆ SetStereoTypeToInterlaced()

void vtkRenderWindow::SetStereoTypeToInterlaced ( )

inline

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.

Definition at line 463 of file vtkRenderWindow.h.

◆ SetStereoTypeToLeft()

void vtkRenderWindow::SetStereoTypeToLeft ( )

inline

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.

Definition at line 464 of file vtkRenderWindow.h.

◆ SetStereoTypeToRight()

void vtkRenderWindow::SetStereoTypeToRight ( )

inline

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.

Definition at line 465 of file vtkRenderWindow.h.

◆ SetStereoTypeToDresden()

void vtkRenderWindow::SetStereoTypeToDresden ( )

inline

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.

Definition at line 466 of file vtkRenderWindow.h.

◆ SetStereoTypeToAnaglyph()

void vtkRenderWindow::SetStereoTypeToAnaglyph ( )

inline

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.

Definition at line 467 of file vtkRenderWindow.h.

◆ SetStereoTypeToCheckerboard()

void vtkRenderWindow::SetStereoTypeToCheckerboard ( )

inline

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.

Definition at line 468 of file vtkRenderWindow.h.

◆ SetStereoTypeToSplitViewportHorizontal()

void vtkRenderWindow::SetStereoTypeToSplitViewportHorizontal ( )

inline

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.

Definition at line 469 of file vtkRenderWindow.h.

◆ SetStereoTypeToFake()

void vtkRenderWindow::SetStereoTypeToFake ( )

inline

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.

Definition at line 473 of file vtkRenderWindow.h.

◆ SetStereoTypeToEmulate()

void vtkRenderWindow::SetStereoTypeToEmulate ( )

inline

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.

Definition at line 474 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

Returns the stereo type as a string.

◆ 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 vtkOpenXRRenderWindow, and vtkOpenXRRemotingRenderWindow.

◆ StereoMidpoint()

virtual void vtkRenderWindow::StereoMidpoint ( )

virtual

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

Reimplemented in vtkOpenGLRenderWindow, vtkOpenVRRenderWindow, vtkOpenXRRenderWindow, vtkOpenXRRemotingRenderWindow, vtkWebGPURenderWindow, vtkZSpaceGenericRenderWindow, and vtkZSpaceWin32RenderWindow.

◆ StereoRenderComplete()

virtual void vtkRenderWindow::StereoRenderComplete ( )

virtual

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

Reimplemented in vtkOpenVRRenderWindow, vtkOpenXRRenderWindow, vtkOpenXRRemotingRenderWindow, vtkZSpaceGenericRenderWindow, and vtkZSpaceWin32RenderWindow.

◆ 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

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.

◆ 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] )

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.

◆ GetAnaglyphColorMask() [1/2]

virtual int * vtkRenderWindow::GetAnaglyphColorMask ( )

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.

◆ GetAnaglyphColorMask() [2/2]

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

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.

◆ WindowRemap()

virtual void vtkRenderWindow::WindowRemap ( )

inlinevirtual

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.

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

Definition at line 539 of file vtkRenderWindow.h.

◆ SetSwapBuffers()

virtual void vtkRenderWindow::SetSwapBuffers ( vtkTypeBool )

virtual

Turn on/off buffer swapping between images.

◆ GetSwapBuffers()

virtual vtkTypeBool vtkRenderWindow::GetSwapBuffers ( )

virtual

Turn on/off buffer swapping between images.

◆ SwapBuffersOn()

virtual void vtkRenderWindow::SwapBuffersOn ( )

virtual

Turn on/off buffer swapping between images.

◆ SwapBuffersOff()

virtual void vtkRenderWindow::SwapBuffersOff ( )

virtual

Turn on/off buffer swapping between images.

◆ SetPixelData() [1/2]

virtual int vtkRenderWindow::SetPixelData	(	int	,
		int	,
		int	,
		int	,
		unsigned char *	,
		int	,
		int	= `0`
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, vtkWebGPURenderWindow, and vtkGenericOpenGLRenderWindow.

Definition at line 563 of file vtkRenderWindow.h.

◆ SetPixelData() [2/2]

virtual int vtkRenderWindow::SetPixelData	(	int	,
		int	,
		int	,
		int	,
		vtkUnsignedCharArray *	,
		int	,
		int	= `0`
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, vtkWebGPURenderWindow, and vtkGenericOpenGLRenderWindow.

Definition at line 568 of file vtkRenderWindow.h.

◆ GetRGBAPixelData() [1/2]

virtual float * vtkRenderWindow::GetRGBAPixelData	(	int	,
		int	,
		int	,
		int	,
		int	,
		int	= `0`
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 583 of file vtkRenderWindow.h.

◆ GetRGBAPixelData() [2/2]

virtual int vtkRenderWindow::GetRGBAPixelData	(	int	,
		int	,
		int	,
		int	,
		int	,
		vtkFloatArray *	,
		int	= `0`
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 588 of file vtkRenderWindow.h.

◆ SetRGBAPixelData() [1/2]

virtual int vtkRenderWindow::SetRGBAPixelData	(	int	,
		int	,
		int	,
		int	,
		float *	,
		int	,
		int	= `0`,
		int	= `0`
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 593 of file vtkRenderWindow.h.

◆ SetRGBAPixelData() [2/2]

virtual int vtkRenderWindow::SetRGBAPixelData	(	int	,
		int	,
		int	,
		int	,
		vtkFloatArray *	,
		int	,
		int	= `0`,
		int	= `0`
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 598 of file vtkRenderWindow.h.

◆ ReleaseRGBAPixelData()

virtual void vtkRenderWindow::ReleaseRGBAPixelData ( float * )

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 603 of file vtkRenderWindow.h.

◆ GetRGBACharPixelData() [1/2]

virtual unsigned char * vtkRenderWindow::GetRGBACharPixelData	(	int	,
		int	,
		int	,
		int	,
		int	,
		int	= `0`
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 604 of file vtkRenderWindow.h.

◆ GetRGBACharPixelData() [2/2]

virtual int vtkRenderWindow::GetRGBACharPixelData	(	int	,
		int	,
		int	,
		int	,
		int	,
		vtkUnsignedCharArray *	,
		int	= `0`
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 609 of file vtkRenderWindow.h.

◆ SetRGBACharPixelData() [1/2]

virtual int vtkRenderWindow::SetRGBACharPixelData	(	int	,
		int	,
		int	,
		int	,
		unsigned char *	,
		int	,
		int	= `0`,
		int	= `0`
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, vtkWebGPURenderWindow, and vtkGenericOpenGLRenderWindow.

Definition at line 614 of file vtkRenderWindow.h.

◆ SetRGBACharPixelData() [2/2]

virtual int vtkRenderWindow::SetRGBACharPixelData	(	int	,
		int	,
		int	,
		int	,
		vtkUnsignedCharArray *	,
		int	,
		int	= `0`,
		int	= `0`
	)

inlinevirtual

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.

Reimplemented in vtkGenericOpenGLRenderWindow, vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 619 of file vtkRenderWindow.h.

◆ GetZbufferData() [1/3]

virtual float * vtkRenderWindow::GetZbufferData	(	int	,
		int	,
		int	,
		int
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 632 of file vtkRenderWindow.h.

◆ GetZbufferData() [2/3]

virtual int vtkRenderWindow::GetZbufferData	(	int	,
		int	,
		int	,
		int	,
		float *
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 633 of file vtkRenderWindow.h.

◆ GetZbufferData() [3/3]

virtual int vtkRenderWindow::GetZbufferData	(	int	,
		int	,
		int	,
		int	,
		vtkFloatArray *
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 637 of file vtkRenderWindow.h.

◆ SetZbufferData() [1/2]

virtual int vtkRenderWindow::SetZbufferData	(	int	,
		int	,
		int	,
		int	,
		float *
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 641 of file vtkRenderWindow.h.

◆ SetZbufferData() [2/2]

virtual int vtkRenderWindow::SetZbufferData	(	int	,
		int	,
		int	,
		int	,
		vtkFloatArray *
	)

inlinevirtual

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.

Reimplemented in vtkOpenGLRenderWindow, and vtkWebGPURenderWindow.

Definition at line 645 of file vtkRenderWindow.h.

◆ GetZbufferDataAtPoint()

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

inline

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.

Definition at line 649 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

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

◆ GetInAbortCheck()

virtual int vtkRenderWindow::GetInAbortCheck ( )

virtual

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

◆ SetInAbortCheck()

virtual void vtkRenderWindow::SetInAbortCheck ( int )

virtual

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

◆ CheckAbortStatus()

virtual int vtkRenderWindow::CheckAbortStatus ( )

virtual

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

◆ GetEventPending()

virtual vtkTypeBool vtkRenderWindow::GetEventPending ( )

inlinevirtual

Check to see if a mouse button has been pressed.

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

Reimplemented in vtkCocoaRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkIOSRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkOpenXRRenderWindow, vtkVRRenderWindow, and vtkXWebGPURenderWindow.

Definition at line 682 of file vtkRenderWindow.h.

◆ CheckInRenderStatus()

virtual int vtkRenderWindow::CheckInRenderStatus ( )

inlinevirtual

Are we rendering at the moment.

Definition at line 687 of file vtkRenderWindow.h.

◆ ClearInRenderStatus()

virtual void vtkRenderWindow::ClearInRenderStatus ( )

inlinevirtual

Clear status (after an exception was thrown for example)

Definition at line 692 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

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.

◆ 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

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

◆ GetInteractor()

virtual vtkRenderWindowInteractor * vtkRenderWindow::GetInteractor ( )

virtual

Get the interactor associated with this render window.

◆ SetInteractor()

virtual void vtkRenderWindow::SetInteractor ( vtkRenderWindowInteractor * )

virtual

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

inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkWindow.

Reimplemented in vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkXWebGPURenderWindow.

Definition at line 740 of file vtkRenderWindow.h.

◆ SetWindowId()

void vtkRenderWindow::SetWindowId ( void * )

inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkWindow.

Reimplemented in vtkXOpenGLRenderWindow, vtkXWebGPURenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 741 of file vtkRenderWindow.h.

◆ SetNextWindowId()

virtual void vtkRenderWindow::SetNextWindowId ( void * )

inlinevirtual

Dummy stubs for vtkWindow API.

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

Definition at line 742 of file vtkRenderWindow.h.

◆ SetParentId()

void vtkRenderWindow::SetParentId ( void * )

inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkWindow.

Reimplemented in vtkXOpenGLRenderWindow, vtkXWebGPURenderWindow, and vtkWin32OpenGLRenderWindow.

Definition at line 743 of file vtkRenderWindow.h.

◆ GetGenericDisplayId()

void * vtkRenderWindow::GetGenericDisplayId ( )

inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkWindow.

Reimplemented in vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkVRRenderWindow, and vtkXWebGPURenderWindow.

Definition at line 744 of file vtkRenderWindow.h.

◆ GetGenericWindowId()

void * vtkRenderWindow::GetGenericWindowId ( )

inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkWindow.

Reimplemented in vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkVRRenderWindow, vtkSDL2WebGPURenderWindow, vtkWebAssemblyWebGPURenderWindow, and vtkXWebGPURenderWindow.

Definition at line 745 of file vtkRenderWindow.h.

◆ GetGenericParentId()

void * vtkRenderWindow::GetGenericParentId ( )

inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkWindow.

Reimplemented in vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkVRRenderWindow, and vtkXWebGPURenderWindow.

Definition at line 746 of file vtkRenderWindow.h.

◆ GetGenericContext()

void * vtkRenderWindow::GetGenericContext ( )

inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkWindow.

Reimplemented in vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkVRRenderWindow.

Definition at line 747 of file vtkRenderWindow.h.

◆ GetGenericDrawable()

void * vtkRenderWindow::GetGenericDrawable ( )

inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkWindow.

Reimplemented in vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkVRRenderWindow, vtkSDL2WebGPURenderWindow, vtkWebAssemblyWebGPURenderWindow, and vtkXWebGPURenderWindow.

Definition at line 748 of file vtkRenderWindow.h.

◆ SetWindowInfo()

void vtkRenderWindow::SetWindowInfo ( const char * )

inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkWindow.

Reimplemented in vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkXWebGPURenderWindow.

Definition at line 749 of file vtkRenderWindow.h.

◆ SetNextWindowInfo()

virtual void vtkRenderWindow::SetNextWindowInfo ( const char * )

inlinevirtual

Dummy stubs for vtkWindow API.

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

Definition at line 750 of file vtkRenderWindow.h.

◆ SetParentInfo()

void vtkRenderWindow::SetParentInfo ( const char * )

inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkWindow.

Reimplemented in vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkXWebGPURenderWindow.

Definition at line 751 of file vtkRenderWindow.h.

◆ InitializeFromCurrentContext()

virtual bool vtkRenderWindow::InitializeFromCurrentContext ( )

inlinevirtual

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

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

Definition at line 758 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

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.

◆ GetPlatformSupportsRenderWindowSharing()

virtual bool vtkRenderWindow::GetPlatformSupportsRenderWindowSharing ( )

inlinevirtual

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.

Reimplemented in vtkCocoaRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkXWebGPURenderWindow.

Definition at line 770 of file vtkRenderWindow.h.

◆ IsCurrent()

virtual bool vtkRenderWindow::IsCurrent ( )

inlinevirtual

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

Reimplemented in vtkExternalOpenGLRenderWindow, vtkCocoaRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkIOSRenderWindow, vtkOSOpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkVRRenderWindow, vtkSDL2WebGPURenderWindow, and vtkWebAssemblyWebGPURenderWindow.

Definition at line 777 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, vtkOSOpenGLRenderWindow, and vtkXOpenGLRenderWindow.

Definition at line 784 of file vtkRenderWindow.h.

◆ ReportCapabilities()

virtual const char * vtkRenderWindow::ReportCapabilities ( )

inlinevirtual

Get report of capabilities for the render window.

Reimplemented in vtkCocoaRenderWindow, vtkEGLRenderWindow, vtkIOSRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkOpenXRRenderWindow, vtkVRRenderWindow, vtkWebGPURenderWindow, and vtkXWebGPURenderWindow.

Definition at line 789 of file vtkRenderWindow.h.

◆ SupportsOpenGL()

virtual int vtkRenderWindow::SupportsOpenGL ( )

inlinevirtual

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

Reimplemented in vtkGenericOpenGLRenderWindow, vtkIOSRenderWindow, vtkOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkVRRenderWindow, and vtkWebGPURenderWindow.

Definition at line 794 of file vtkRenderWindow.h.

◆ IsDirect()

virtual vtkTypeBool vtkRenderWindow::IsDirect ( )

inlinevirtual

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

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

Definition at line 799 of file vtkRenderWindow.h.

◆ GetDepthBufferSize()

virtual int vtkRenderWindow::GetDepthBufferSize ( )

inlinevirtual

This method should be defined by the subclass.

How many bits of precision are there in the zbuffer?

Reimplemented in vtkIOSRenderWindow, and vtkOpenGLRenderWindow.

Definition at line 805 of file vtkRenderWindow.h.

◆ GetColorBufferSizes()

virtual int vtkRenderWindow::GetColorBufferSizes ( int * )

inlinevirtual

Get the size of the color buffer.

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

Reimplemented in vtkOpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkSDL2WebGPURenderWindow, vtkWebAssemblyWebGPURenderWindow, and vtkWebGPURenderWindow.

Definition at line 811 of file vtkRenderWindow.h.

◆ 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. Related to OpenGL parameter GL_MAX_SAMPLES.

◆ GetMultiSamples()

virtual int vtkRenderWindow::GetMultiSamples ( )

virtual

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

A value of 1 will be set to 0. Related to OpenGL parameter GL_MAX_SAMPLES.

◆ SetStencilCapable()

virtual void vtkRenderWindow::SetStencilCapable ( vtkTypeBool )

virtual

Set / Get the availability of the stencil buffer.

◆ GetStencilCapable()

virtual vtkTypeBool vtkRenderWindow::GetStencilCapable ( )

virtual

Set / Get the availability of the stencil buffer.

◆ StencilCapableOn()

virtual void vtkRenderWindow::StencilCapableOn ( )

virtual

Set / Get the availability of the stencil buffer.

◆ StencilCapableOff()

virtual void vtkRenderWindow::StencilCapableOff ( )

virtual

Set / Get the availability of the stencil buffer.

◆ 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

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.

◆ 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 846 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

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

Some hardware/drivers do not fully support this.

◆ UseSRGBColorSpaceOn()

virtual void vtkRenderWindow::UseSRGBColorSpaceOn ( )

virtual

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

Some hardware/drivers do not fully support this.

◆ UseSRGBColorSpaceOff()

virtual void vtkRenderWindow::UseSRGBColorSpaceOff ( )

virtual

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

Some hardware/drivers do not fully support this.