window superclass for vtkRenderWindow More...

#include <vtkWindow.h>

Inheritance diagram for vtkWindow:

Collaboration diagram for vtkWindow:

Public Types
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.

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 void	SetDisplayId (void *)
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

virtual void	SetWindowId (void *)
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

virtual void	SetParentId (void *)
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

virtual void *	GetGenericDisplayId ()
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

virtual void *	GetGenericWindowId ()
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

virtual void *	GetGenericParentId ()
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

virtual void *	GetGenericContext ()
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

virtual void *	GetGenericDrawable ()
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

virtual void	SetWindowInfo (const char *)
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

virtual void	SetParentInfo (const char *)
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

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

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

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

window superclass for vtkRenderWindow

vtkWindow is an abstract object to specify the behavior of a rendering window. It contains vtkViewports.

See also: vtkRenderWindow vtkViewport

Events:: vtkCommand::WindowResizeEvent

Online Examples:

AnimateActors

Definition at line 47 of file vtkWindow.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkWindow::Superclass

Definition at line 50 of file vtkWindow.h.

Constructor & Destructor Documentation

◆ vtkWindow()

vtkWindow::vtkWindow ( )

protected

◆ ~vtkWindow()

vtkWindow::~vtkWindow ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

◆ NewInstance()

vtkWindow * vtkWindow::NewInstance ( ) const

◆ PrintSelf()

void vtkWindow::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 vtkXOpenGLRenderWindow, vtkXWebGPURenderWindow, vtkZSpaceGenericRenderWindow, and vtkZSpaceWin32RenderWindow.

◆ SetDisplayId()

virtual void vtkWindow::SetDisplayId ( void * )

inlinevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

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

Definition at line 58 of file vtkWindow.h.

◆ SetWindowId()

virtual void vtkWindow::SetWindowId ( void * )

inlinevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

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

Definition at line 59 of file vtkWindow.h.

◆ SetParentId()

virtual void vtkWindow::SetParentId ( void * )

inlinevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

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

Definition at line 60 of file vtkWindow.h.

◆ GetGenericDisplayId()

virtual void * vtkWindow::GetGenericDisplayId ( )

inlinevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

Reimplemented in vtkRenderWindow, vtkCocoaRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkIOSRenderWindow, vtkOSOpenGLRenderWindow, vtkSDL2OpenGLRenderWindow, vtkWebAssemblyOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkWin32HardwareWindow, vtkVRRenderWindow, and vtkXWebGPURenderWindow.

Definition at line 61 of file vtkWindow.h.

◆ GetGenericWindowId()

virtual void * vtkWindow::GetGenericWindowId ( )

inlinevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

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

Definition at line 62 of file vtkWindow.h.

◆ GetGenericParentId()

virtual void * vtkWindow::GetGenericParentId ( )

inlinevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

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

Definition at line 63 of file vtkWindow.h.

◆ GetGenericContext()

virtual void * vtkWindow::GetGenericContext ( )

inlinevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

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

Definition at line 64 of file vtkWindow.h.

◆ GetGenericDrawable()

virtual void * vtkWindow::GetGenericDrawable ( )

inlinevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

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

Definition at line 65 of file vtkWindow.h.

◆ SetWindowInfo()

virtual void vtkWindow::SetWindowInfo ( const char * )

inlinevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

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

Definition at line 66 of file vtkWindow.h.

◆ SetParentInfo()

virtual void vtkWindow::SetParentInfo ( const char * )

inlinevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

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

Definition at line 67 of file vtkWindow.h.

◆ EnsureDisplay()

virtual bool vtkWindow::EnsureDisplay ( )

inlinevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

Reimplemented in vtkXOpenGLRenderWindow, and vtkXWebGPURenderWindow.

Definition at line 68 of file vtkWindow.h.

◆ GetPosition()

virtual int * vtkWindow::GetPosition ( )

virtual

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

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

◆ SetPosition() [1/2]

virtual void vtkWindow::SetPosition	(	int	x,
		int	y
	)

virtual

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

This resizes the operating system's view/window and redraws it.

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

◆ SetPosition() [2/2]

virtual void vtkWindow::SetPosition ( int a[2] )

virtual

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

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

◆ GetSize()

virtual int * vtkWindow::GetSize ( )

virtual

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

Reimplemented in vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkSDL2OpenGLRenderWindow, vtkWin32OpenGLRenderWindow, and vtkSDL2WebGPURenderWindow.

◆ SetSize() [1/2]

virtual void vtkWindow::SetSize	(	int	width,
		int	height
	)

virtual

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

This resizes the operating system's view/window and redraws it.

If the size has changed, this method will fire vtkCommand::WindowResizeEvent.

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

◆ SetSize() [2/2]

virtual void vtkWindow::SetSize ( int a[2] )

virtual

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

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

◆ GetActualSize()

int * vtkWindow::GetActualSize ( )

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

Measured in pixels.

◆ GetScreenSize()

virtual int * vtkWindow::GetScreenSize ( )

inlinevirtual

Get the current size of the screen in pixels.

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

Definition at line 116 of file vtkWindow.h.

◆ GetMapped()

virtual vtkTypeBool vtkWindow::GetMapped ( )

virtual

Keep track of whether the rendering window has been mapped to screen.

◆ GetShowWindow()

virtual bool vtkWindow::GetShowWindow ( )

virtual

Show or not Show the window.

◆ SetShowWindow()

virtual void vtkWindow::SetShowWindow ( bool )

virtual

Show or not Show the window.

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

◆ ShowWindowOn()

virtual void vtkWindow::ShowWindowOn ( )

virtual

Show or not Show the window.

◆ ShowWindowOff()

virtual void vtkWindow::ShowWindowOff ( )

virtual

Show or not Show the window.

◆ SetUseOffScreenBuffers()

virtual void vtkWindow::SetUseOffScreenBuffers ( bool )

virtual

Render to an offscreen destination such as a framebuffer.

All four combinations of ShowWindow and UseOffScreenBuffers should work for most rendering backends.

◆ GetUseOffScreenBuffers()

virtual bool vtkWindow::GetUseOffScreenBuffers ( )

virtual

Render to an offscreen destination such as a framebuffer.

All four combinations of ShowWindow and UseOffScreenBuffers should work for most rendering backends.

◆ UseOffScreenBuffersOn()

virtual void vtkWindow::UseOffScreenBuffersOn ( )

virtual

Render to an offscreen destination such as a framebuffer.

All four combinations of ShowWindow and UseOffScreenBuffers should work for most rendering backends.

◆ UseOffScreenBuffersOff()

virtual void vtkWindow::UseOffScreenBuffersOff ( )

virtual

Render to an offscreen destination such as a framebuffer.

All four combinations of ShowWindow and UseOffScreenBuffers should work for most rendering backends.

◆ SetErase()

virtual void vtkWindow::SetErase ( vtkTypeBool )

virtual

Turn on/off erasing the screen between images.

This allows multiple exposure sequences if turned on. You will need to turn double buffering off or make use of the SwapBuffers methods to prevent you from swapping buffers between exposures.

◆ GetErase()

virtual vtkTypeBool vtkWindow::GetErase ( )

virtual

Turn on/off erasing the screen between images.

This allows multiple exposure sequences if turned on. You will need to turn double buffering off or make use of the SwapBuffers methods to prevent you from swapping buffers between exposures.

◆ EraseOn()

virtual void vtkWindow::EraseOn ( )

virtual

Turn on/off erasing the screen between images.

This allows multiple exposure sequences if turned on. You will need to turn double buffering off or make use of the SwapBuffers methods to prevent you from swapping buffers between exposures.

◆ EraseOff()

virtual void vtkWindow::EraseOff ( )

virtual

Turn on/off erasing the screen between images.

This allows multiple exposure sequences if turned on. You will need to turn double buffering off or make use of the SwapBuffers methods to prevent you from swapping buffers between exposures.

◆ SetDoubleBuffer()

virtual void vtkWindow::SetDoubleBuffer ( vtkTypeBool )

virtual

Keep track of whether double buffering is on or off.

◆ GetDoubleBuffer()

virtual vtkTypeBool vtkWindow::GetDoubleBuffer ( )

virtual

Keep track of whether double buffering is on or off.

◆ DoubleBufferOn()

virtual void vtkWindow::DoubleBufferOn ( )

virtual

Keep track of whether double buffering is on or off.

◆ DoubleBufferOff()

virtual void vtkWindow::DoubleBufferOff ( )

virtual

Keep track of whether double buffering is on or off.

◆ GetWindowName()

virtual char * vtkWindow::GetWindowName ( )

virtual

Get name of rendering window.

◆ SetWindowName()

virtual void vtkWindow::SetWindowName ( const char * )

virtual

Get name of rendering window.

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

◆ SetIcon()

virtual void vtkWindow::SetIcon ( vtkImageData * )

inlinevirtual

Set the icon used in title bar and task bar.

Currently implemented for OpenGL windows on Windows and Linux.

Reimplemented in vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkXWebGPURenderWindow.

Definition at line 180 of file vtkWindow.h.

◆ Render()

virtual VTK_UNBLOCKTHREADS void vtkWindow::Render ( )

inlinevirtual

Ask each viewport owned by this Window to render its image and synchronize this process.

Reimplemented in vtkRenderWindow, vtkCocoaRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkOpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkOpenVRRenderWindow, vtkOpenXRRenderWindow, vtkVRRenderWindow, vtkWebGPURenderWindow, and vtkXWebGPURenderWindow.

Definition at line 187 of file vtkWindow.h.

◆ ReleaseGraphicsResources()

virtual void vtkWindow::ReleaseGraphicsResources ( vtkWindow * )

inlinevirtual

Release any graphics resources that are being consumed by this texture.

The parameter window could be used to determine which graphic resources to release.

Reimplemented in vtkOpenGLRenderWindow, vtkVRRenderWindow, and vtkWebGPURenderWindow.

Definition at line 194 of file vtkWindow.h.

◆ GetPixelData() [1/2]

virtual unsigned char * vtkWindow::GetPixelData	(	int	,
		int	,
		int	,
		int	,
		int	,
		int	= `0`
	)

inlinevirtual

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

Definition at line 209 of file vtkWindow.h.

◆ GetPixelData() [2/2]

virtual int vtkWindow::GetPixelData	(	int	,
		int	,
		int	,
		int	,
		int	,
		vtkUnsignedCharArray *	,
		int	= `0`
	)

inlinevirtual

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

Definition at line 214 of file vtkWindow.h.

◆ GetDPI()

virtual int vtkWindow::GetDPI ( )

virtual

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

◆ SetDPI()

virtual void vtkWindow::SetDPI ( int )

virtual

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

◆ DetectDPI()

virtual bool vtkWindow::DetectDPI ( )

inlinevirtual

Attempt to detect and set the DPI of the display device by querying the system.

Note that this is not supported on most backends, and this method will return false if the DPI could not be detected. Use GetDPI() to inspect the detected value.

Reimplemented in vtkWin32OpenGLRenderWindow.

Definition at line 237 of file vtkWindow.h.

◆ SetOffScreenRendering()

void vtkWindow::SetOffScreenRendering ( vtkTypeBool val )

inline

Convenience to set SHowWindow and UseOffScreenBuffers in one call.

Definition at line 244 of file vtkWindow.h.

◆ OffScreenRenderingOn()

virtual void vtkWindow::OffScreenRenderingOn ( )

virtual

Convenience to set SHowWindow and UseOffScreenBuffers in one call.

◆ OffScreenRenderingOff()

virtual void vtkWindow::OffScreenRenderingOff ( )

virtual

Convenience to set SHowWindow and UseOffScreenBuffers in one call.

◆ GetOffScreenRendering()

vtkTypeBool vtkWindow::GetOffScreenRendering ( )

inline

Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead.

Definition at line 257 of file vtkWindow.h.

◆ MakeCurrent()

virtual void vtkWindow::MakeCurrent ( )

inlinevirtual

Make the window current.

May be overridden in subclasses to do for example a glXMakeCurrent or a wglMakeCurrent.

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

Definition at line 263 of file vtkWindow.h.

◆ ReleaseCurrent()

virtual void vtkWindow::ReleaseCurrent ( )

inlinevirtual

Release the current context.

May be overridden in subclasses to do for example a glXMakeCurrent or a wglMakeCurrent.

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

Definition at line 269 of file vtkWindow.h.

◆ SetTileScale() [1/3]

virtual void vtkWindow::SetTileScale	(	int	,
		int
	)

virtual

These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.