vtkExternalOpenGLRenderWindow Class Reference

OpenGL render window that allows using an external window to render vtk objects. More...

#include <vtkExternalOpenGLRenderWindow.h>

Inheritance diagram for vtkExternalOpenGLRenderWindow:

Collaboration diagram for vtkExternalOpenGLRenderWindow:

Public Types
typedef vtkGenericOpenGLRenderWindow	Superclass
Public Types inherited from vtkGenericOpenGLRenderWindow
typedef vtkOpenGLRenderWindow	Superclass
Public Types inherited from vtkOpenGLRenderWindow
enum	FrameBlitModes { BlitToHardware , BlitToCurrent , NoBlit }
	Define how the resulting image should be blitted when at the end of the Frame() call if SwapBuffers is true. More...
typedef vtkRenderWindow	Superclass
Public Types inherited from vtkRenderWindow
typedef vtkWindow	Superclass
Public Types inherited from vtkWindow
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkExternalOpenGLRenderWindow *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Start (void) override
	Begin the rendering process using the existing context.
bool	IsCurrent () override
	Tells if this window is the current graphics context for the calling thread.
virtual int	GetAutomaticWindowPositionAndResize ()
	Turn on/off a flag which enables/disables automatic positioning and resizing of the render window.
virtual void	SetAutomaticWindowPositionAndResize (int)
	Turn on/off a flag which enables/disables automatic positioning and resizing of the render window.
virtual void	AutomaticWindowPositionAndResizeOn ()
	Turn on/off a flag which enables/disables automatic positioning and resizing of the render window.
virtual void	AutomaticWindowPositionAndResizeOff ()
	Turn on/off a flag which enables/disables automatic positioning and resizing of the render window.
virtual bool	GetUseExternalContent ()
	Turn on/off a flag which enables/disables using the content from an outside applicaiton.
virtual void	SetUseExternalContent (bool)
	Turn on/off a flag which enables/disables using the content from an outside applicaiton.
virtual void	UseExternalContentOn ()
	Turn on/off a flag which enables/disables using the content from an outside applicaiton.
virtual void	UseExternalContentOff ()
	Turn on/off a flag which enables/disables using the content from an outside applicaiton.
Public Member Functions inherited from vtkGenericOpenGLRenderWindow
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkGenericOpenGLRenderWindow *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Finalize () override
	Cleans up graphics resources allocated in the context for this VTK scene.
void	Frame () override
	flush the pending drawing operations Class user may to watch for WindowFrameEvent and act on it
void	MakeCurrent () override
	Makes the context current.
bool	IsCurrent () override
	Returns if the context is current.
int	SupportsOpenGL () override
	Returns if OpenGL is supported.
vtkTypeBool	IsDirect () override
	Returns if the context is direct.
void	SetFrontLeftBuffer (unsigned int)
	set the drawing buffers to use
void	SetFrontRightBuffer (unsigned int)
void	SetBackLeftBuffer (unsigned int)
void	SetBackRightBuffer (unsigned int)
void	SetOwnContext (vtkTypeBool)
void	PushState ()
	no-op (for API compat with OpenGL1).
void	PopState ()
	no-op (for API compat with OpenGL1).
void	SetWindowId (void *) override
	does nothing
void *	GetGenericWindowId () override
	Dummy stubs for vtkWindow API.
void	SetDisplayId (void *) override
	Dummy stubs for vtkWindow API.
void	SetParentId (void *) override
	Dummy stubs for vtkWindow API.
void *	GetGenericDisplayId () 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.
void	SetParentInfo (const char *) override
	Dummy stubs for vtkWindow API.
int *	GetScreenSize () override
	Get the current size of the screen in pixels.
void	HideCursor () override
	Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead.
void	ShowCursor () override
	Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead.
void	SetFullScreen (vtkTypeBool) override
	Turn on/off rendering full screen window size.
void	WindowRemap () override
	Remap the rendering window.
vtkTypeBool	GetEventPending () override
	Check to see if a mouse button has been pressed.
void	SetNextWindowId (void *) override
	Dummy stubs for vtkWindow API.
void	SetNextWindowInfo (const char *) override
	Dummy stubs for vtkWindow API.
void	CreateAWindow () override
	Create a not-off-screen window.
void	DestroyWindow () override
	Destroy a not-off-screen window.
void	Render () override
	Override the Render method to do some state management.
float	GetMaximumHardwareLineWidth () override
	Overridden to pass explicitly specified MaximumHardwareLineWidth, if any.
void	SetIsDirect (vtkTypeBool newValue)
	Allow to update state within observer callback without changing data argument and MTime.
void	SetSupportsOpenGL (int newValue)
	Allow to update state within observer callback without changing data argument and MTime.
void	SetIsCurrent (bool newValue)
	Allow to update state within observer callback without changing data argument and MTime.
virtual void	SetForceMaximumHardwareLineWidth (float)
	Specify a non-zero line width to force the hardware line width determined by the window.
virtual float	GetForceMaximumHardwareLineWidth ()
	Specify a non-zero line width to force the hardware line width determined by the window.
virtual void	SetReadyForRendering (bool)
	Set this to true to indicate that the context is now ready.
virtual bool	GetReadyForRendering ()
	Set this to true to indicate that the context is now ready.
virtual void	SetScreenSize (int, int)
	Set the size of the screen in pixels.
void	SetScreenSize (int[2])
	Set this to true to indicate that the context is now ready.
void	SetCurrentCursor (int cShape) override
	Overridden to invoke vtkCommand::CursorChangedEvent.
virtual void	SetMapped (vtkTypeBool)
	Set this to true to indicate that the context is now ready.
bool	IsDrawable () override
	Overridden to simply call GetReadyForRendering
void	OpenGLInit () override
	Initialize OpenGL for this window.
Public Member Functions inherited from vtkOpenGLRenderWindow
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkOpenGLRenderWindow *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Start (void) override
	Begin the rendering process.
void	Frame () override
	A termination method performed at the end of the rendering process to do things like swapping buffers (if necessary) or similar actions.
const char *	GetRenderingBackend () override
	What rendering backend has the user requested.
void	ActivateTexture (vtkTextureObject *)
	Activate a texture unit for this texture.
void	DeactivateTexture (vtkTextureObject *)
	Deactivate a previously activated texture.
int	GetTextureUnitForTexture (vtkTextureObject *)
	Get the texture unit for a given texture object.
int	GetDepthBufferSize () override
	Get the size of the depth buffer.
bool	GetUsingSRGBColorSpace ()
	Is this window/fo in sRGB colorspace.
int	GetColorBufferSizes (int *rgba) override
	Get the size of the color buffer.
int	GetColorBufferInternalFormat (int attachmentPoint)
	Get the internal format of current attached texture or render buffer.
virtual void	OpenGLInit ()
	Initialize OpenGL for this window.
virtual void	OpenGLInitState ()
virtual void	OpenGLInitContext ()
void	GetOpenGLVersion (int &major, int &minor)
	Get the major and minor version numbers of the OpenGL context we are using ala 3.2, 3.3, 4.0, etc... returns 0,0 if opengl has not been initialized yet.
virtual vtkMTimeType	GetContextCreationTime ()
	Get the time when the OpenGL context was created.
vtkOpenGLShaderCache *	GetShaderCache ()
	Returns an Shader Cache object.
vtkOpenGLVertexBufferObjectCache *	GetVBOCache ()
	Returns the VBO Cache.
virtual vtkOpenGLFramebufferObject *	GetDisplayFramebuffer ()
	Returns the display framebuffer object.
vtkTextureUnitManager *	GetTextureUnitManager ()
	Returns its texture unit manager object.
void	WaitForCompletion () override
	Block the thread until the actual rendering is finished().
virtual void	DrawPixels (int x1, int y1, int x2, int y2, int numComponents, int dataType, void *data)
	Replacement for the old glDrawPixels function.
virtual void	DrawPixels (int dstXmin, int dstYmin, int dstXmax, int dstYmax, int srcXmin, int srcYmin, int srcXmax, int srcYmax, int srcWidth, int srcHeight, int numComponents, int dataType, void *data)
	Replacement for the old glDrawPixels function, but it allows for scaling the data and using only part of the texture.
virtual void	DrawPixels (int srcWidth, int srcHeight, int numComponents, int dataType, void *data)
	Replacement for the old glDrawPixels function.
virtual float	GetMaximumHardwareLineWidth ()
	Return the largest line width supported by the hardware.
virtual bool	IsPointSpriteBugPresent ()
	Returns true if driver has an EGL/OpenGL bug that makes vtkChartsCoreCxx-TestChartDoubleColors and other tests to fail because point sprites don't work correctly (gl_PointCoord is undefined) unless glEnable(GL_POINT_SPRITE)
int	GetDefaultTextureInternalFormat (int vtktype, int numComponents, bool needInteger, bool needFloat, bool needSRGB)
	Get a mapping of vtk data types to native texture formats for this window we put this on the RenderWindow so that every texture does not have to build these structures themselves.
std::string	GetOpenGLSupportMessage ()
	Return a message profiding additional details about the results of calling SupportsOpenGL() This can be used to retrieve more specifics about what failed.
int	SupportsOpenGL () override
	Does this render window support OpenGL? 0-false, 1-true.
const char *	ReportCapabilities () override
	Get report of capabilities for the render window.
virtual void	Initialize (void)
	Initialize the rendering window.
void	RegisterGraphicsResources (vtkGenericOpenGLResourceFreeCallback *cb)
void	UnregisterGraphicsResources (vtkGenericOpenGLResourceFreeCallback *cb)
virtual void	PushContext ()
	Ability to push and pop this window's context as the current context.
virtual void	PopContext ()
bool	InitializeFromCurrentContext () override
	Initialize the render window from the information associated with the currently activated OpenGL context.
virtual bool	SetSwapControl (int)
	Set the number of vertical syncs required between frames.
virtual vtkOpenGLState *	GetState ()
vtkOpenGLBufferObject *	GetTQuad2DVBO ()
int	GetNoiseTextureUnit ()
void	End () override
	Update the system, if needed, at end of render process.
void	Render () override
	Handle opengl specific code and calls superclass.
void	StereoMidpoint () override
	Intermediate method performs operations required between the rendering of the left and right eye.
bool	GetBufferNeedsResolving ()
void	ReleaseGraphicsResources (vtkWindow *) override
	Free up any graphics resources associated with this window a value of NULL means the context may already be destroyed.
void	BlitDisplayFramebuffer ()
	Blit a display framebuffer into a currently bound draw destination.
void	BlitDisplayFramebuffer (int right, int srcX, int srcY, int srcWidth, int srcHeight, int destX, int destY, int destWidth, int destHeight, int bufferMode, int interpolation)
	Blit a display buffer into a currently bound draw destination.
unsigned char *	GetPixelData (int x, int y, int x2, int y2, int front, int right) override
	Set/Get the pixel data of an image, transmitted as RGBRGB... front in this context indicates that the read should come from the display buffer versus the render buffer.
int	GetPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right) override
	Set/Get the pixel data of an image, transmitted as RGBRGB... front in this context indicates that the read should come from the display buffer versus the render buffer.
int	SetPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int right) override
	Set/Get the pixel data of an image, transmitted as RGBRGB... front in this context indicates that the read should come from the display buffer versus the render buffer.
int	SetPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int right) override
	Set/Get the pixel data of an image, transmitted as RGBRGB... front in this context indicates that the read should come from the display buffer versus the render buffer.
float *	GetRGBAPixelData (int x, int y, int x2, int y2, int front, int right=0) override
	Set/Get the pixel data of an image, transmitted as RGBARGBA...
int	GetRGBAPixelData (int x, int y, int x2, int y2, int front, vtkFloatArray *data, int right=0) override
	Set/Get the pixel data of an image, transmitted as RGBARGBA...
int	SetRGBAPixelData (int x, int y, int x2, int y2, float *data, int front, int blend=0, int right=0) override
	Set/Get the pixel data of an image, transmitted as RGBARGBA...
int	SetRGBAPixelData (int x, int y, int x2, int y2, vtkFloatArray *data, int front, int blend=0, int right=0) override
	Set/Get the pixel data of an image, transmitted as RGBARGBA...
void	ReleaseRGBAPixelData (float *data) override
	Set/Get the pixel data of an image, transmitted as RGBARGBA...
unsigned char *	GetRGBACharPixelData (int x, int y, int x2, int y2, int front, int right=0) override
	Set/Get the pixel data of an image, transmitted as RGBARGBA...
int	GetRGBACharPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right=0) override
	Set/Get the pixel data of an image, transmitted as RGBARGBA...
int	SetRGBACharPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int blend=0, int right=0) override
	Set/Get the pixel data of an image, transmitted as RGBARGBA...
int	SetRGBACharPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int blend=0, int right=0) override
	Set/Get the pixel data of an image, transmitted as RGBARGBA...
float *	GetZbufferData (int x1, int y1, int x2, int y2) override
	Set/Get the zbuffer data from an image.
int	GetZbufferData (int x1, int y1, int x2, int y2, float *z) override
	Set/Get the zbuffer data from an image.
int	GetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *buffer) override
	Set/Get the zbuffer data from an image.
int	SetZbufferData (int x1, int y1, int x2, int y2, float *buffer) override
	Set/Get the zbuffer data from an image.
int	SetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *buffer) override
	Set/Get the zbuffer data from an image.
unsigned int	GetBackLeftBuffer ()
unsigned int	GetBackRightBuffer ()
unsigned int	GetFrontLeftBuffer ()
unsigned int	GetFrontRightBuffer ()
unsigned int	GetBackBuffer ()
unsigned int	GetFrontBuffer ()
virtual vtkOpenGLFramebufferObject *	GetRenderFramebuffer ()
	Returns the render framebuffer object.
vtkOpenGLFramebufferObject *	GetOffScreenFramebuffer ()
	Returns the render framebuffer object.
void	BlitToRenderFramebuffer (bool includeDepth)
	Blit the currently bound read buffer to the renderbuffer.
void	BlitToRenderFramebuffer (int srcX, int srcY, int srcWidth, int srcHeight, int destX, int destY, int destWidth, int destHeight, int bufferMode, int interpolation)
	Blit the currently bound read buffer to the renderbuffer.
virtual void	SetFrameBlitMode (FrameBlitModes)
	SetGet how to handle blits at the end of a Frame() call.
virtual FrameBlitModes	GetFrameBlitMode ()
	SetGet how to handle blits at the end of a Frame() call.
void	SetFrameBlitModeToBlitToHardware ()
	SetGet how to handle blits at the end of a Frame() call.
void	SetFrameBlitModeToBlitToCurrent ()
	SetGet how to handle blits at the end of a Frame() call.
void	SetFrameBlitModeToNoBlit ()
	SetGet how to handle blits at the end of a Frame() call.
virtual void	TextureDepthBlit (vtkTextureObject *source)
virtual void	TextureDepthBlit (vtkTextureObject *source, int srcX, int srcY, int srcX2, int srcY2)
virtual void	TextureDepthBlit (vtkTextureObject *source, int srcX, int srcY, int srcX2, int srcY2, int destX, int destY, int destX2, int destY2)
Public Member Functions inherited from vtkRenderWindow
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.
int	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	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 bool	IsDrawable ()
	Test if the window has a valid drawable.
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 int	GetCapturingGL2PSSpecialProps ()
	Returns true if the render process is capturing text actors.
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 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 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	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.
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.
vtkTypeBool	GetIsPicking ()
void	SetIsPicking (vtkTypeBool)
void	IsPickingOn ()
void	IsPickingOff ()
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.
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.
const char *	GetStereoTypeAsString ()
	Returns the stereo type as a string.
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 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 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 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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
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.
virtual 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.

Static Public Member Functions
static vtkExternalOpenGLRenderWindow *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkExternalOpenGLRenderWindow *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkGenericOpenGLRenderWindow
static vtkGenericOpenGLRenderWindow *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkGenericOpenGLRenderWindow *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkOpenGLRenderWindow
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOpenGLRenderWindow *	SafeDownCast (vtkObjectBase *o)
static void	SetGlobalMaximumNumberOfMultiSamples (int val)
	Set/Get the maximum number of multisamples.
static int	GetGlobalMaximumNumberOfMultiSamples ()
	Set/Get the maximum number of multisamples.
Static Public Member Functions inherited from vtkRenderWindow
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 const char *	GetStereoTypeAsString (int type)
	Returns the stereo type as a string.
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 (int 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 int	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
	vtkExternalOpenGLRenderWindow ()
	~vtkExternalOpenGLRenderWindow () override
Protected Member Functions inherited from vtkGenericOpenGLRenderWindow
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGenericOpenGLRenderWindow ()
	~vtkGenericOpenGLRenderWindow () override
int	ReadPixels (const vtkRecti &rect, int front, int glFormat, int glType, void *data, int right) override
	Overridden to not attempt to read pixels if this->ReadyForRendering is false.
int	SetPixelData (int x1, int y1, int x2, int y2, unsigned char *data, int front, int right) override
	Set this to true to indicate that the context is now ready.
int	SetPixelData (int x1, int y1, int x2, int y2, vtkUnsignedCharArray *data, int front, int right) override
	Set this to true to indicate that the context is now ready.
int	SetRGBACharPixelData (int x1, int y1, int x2, int y2, unsigned char *data, int front, int blend, int right) override
	Set this to true to indicate that the context is now ready.
int	SetRGBACharPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int blend=0, int right=0) override
	Set this to true to indicate that the context is now ready.
Protected Member Functions inherited from vtkOpenGLRenderWindow
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOpenGLRenderWindow ()
	~vtkOpenGLRenderWindow () override
virtual void	BlitDisplayFramebuffersToHardware ()
virtual int	ReadPixels (const vtkRecti &rect, int front, int glFormat, int glType, void *data, int right=0)
int	CreateFramebuffers (int width, int height)
	Create the offScreen framebuffer Return if the creation was successful or not.
virtual void	CreateAWindow ()=0
	Create a not-off-screen window.
virtual void	DestroyWindow ()=0
	Destroy a not-off-screen window.
void	SaveGLState ()
	Query and save OpenGL state.
void	RestoreGLState ()
	Restore OpenGL state at end of the rendering.
Protected Member Functions inherited from vtkRenderWindow
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 *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	AutomaticWindowPositionAndResize
bool	UseExternalContent
Protected Attributes inherited from vtkGenericOpenGLRenderWindow
int	DirectStatus
	Set this to true to indicate that the context is now ready.
int	SupportsOpenGLStatus
	Set this to true to indicate that the context is now ready.
bool	CurrentStatus
	Set this to true to indicate that the context is now ready.
float	ForceMaximumHardwareLineWidth
	Set this to true to indicate that the context is now ready.
bool	ReadyForRendering
	Set this to true to indicate that the context is now ready.
Protected Attributes inherited from vtkOpenGLRenderWindow
FrameBlitModes	FrameBlitMode
vtkOpenGLQuadHelper *	ResolveQuad
vtkOpenGLQuadHelper *	DepthBlitQuad
bool	OpenGLSupportTested
int	OpenGLSupportResult
std::string	OpenGLSupportMessage
vtkOpenGLFramebufferObject *	RenderFramebuffer
vtkOpenGLFramebufferObject *	DisplayFramebuffer
vtkOpenGLFramebufferObject *	ResolveFramebuffer
std::map< std::string, int >	GLStateIntegers
vtkTypeBool	OwnContext
	Flag telling if the context has been created here or was inherited.
vtkTimeStamp	ContextCreationTime
vtkTextureObject *	DrawPixelsTextureObject
bool	Initialized
bool	GlewInitValid
float	MaximumHardwareLineWidth
char *	Capabilities
vtkOpenGLBufferObject *	TQuad2DVBO
vtkTextureObject *	NoiseTextureObject
double	FirstRenderTime
int	LastMultiSamples
int	ScreenSize [2]
Protected Attributes inherited from vtkRenderWindow
vtkRendererCollection *	Renderers
vtkNew< vtkRenderTimerLog >	RenderTimer
vtkTypeBool	Borders
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
Protected Attributes inherited from vtkWindow
char *	WindowName
int	Size [2]
int	Position [2]
vtkTypeBool	Mapped
bool	ShowWindow
bool	UseOffScreenBuffers
vtkTypeBool	Erase
vtkTypeBool	DoubleBuffer
int	DPI
double	TileViewport [4]
int	TileSize [2]
int	TileScale [2]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkOpenGLRenderWindow
std::set< vtkGenericOpenGLResourceFreeCallback * >	Resources
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

OpenGL render window that allows using an external window to render vtk objects.

vtkExternalOpenGLRenderWindow is a concrete implementation of the abstract class vtkRenderWindow. vtkExternalOpenGLRenderer interfaces to the OpenGL graphics library.

This class extends vtkGenericOpenGLRenderWindow to allow sharing the same OpenGL context by various visualization applications. Basically, this class prevents VTK from creating a new OpenGL context. Thus, it requires that an OpenGL context be initialized before Render is called.

See also

Render()

It is a generic implementation; this window is platform agnostic. However, the application user must explicitly make sure the window size is synchronized when the external application window/viewport resizes.

See also

SetSize()

It has the same requirements as the vtkGenericOpenGLRenderWindow, whereby, one must register an observer for WindowMakeCurrentEvent, WindowIsCurrentEvent and WindowFrameEvent.

See also

vtkGenericOpenGLRenderWindow

Definition at line 47 of file vtkExternalOpenGLRenderWindow.h.

Member Typedef Documentation

Superclass

typedef vtkGenericOpenGLRenderWindow vtkExternalOpenGLRenderWindow::Superclass

Definition at line 52 of file vtkExternalOpenGLRenderWindow.h.

Constructor & Destructor Documentation

vtkExternalOpenGLRenderWindow()

vtkExternalOpenGLRenderWindow::vtkExternalOpenGLRenderWindow ( )

protected

~vtkExternalOpenGLRenderWindow()

vtkExternalOpenGLRenderWindow::~vtkExternalOpenGLRenderWindow ( )

overrideprotected

Member Function Documentation

New()

static vtkExternalOpenGLRenderWindow * vtkExternalOpenGLRenderWindow::New ( )

static

IsTypeOf()

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

static

IsA()

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

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkExternalOpenGLRenderWindow::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGenericOpenGLRenderWindow.

NewInstance()

vtkExternalOpenGLRenderWindow * vtkExternalOpenGLRenderWindow::NewInstance

(

)

const

PrintSelf()

void vtkExternalOpenGLRenderWindow::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkRenderWindow.

Start()

void vtkExternalOpenGLRenderWindow::Start ( void  )

overridevirtual

Begin the rendering process using the existing context.

Reimplemented from vtkRenderWindow.

IsCurrent()

bool vtkExternalOpenGLRenderWindow::IsCurrent ( )

overridevirtual

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

Reimplemented from vtkRenderWindow.

GetAutomaticWindowPositionAndResize()

virtual int vtkExternalOpenGLRenderWindow::GetAutomaticWindowPositionAndResize ( )

virtual

Turn on/off a flag which enables/disables automatic positioning and resizing of the render window.

By default, vtkExternalOpenGLRenderWindow queries the viewport position and size (glViewport) from the OpenGL state and uses it to resize itself. However, in special circumstances this feature is undesirable. One such circumstance may be to avoid performance penalty of querying OpenGL state variables. So the following boolean is provided to disable automatic window resize. (Turn AutomaticWindowPositionAndResize off if you do not want the viewport to be queried from the OpenGL state.)

SetAutomaticWindowPositionAndResize()

virtual void vtkExternalOpenGLRenderWindow::SetAutomaticWindowPositionAndResize ( int  )

virtual

Turn on/off a flag which enables/disables automatic positioning and resizing of the render window.

By default, vtkExternalOpenGLRenderWindow queries the viewport position and size (glViewport) from the OpenGL state and uses it to resize itself. However, in special circumstances this feature is undesirable. One such circumstance may be to avoid performance penalty of querying OpenGL state variables. So the following boolean is provided to disable automatic window resize. (Turn AutomaticWindowPositionAndResize off if you do not want the viewport to be queried from the OpenGL state.)

AutomaticWindowPositionAndResizeOn()

virtual void vtkExternalOpenGLRenderWindow::AutomaticWindowPositionAndResizeOn ( )

virtual

Turn on/off a flag which enables/disables automatic positioning and resizing of the render window.

By default, vtkExternalOpenGLRenderWindow queries the viewport position and size (glViewport) from the OpenGL state and uses it to resize itself. However, in special circumstances this feature is undesirable. One such circumstance may be to avoid performance penalty of querying OpenGL state variables. So the following boolean is provided to disable automatic window resize. (Turn AutomaticWindowPositionAndResize off if you do not want the viewport to be queried from the OpenGL state.)

AutomaticWindowPositionAndResizeOff()

virtual void vtkExternalOpenGLRenderWindow::AutomaticWindowPositionAndResizeOff ( )

virtual

Turn on/off a flag which enables/disables automatic positioning and resizing of the render window.

By default, vtkExternalOpenGLRenderWindow queries the viewport position and size (glViewport) from the OpenGL state and uses it to resize itself. However, in special circumstances this feature is undesirable. One such circumstance may be to avoid performance penalty of querying OpenGL state variables. So the following boolean is provided to disable automatic window resize. (Turn AutomaticWindowPositionAndResize off if you do not want the viewport to be queried from the OpenGL state.)

GetUseExternalContent()

virtual bool vtkExternalOpenGLRenderWindow::GetUseExternalContent ( )

virtual

Turn on/off a flag which enables/disables using the content from an outside applicaiton.

When on the active read buffer is first blitted into VTK and becomes the starting poiint for VTK's rendering.

SetUseExternalContent()

virtual void vtkExternalOpenGLRenderWindow::SetUseExternalContent ( bool  )

virtual

Turn on/off a flag which enables/disables using the content from an outside applicaiton.

When on the active read buffer is first blitted into VTK and becomes the starting poiint for VTK's rendering.

UseExternalContentOn()

virtual void vtkExternalOpenGLRenderWindow::UseExternalContentOn ( )

virtual

Turn on/off a flag which enables/disables using the content from an outside applicaiton.

When on the active read buffer is first blitted into VTK and becomes the starting poiint for VTK's rendering.

UseExternalContentOff()

virtual void vtkExternalOpenGLRenderWindow::UseExternalContentOff ( )

virtual

Turn on/off a flag which enables/disables using the content from an outside applicaiton.

When on the active read buffer is first blitted into VTK and becomes the starting poiint for VTK's rendering.

Member Data Documentation

AutomaticWindowPositionAndResize

int vtkExternalOpenGLRenderWindow::AutomaticWindowPositionAndResize

protected

Definition at line 98 of file vtkExternalOpenGLRenderWindow.h.

UseExternalContent

bool vtkExternalOpenGLRenderWindow::UseExternalContent

protected

Definition at line 99 of file vtkExternalOpenGLRenderWindow.h.

---

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

• Rendering/External/vtkExternalOpenGLRenderWindow.h