VTK  9.4.20250311
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkXWebGPURenderWindow Class Reference

WebGPU rendering window for the X Window system. More...

#include <vtkXWebGPURenderWindow.h>

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

Public Member Functions

void Frame () override
 End the rendering process and display the image.
 
virtual void WindowInitialize ()
 Initialize the window for rendering.
 
bool WindowSetup () override
 Initialize the rendering window.
 
void Finalize () override
 "Deinitialize" the rendering window.
 
void SetFullScreen (vtkTypeBool) override
 Change the window to fill the entire screen.
 
void WindowRemap () override
 Resize the window.
 
void SetShowWindow (bool val) override
 Show or not Show the window.
 
virtual void PrefFullScreen ()
 Set the preferred window size to full screen.
 
void SetSize (int width, int height) override
 Set the size (width and height in pixels) of the rendering window.
 
void SetSize (int a[2]) override
 Get the size (width and height) of the rendering window in screen coordinates (in pixels).
 
void SetStereoCapableWindow (vtkTypeBool capable) override
 Prescribe that the window be created in a stereo-capable mode.
 
const char * ReportCapabilities () override
 Get report of capabilities for the render window.
 
vtkTypeBool IsDirect () override
 Is this render window using hardware acceleration? 0-false, 1-true.
 
void * GetGenericDisplayId () override
 Xwindow get set functions.
 
void * GetGenericWindowId () override
 Dummy stubs for vtkWindow API.
 
void * GetGenericParentId () override
 Dummy stubs for vtkWindow API.
 
void * GetGenericDrawable () override
 Dummy stubs for vtkWindow API.
 
int * GetScreenSize () override
 Get the current size of the screen in pixels.
 
int * GetPosition () override
 Get the position (x and y) of the rendering window in screen coordinates (in pixels).
 
Display * GetDisplayId ()
 Get this RenderWindow's X display id.
 
bool EnsureDisplay () override
 Ensure RenderWindow's X display is opened.
 
Window GetParentId ()
 Get this RenderWindow's parent X window id.
 
Window GetWindowId ()
 Get this RenderWindow's X window id.
 
void SetNextWindowId (Window)
 Specify the X window id to use if a WindowRemap is done.
 
void SetNextWindowId (void *) override
 Set the window id of the new window once a WindowRemap is done.
 
void SetWindowName (const char *) override
 Set name of rendering window.
 
void SetIcon (vtkImageData *img) override
 For window manager that supports it, set the icon displayed in the taskbar and the title bar.
 
bool InitializeFromCurrentContext () override
 Initialize the render window from the information associated with the currently activated native graphics context.
 
bool GetPlatformSupportsRenderWindowSharing () override
 Does this platform support render window data sharing.
 
void SetCurrentCursor (int) override
 Change the shape of the cursor.
 
vtkTypeBool GetEventPending () override
 Check to see if a mouse button has been pressed or mouse wheel activated.
 
void SetWindowInfo (const char *info) override
 Set this RenderWindow's X window id to a pre-existing window.
 
void SetNextWindowInfo (const char *info) override
 Set the window info that will be used after WindowRemap()
 
void SetParentInfo (const char *info) override
 Sets the X window id of the window that WILL BE created.
 
void Render () override
 This computes the size of the render window before calling the supper classes render.
 
void SetDisplayId (Display *)
 Set the X display id for this RenderWindow to use to a pre-existing X display id.
 
void SetDisplayId (void *) override
 Set the X display id for this RenderWindow to use to a pre-existing X display id.
 
void SetParentId (Window)
 Sets the parent of the window that WILL BE created.
 
void SetParentId (void *) override
 Sets the parent of the window that WILL BE created.
 
void SetWindowId (Window)
 Set this RenderWindow's X window id to a pre-existing window.
 
void SetWindowId (void *) override
 Set this RenderWindow's X window id to a pre-existing window.
 
void SetPosition (int x, int y) override
 Set the position (x and y) of the rendering window in screen coordinates (in pixels).
 
void SetPosition (int a[2]) override
 Set the position (x and y) of the rendering window in screen coordinates (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.
 
- Public Member Functions inherited from vtkWebGPURenderWindow
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkWebGPURenderWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool WindowSetup ()=0
 Concrete render windows must create a platform window and initialize this->WindowId.
 
virtual void CreateAWindow ()=0
 Create a not-off-screen window.
 
virtual void DestroyWindow ()=0
 Destroy a not-off-screen window.
 
void Initialize () override
 Creates the WebGPU context, swapchain, depth buffer, color attachment, ...
 
void Start () override
 Start the rendering process for a frame.
 
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.
 
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.
 
int GetColorBufferSizes (int *rgba) override
 Get the size of the color buffer.
 
void WaitForCompletion () override
 Block the thread until work queue completes all submitted work.
 
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.
 
bool InitializeFromCurrentContext () override
 Initialize the render window from the information associated with the currently activated OpenGL context.
 
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 SetWGPUConfiguration (vtkWebGPUConfiguration *config)
 
virtual vtkWebGPUConfigurationGetWGPUConfiguration ()
 
 vtkGetNewMacro (WGPUShaderDatabase, vtkWebGPUShaderDatabase)
 Get a database of all WebGPU shader source codes in VTK.
 
 vtkGetNewMacro (WGPUPipelineCache, vtkWebGPURenderPipelineCache)
 Get the pipeline cache for this renderer.
 
std::string PreprocessShaderSource (const std::string &source) const
 Replaces all include statements in the given source code with source code corresponding to the included file from the database.
 
wgpu::RenderPassEncoder NewRenderPass (wgpu::RenderPassDescriptor &descriptor)
 Create a new render pass encoder on the webgpu device.
 
wgpu::RenderBundleEncoder NewRenderBundleEncoder (wgpu::RenderBundleEncoderDescriptor &descriptor)
 Create a new render bundle encoder on the webgpu device.
 
wgpu::CommandEncoder GetCommandEncoder ()
 Get the currently used command encoder.
 
void CreateCommandEncoder ()
 Initializes a new command encoder.
 
void FlushCommandBuffers (vtkTypeUInt32 count, wgpu::CommandBuffer *buffers)
 Sends a given command buffer to the device queue.
 
wgpu::TextureView GetOffscreenColorAttachmentView ()
 Get a view of the color attachment used in the offscreen render target.
 
wgpu::TextureView GetHardwareSelectorAttachmentView ()
 
wgpu::TextureView GetDepthStencilView ()
 Get a view of the depth-stencil attachment used in the offscreen render target.
 
wgpu::TextureFormat GetDepthStencilFormat ()
 Get the texture format of the depth-stencil attachment.
 
bool HasStencil ()
 Whether the offscreen render target has stencil capabilities.
 
wgpu::Device GetDevice ()
 Get the webgpu device.
 
wgpu::Adapter GetAdapter ()
 Get the webgpu adapter.
 
wgpu::TextureFormat GetPreferredSurfaceTextureFormat ()
 Get the texture format preferred for the surface.
 
wgpu::TextureFormat GetPreferredSelectorIdsTextureFormat ()
 Get the texture format preferred for selector IDs.
 
vtkSmartPointer< vtkImageDataSaveAttachmentToVTI (AttachmentTypeForVTISnapshot type)
 
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.
 
vtkSmartPointer< vtkWebGPUComputeRenderTextureAcquireDepthBufferRenderTexture ()
 Returns a vtkWebGPUComputeRenderTexture ready to be added to a compute pipeline using vtkWebGPUComputePipeline::AddRenderTexture() that "points" to the depth buffer/color texture of this vtkWebGPURenderWindow.
 
vtkSmartPointer< vtkWebGPUComputeRenderTextureAcquireFramebufferRenderTexture ()
 Returns a vtkWebGPUComputeRenderTexture ready to be added to a compute pipeline using vtkWebGPUComputePipeline::AddRenderTexture() that "points" to the depth buffer/color texture of this vtkWebGPURenderWindow.
 
- 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.
 
vtkRenderWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void AddRenderer (vtkRenderer *)
 Add a renderer to the list of renderers.
 
void RemoveRenderer (vtkRenderer *)
 Remove a renderer from the list of renderers.
 
vtkTypeBool HasRenderer (vtkRenderer *)
 Query if a renderer is in the list of renderers.
 
virtual const char * GetRenderingBackend ()
 What rendering backend has the user requested.
 
 vtkGetNewMacro (RenderTimer, vtkRenderTimerLog)
 Get the render timer log for this window.
 
vtkRendererCollectionGetRenderers ()
 Return the collection of renderers in the render window.
 
void CaptureGL2PSSpecialProps (vtkCollection *specialProps)
 The GL2PS exporter must handle certain props in a special way (e.g.
 
void Render () override
 Ask each renderer owned by this RenderWindow to render its image and synchronize this process.
 
virtual void Start ()
 Start the rendering process for a frame.
 
virtual void End ()
 Update the system, if needed, at end of render process.
 
virtual void Initialize ()
 Initializes the rendering process.
 
virtual void Finalize ()
 Finalize the rendering process.
 
virtual void Frame ()
 A termination method performed at the end of the rendering process to do things like swapping buffers (if necessary) or similar actions.
 
virtual void WaitForCompletion ()
 Block the thread until the actual rendering is finished().
 
virtual void CopyResultFrame ()
 Performed at the end of the rendering process to generate image.
 
virtual vtkRenderWindowInteractorMakeRenderWindowInteractor ()
 Create an interactor to control renderers in this window.
 
virtual void StereoUpdate ()
 Update the system, if needed, due to stereo rendering.
 
virtual void StereoMidpoint ()
 Intermediate method performs operations required between the rendering of the left and right eye.
 
virtual void StereoRenderComplete ()
 Handles work required once both views have been rendered when using stereo rendering.
 
virtual void WindowRemap ()
 Remap the rendering window.
 
virtual vtkTypeBool GetEventPending ()
 Check to see if a mouse button has been pressed.
 
virtual int CheckInRenderStatus ()
 Are we rendering at the moment.
 
virtual void ClearInRenderStatus ()
 Clear status (after an exception was thrown for example)
 
virtual void SetInteractor (vtkRenderWindowInteractor *)
 Set the interactor to the render window.
 
void UnRegister (vtkObjectBase *o) override
 This Method detects loops of RenderWindow<->Interactor, so objects are freed properly.
 
virtual bool InitializeFromCurrentContext ()
 Initialize the render window from the information associated with the currently activated OpenGL context.
 
virtual bool IsCurrent ()
 Tells if this window is the current graphics context for the calling thread.
 
virtual void SetForceMakeCurrent ()
 If called, allow MakeCurrent() to skip cache-check when called.
 
virtual const char * ReportCapabilities ()
 Get report of capabilities for the render window.
 
virtual int SupportsOpenGL ()
 Does this render window support OpenGL? 0-false, 1-true.
 
virtual vtkTypeBool IsDirect ()
 Is this render window using hardware acceleration? 0-false, 1-true.
 
virtual int GetDepthBufferSize ()
 This method should be defined by the subclass.
 
virtual int GetColorBufferSizes (int *)
 Get the size of the color buffer.
 
virtual int GetNumberOfDevices ()
 Returns the number of devices (graphics cards) on a system.
 
virtual void SetPhysicalToWorldMatrix (vtkMatrix4x4 *matrix)
 Set physical to world transform matrix.
 
virtual void GetPhysicalToWorldMatrix (vtkMatrix4x4 *matrix)
 Get physical to world transform matrix.
 
virtual bool GetDeviceToWorldMatrixForDevice (vtkEventDataDevice device, vtkMatrix4x4 *deviceToWorldMatrix)
 Store in deviceToWorldMatrix the matrix that goes from device coordinates to world coordinates.
 
virtual int GetCapturingGL2PSSpecialProps ()
 Returns true if the render process is capturing text actors.
 
virtual bool GetInitialized ()
 Get/set whether or not the window has been initialized yet.
 
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 GetCoverable ()
 Set/Get whether windows should be coverable (as opposed to always on top).
 
virtual void CoverableOn ()
 Set/Get whether windows should be coverable (as opposed to always on top).
 
virtual void CoverableOff ()
 Set/Get whether windows should be coverable (as opposed to always on top).
 
virtual void SetCoverable (vtkTypeBool coverable)
 Set/Get whether windows should be coverable (as opposed to always on top).
 
virtual vtkTypeBool GetStereoCapableWindow ()
 Prescribe that the window be created in a stereo-capable mode.
 
virtual void StereoCapableWindowOn ()
 Prescribe that the window be created in a stereo-capable mode.
 
virtual void StereoCapableWindowOff ()
 Prescribe that the window be created in a stereo-capable mode.
 
virtual 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.
 
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 vtkRenderWindowInteractorGetInteractor ()
 Get the interactor associated with this render window.
 
void * GetGenericContext () override
 Dummy stubs for vtkWindow API.
 
virtual void SetSharedRenderWindow (vtkRenderWindow *)
 Set/Get an already existing window that this window should share data with if possible.
 
virtual vtkRenderWindowGetSharedRenderWindow ()
 Set/Get an already existing window that this window should share data with if possible.
 
virtual void SetMultiSamples (int)
 Set / Get the number of multisamples to use for hardware antialiasing.
 
virtual int GetMultiSamples ()
 Set / Get the number of multisamples to use for hardware antialiasing.
 
virtual void SetStencilCapable (vtkTypeBool)
 Set / Get the availability of the stencil buffer.
 
virtual vtkTypeBool GetStencilCapable ()
 Set / Get the availability of the stencil buffer.
 
virtual void StencilCapableOn ()
 Set / Get the availability of the stencil buffer.
 
virtual void StencilCapableOff ()
 Set / Get the availability of the stencil buffer.
 
virtual void SetDeviceIndex (int)
 If there are several graphics card installed on a system, this index can be used to specify which card you want to render to.
 
virtual int GetDeviceIndex ()
 If there are several graphics card installed on a system, this index can be used to specify which card you want to render to.
 
virtual bool GetUseSRGBColorSpace ()
 Set/Get if we want this window to use the sRGB color space.
 
virtual void SetUseSRGBColorSpace (bool)
 Set/Get if we want this window to use the sRGB color space.
 
virtual void UseSRGBColorSpaceOn ()
 Set/Get if we want this window to use the sRGB color space.
 
virtual void UseSRGBColorSpaceOff ()
 Set/Get if we want this window to use the sRGB color space.
 
virtual void SetPhysicalViewDirection (double, double, double)
 Set/get physical coordinate system in world coordinate system.
 
virtual void SetPhysicalViewDirection (double[3])
 Set/get physical coordinate system in world coordinate system.
 
virtual double * GetPhysicalViewDirection ()
 Set/get physical coordinate system in world coordinate system.
 
virtual void GetPhysicalViewDirection (double &, double &, double &)
 Set/get physical coordinate system in world coordinate system.
 
virtual void GetPhysicalViewDirection (double[3])
 Set/get physical coordinate system in world coordinate system.
 
virtual void SetPhysicalViewUp (double, double, double)
 Set/get physical coordinate system in world coordinate system.
 
virtual void SetPhysicalViewUp (double[3])
 Set/get physical coordinate system in world coordinate system.
 
virtual double * GetPhysicalViewUp ()
 Set/get physical coordinate system in world coordinate system.
 
virtual void GetPhysicalViewUp (double &, double &, double &)
 Set/get physical coordinate system in world coordinate system.
 
virtual void GetPhysicalViewUp (double[3])
 Set/get physical coordinate system in world coordinate system.
 
virtual void SetPhysicalTranslation (double, double, double)
 Set/get physical coordinate system in world coordinate system.
 
virtual void SetPhysicalTranslation (double[3])
 Set/get physical coordinate system in world coordinate system.
 
virtual double * GetPhysicalTranslation ()
 Set/get physical coordinate system in world coordinate system.
 
virtual void GetPhysicalTranslation (double &, double &, double &)
 Set/get physical coordinate system in world coordinate system.
 
virtual void GetPhysicalTranslation (double[3])
 Set/get physical coordinate system in world coordinate system.
 
virtual void SetPhysicalScale (double)
 Set/get physical coordinate system in world coordinate system.
 
virtual double GetPhysicalScale ()
 Set/get physical coordinate system in world coordinate system.
 
virtual bool GetEnableTranslucentSurface ()
 Set/Get if we want this window to use a translucent surface with alpha channel support.
 
virtual void SetEnableTranslucentSurface (bool)
 Set/Get if we want this window to use a translucent surface with alpha channel support.
 
virtual void EnableTranslucentSurfaceOn ()
 Set/Get if we want this window to use a translucent surface with alpha channel support.
 
virtual void EnableTranslucentSurfaceOff ()
 Set/Get if we want this window to use a translucent surface with alpha channel support.
 
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.
 
vtkWindowNewInstance () 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 int * GetSize ()
 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 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 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.
 
vtkCommandGetCommand (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 vtkXWebGPURenderWindowNew ()
 Instantiate the class.
 
- Static Public Member Functions inherited from vtkWebGPURenderWindow
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWebGPURenderWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderWindow
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderWindowSafeDownCast (vtkObjectBase *o)
 
static vtkRenderWindowNew ()
 Construct an instance of vtkRenderWindow with its screen size set to 300x300, borders turned on, positioned at (0,0), double buffering turned on.
 
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 vtkWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
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 vtkObjectBaseNew ()
 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

 vtkXWebGPURenderWindow ()
 
 ~vtkXWebGPURenderWindow () override
 
std::string MakeDefaultWindowNameWithBackend () override
 Construct the window title as "Visualization Toolkit - <WindowSystem> <GraphicsBackend>" Ex: "Visualization Toolkit - X11 Vulkan" "Visualization Toolkit - X11 OpenGL" "Visualization Toolkit - Cocoa Metal" "Visualization Toolkit - Cocoa OpenGL" "Visualization Toolkit - Win32 D3D12".
 
void CreateAWindow () override
 Create a not-off-screen window.
 
void DestroyWindow () override
 Destroy a not-off-screen window.
 
void CloseDisplay ()
 
- Protected Member Functions inherited from vtkWebGPURenderWindow
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkWebGPURenderWindow ()
 
 ~vtkWebGPURenderWindow () override
 
virtual std::string MakeDefaultWindowNameWithBackend ()=0
 Construct the window title as "Visualization Toolkit - <WindowSystem> <GraphicsBackend>" Ex: "Visualization Toolkit - X11 Vulkan" "Visualization Toolkit - X11 OpenGL" "Visualization Toolkit - Cocoa Metal" "Visualization Toolkit - Cocoa OpenGL" "Visualization Toolkit - Win32 D3D12".
 
bool WGPUInit ()
 
void WGPUFinalize ()
 
void ConfigureSurface ()
 
void UnconfigureSurface ()
 
void CreateOffscreenColorAttachment ()
 
void DestroyOffscreenColorAttachment ()
 
void CreateIdsAttachment ()
 
void DestroyIdsAttachment ()
 
void CreateDepthStencilAttachment ()
 
void DestroyDepthStencilAttachment ()
 
void CreateColorCopyPipeline ()
 
void DestroyColorCopyPipeline ()
 
void RecreateComputeRenderTextures ()
 
void RenderOffscreenTexture ()
 
- Protected Member Functions inherited from vtkRenderWindow
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRenderWindow ()
 
 ~vtkRenderWindow () override
 
virtual void DoStereoRender ()
 
- Protected Member Functions inherited from vtkWindow
virtual vtkObjectBaseNewInstanceInternal () 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

Window ParentId
 
Window WindowId
 
Window NextWindowId
 
Display * DisplayId
 
Colormap ColorMap
 
vtkTypeBool OwnWindow
 
vtkTypeBool OwnDisplay
 
vtkTypeBool CursorHidden
 
vtkTypeBool UsingHardware
 
Cursor XCCrosshair
 
Cursor XCArrow
 
Cursor XCSizeAll
 
Cursor XCSizeNS
 
Cursor XCSizeWE
 
Cursor XCSizeNE
 
Cursor XCSizeNW
 
Cursor XCSizeSE
 
Cursor XCSizeSW
 
Cursor XCHand
 
Cursor XCCustom
 
- Protected Attributes inherited from vtkWebGPURenderWindow
bool RenderTexturesSetup = false
 
wgpu::Surface Surface
 
wgpu::CommandEncoder CommandEncoder
 
int SurfaceConfiguredSize [2]
 
wgpu::TextureFormat PreferredSurfaceTextureFormat = wgpu::TextureFormat::BGRA8Unorm
 
wgpu::TextureFormat PreferredSelectorIdsTextureFormat = wgpu::TextureFormat::RGBA32Uint
 
vtkWGPUDepthStencil DepthStencilAttachment
 
vtkWGPUAttachment ColorAttachment
 
vtkWGPUAttachment IdsAttachment
 
vtkWGPUUserStagingPixelData StagingPixelData
 
vtkWGPUFullScreenQuad ColorCopyRenderPipeline
 
vtkSmartPointer< vtkWebGPUConfigurationWGPUConfiguration
 
vtkNew< vtkWebGPUShaderDatabaseWGPUShaderDatabase
 
vtkNew< vtkWebGPURenderPipelineCacheWGPUPipelineCache
 
vtkSmartPointer< vtkWebGPUComputePipelineDepthCopyPipeline
 
vtkSmartPointer< vtkWebGPUComputePassDepthCopyPass
 
int DepthCopyBufferIndex = 0
 
int DepthCopyTextureIndex = 0
 
int ScreenSize [2]
 
- Protected Attributes inherited from vtkRenderWindow
vtkRendererCollectionRenderers
 
vtkNew< vtkRenderTimerLogRenderTimer
 
vtkTypeBool Borders
 
vtkTypeBool Coverable
 
vtkTypeBool FullScreen
 
int OldScreen [5]
 
vtkTypeBool PointSmoothing
 
vtkTypeBool LineSmoothing
 
vtkTypeBool PolygonSmoothing
 
vtkTypeBool StereoRender
 
int StereoType
 
vtkTypeBool StereoCapableWindow
 
vtkTypeBool AlphaBitPlanes
 
vtkRenderWindowInteractorInteractor
 
vtkSmartPointer< vtkUnsignedCharArrayStereoBuffer
 
vtkSmartPointer< vtkUnsignedCharArrayResultFrame
 
vtkTypeBool SwapBuffers
 
double DesiredUpdateRate
 
int AbortRender
 
int InAbortCheck
 
int InRender
 
int NeverRendered
 
int NumberOfLayers
 
int CurrentCursor
 
float AnaglyphColorSaturation
 
int AnaglyphColorMask [2]
 
int MultiSamples
 
vtkTypeBool StencilCapable
 
int CapturingGL2PSSpecialProps
 
int DeviceIndex
 
bool UseSRGBColorSpace
 
char * CursorFileName
 
double AbortCheckTime
 The universal time since the last abort check occurred.
 
vtkRenderWindowSharedRenderWindow
 
double PhysicalViewDirection [3] = { 0.0, 0.0, -1.0 }
 
double PhysicalViewUp [3] = { 0.0, 1.0, 0.0 }
 
double PhysicalTranslation [3] = { 0.0, 0.0, 0.0 }
 
double PhysicalScale = 1.0
 
bool EnableTranslucentSurface = false
 
bool Initialized = false
 
- Protected Attributes inherited from vtkWindow
char * WindowName
 
int Size [2]
 
int Position [2]
 
vtkTypeBool Mapped
 
bool ShowWindow
 
bool UseOffScreenBuffers
 
vtkTypeBool Erase
 
vtkTypeBool DoubleBuffer
 
int DPI
 
double TileViewport [4]
 
int TileSize [2]
 
int TileScale [2]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkWebGPURenderWindow Superclass
 Standard methods for the VTK class.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for the VTK class.
 
static vtkXWebGPURenderWindowSafeDownCast (vtkObjectBase *o)
 Standard methods for the VTK class.
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for the VTK class.
 
vtkXWebGPURenderWindowNewInstance () const
 Standard methods for the VTK class.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for the VTK class.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for the VTK class.
 

Additional Inherited Members

- Public Types inherited from vtkWebGPURenderWindow
enum class  AttachmentTypeForVTISnapshot { ColorRGBA , ColorRGB , Depth , Ids }
 
typedef vtkRenderWindow Superclass
 
using TextureMapCallback = std::function< void(const void *mappedData, int bytesPerRow, void *userdata)>
 
- Public Types inherited from vtkRenderWindow
enum  { PhysicalToWorldMatrixModified = vtkCommand::UserEvent + 200 }
 
typedef vtkWindow Superclass
 
- Public Types inherited from vtkWindow
typedef vtkObject Superclass
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

WebGPU rendering window for the X Window system.

vtkXWebGPURenderWindow is a concrete implementation of the abstract class vtkRenderWindow. vtkWebGPURenderer interfaces to the WebGPU graphics library. Application programmers should normally use vtkRenderWindow instead of the WebGPU specific version.

Events:
vtkCommand::CursorChangedEvent

Definition at line 25 of file vtkXWebGPURenderWindow.h.

Member Typedef Documentation

◆ Superclass

Standard methods for the VTK class.

Definition at line 37 of file vtkXWebGPURenderWindow.h.

Constructor & Destructor Documentation

◆ vtkXWebGPURenderWindow()

vtkXWebGPURenderWindow::vtkXWebGPURenderWindow ( )
protected

◆ ~vtkXWebGPURenderWindow()

vtkXWebGPURenderWindow::~vtkXWebGPURenderWindow ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkXWebGPURenderWindow * vtkXWebGPURenderWindow::New ( )
static

Instantiate the class.

◆ IsTypeOf()

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

Standard methods for the VTK class.

◆ IsA()

virtual vtkTypeBool vtkXWebGPURenderWindow::IsA ( const char *  type)
virtual

Standard methods for the VTK class.

Reimplemented from vtkWebGPURenderWindow.

◆ SafeDownCast()

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

Standard methods for the VTK class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXWebGPURenderWindow::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for the VTK class.

Reimplemented from vtkWebGPURenderWindow.

◆ NewInstance()

vtkXWebGPURenderWindow * vtkXWebGPURenderWindow::NewInstance ( ) const

Standard methods for the VTK class.

◆ PrintSelf()

void vtkXWebGPURenderWindow::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard methods for the VTK class.

Reimplemented from vtkWebGPURenderWindow.

◆ Frame()

void vtkXWebGPURenderWindow::Frame ( )
overridevirtual

End the rendering process and display the image.

Reimplemented from vtkWebGPURenderWindow.

◆ WindowInitialize()

virtual void vtkXWebGPURenderWindow::WindowInitialize ( )
virtual

Initialize the window for rendering.

◆ WindowSetup()

bool vtkXWebGPURenderWindow::WindowSetup ( )
overridevirtual

Initialize the rendering window.

This will setup all system-specific resources. This method and Finalize() must be symmetric and it should be possible to call them multiple times, even changing WindowId in-between. This is what WindowRemap does.

Implements vtkWebGPURenderWindow.

◆ Finalize()

void vtkXWebGPURenderWindow::Finalize ( )
overridevirtual

"Deinitialize" the rendering window.

This will shutdown all system-specific resources. After having called this, it should be possible to destroy a window that was used for a SetWindowId() call without any ill effects.

Reimplemented from vtkRenderWindow.

◆ SetFullScreen()

void vtkXWebGPURenderWindow::SetFullScreen ( vtkTypeBool  )
overridevirtual

Change the window to fill the entire screen.

Reimplemented from vtkRenderWindow.

◆ WindowRemap()

void vtkXWebGPURenderWindow::WindowRemap ( )
overridevirtual

Resize the window.

Reimplemented from vtkRenderWindow.

◆ SetShowWindow()

void vtkXWebGPURenderWindow::SetShowWindow ( bool  )
overridevirtual

Show or not Show the window.

Reimplemented from vtkWindow.

◆ PrefFullScreen()

virtual void vtkXWebGPURenderWindow::PrefFullScreen ( )
virtual

Set the preferred window size to full screen.

◆ SetSize() [1/2]

void vtkXWebGPURenderWindow::SetSize ( int  width,
int  height 
)
overridevirtual

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

If this is a toplevel window with borders, then the request for a new size is redirected to the window manager. If the window manager chooses a different size for the window, the size it chooses will take effect at the next render, otherwise the size change will take effect immediately. In the rare case that the window manager does does not respond at all (buggy/frozen window manager), the SetSize() method will wait for the response for two seconds before returning.

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

Reimplemented from vtkWindow.

◆ SetSize() [2/2]

void vtkXWebGPURenderWindow::SetSize ( int  a[2])
inlineoverridevirtual

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

Reimplemented from vtkWindow.

Definition at line 97 of file vtkXWebGPURenderWindow.h.

◆ SetStereoCapableWindow()

void vtkXWebGPURenderWindow::SetStereoCapableWindow ( vtkTypeBool  capable)
overridevirtual

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

This method must be called before the window is realized. This method overrides the superclass method since this class can actually check whether the window has been realized yet.

Reimplemented from vtkRenderWindow.

◆ ReportCapabilities()

const char * vtkXWebGPURenderWindow::ReportCapabilities ( )
overridevirtual

Get report of capabilities for the render window.

Reimplemented from vtkWebGPURenderWindow.

◆ IsDirect()

vtkTypeBool vtkXWebGPURenderWindow::IsDirect ( )
overridevirtual

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

Reimplemented from vtkRenderWindow.

◆ GetGenericDisplayId()

void * vtkXWebGPURenderWindow::GetGenericDisplayId ( )
inlineoverridevirtual

Xwindow get set functions.

Reimplemented from vtkRenderWindow.

Definition at line 120 of file vtkXWebGPURenderWindow.h.

◆ GetGenericWindowId()

void * vtkXWebGPURenderWindow::GetGenericWindowId ( )
overridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkRenderWindow.

◆ GetGenericParentId()

void * vtkXWebGPURenderWindow::GetGenericParentId ( )
inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkRenderWindow.

Definition at line 123 of file vtkXWebGPURenderWindow.h.

◆ GetGenericDrawable()

void * vtkXWebGPURenderWindow::GetGenericDrawable ( )
inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkRenderWindow.

Definition at line 125 of file vtkXWebGPURenderWindow.h.

◆ GetScreenSize()

int * vtkXWebGPURenderWindow::GetScreenSize ( )
overridevirtual

Get the current size of the screen in pixels.

An HDTV for example would be 1920 x 1080 pixels.

Reimplemented from vtkWindow.

◆ GetPosition()

int * vtkXWebGPURenderWindow::GetPosition ( )
overridevirtual

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

Reimplemented from vtkWindow.

◆ GetDisplayId()

Display * vtkXWebGPURenderWindow::GetDisplayId ( )

Get this RenderWindow's X display id.

◆ EnsureDisplay()

bool vtkXWebGPURenderWindow::EnsureDisplay ( )
overridevirtual

Ensure RenderWindow's X display is opened.

Reimplemented from vtkWindow.

◆ SetDisplayId() [1/2]

void vtkXWebGPURenderWindow::SetDisplayId ( Display *  )

Set the X display id for this RenderWindow to use to a pre-existing X display id.

◆ SetDisplayId() [2/2]

void vtkXWebGPURenderWindow::SetDisplayId ( void *  )
overridevirtual

Set the X display id for this RenderWindow to use to a pre-existing X display id.

Reimplemented from vtkRenderWindow.

◆ GetParentId()

Window vtkXWebGPURenderWindow::GetParentId ( )

Get this RenderWindow's parent X window id.

◆ SetParentId() [1/2]

void vtkXWebGPURenderWindow::SetParentId ( Window  )

Sets the parent of the window that WILL BE created.

◆ SetParentId() [2/2]

void vtkXWebGPURenderWindow::SetParentId ( void *  )
overridevirtual

Sets the parent of the window that WILL BE created.

Reimplemented from vtkRenderWindow.

◆ GetWindowId()

Window vtkXWebGPURenderWindow::GetWindowId ( )

Get this RenderWindow's X window id.

◆ SetWindowId() [1/2]

void vtkXWebGPURenderWindow::SetWindowId ( Window  )

Set this RenderWindow's X window id to a pre-existing window.

◆ SetWindowId() [2/2]

void vtkXWebGPURenderWindow::SetWindowId ( void *  )
overridevirtual

Set this RenderWindow's X window id to a pre-existing window.

Reimplemented from vtkRenderWindow.

◆ SetNextWindowId() [1/2]

void vtkXWebGPURenderWindow::SetNextWindowId ( Window  )

Specify the X window id to use if a WindowRemap is done.

◆ SetNextWindowId() [2/2]

void vtkXWebGPURenderWindow::SetNextWindowId ( void *  )
overridevirtual

Set the window id of the new window once a WindowRemap is done.

This is the generic prototype as required by the vtkRenderWindow parent.

Reimplemented from vtkRenderWindow.

◆ SetWindowName()

void vtkXWebGPURenderWindow::SetWindowName ( const char *  )
overridevirtual

Set name of rendering window.

Reimplemented from vtkWindow.

◆ SetIcon()

void vtkXWebGPURenderWindow::SetIcon ( vtkImageData img)
overridevirtual

For window manager that supports it, set the icon displayed in the taskbar and the title bar.

Reimplemented from vtkWindow.

◆ InitializeFromCurrentContext()

bool vtkXWebGPURenderWindow::InitializeFromCurrentContext ( )
overridevirtual

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

Reimplemented from vtkWebGPURenderWindow.

◆ GetPlatformSupportsRenderWindowSharing()

bool vtkXWebGPURenderWindow::GetPlatformSupportsRenderWindowSharing ( )
inlineoverridevirtual

Does this platform support render window data sharing.

Reimplemented from vtkRenderWindow.

Definition at line 216 of file vtkXWebGPURenderWindow.h.

◆ SetPosition() [1/2]

void vtkXWebGPURenderWindow::SetPosition ( int  x,
int  y 
)
overridevirtual

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 from vtkWindow.

◆ SetPosition() [2/2]

void vtkXWebGPURenderWindow::SetPosition ( int  a[2])
inlineoverridevirtual

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 from vtkWindow.

Definition at line 225 of file vtkXWebGPURenderWindow.h.

◆ HideCursor()

void vtkXWebGPURenderWindow::HideCursor ( )
overridevirtual

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

Reimplemented from vtkRenderWindow.

◆ ShowCursor()

void vtkXWebGPURenderWindow::ShowCursor ( )
overridevirtual

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

Reimplemented from vtkRenderWindow.

◆ SetCurrentCursor()

void vtkXWebGPURenderWindow::SetCurrentCursor ( int  )
overridevirtual

Change the shape of the cursor.

Reimplemented from vtkRenderWindow.

◆ GetEventPending()

vtkTypeBool vtkXWebGPURenderWindow::GetEventPending ( )
overridevirtual

Check to see if a mouse button has been pressed or mouse wheel activated.

All other events are ignored by this method. This is a useful check to abort a long render.

Reimplemented from vtkRenderWindow.

◆ SetWindowInfo()

void vtkXWebGPURenderWindow::SetWindowInfo ( const char *  info)
overridevirtual

Set this RenderWindow's X window id to a pre-existing window.

Reimplemented from vtkRenderWindow.

◆ SetNextWindowInfo()

void vtkXWebGPURenderWindow::SetNextWindowInfo ( const char *  info)
overridevirtual

Set the window info that will be used after WindowRemap()

Reimplemented from vtkRenderWindow.

◆ SetParentInfo()

void vtkXWebGPURenderWindow::SetParentInfo ( const char *  info)
overridevirtual

Sets the X window id of the window that WILL BE created.

Reimplemented from vtkRenderWindow.

◆ Render()

void vtkXWebGPURenderWindow::Render ( )
overridevirtual

This computes the size of the render window before calling the supper classes render.

Reimplemented from vtkWebGPURenderWindow.

◆ MakeDefaultWindowNameWithBackend()

std::string vtkXWebGPURenderWindow::MakeDefaultWindowNameWithBackend ( )
overrideprotectedvirtual

Construct the window title as "Visualization Toolkit - <WindowSystem> <GraphicsBackend>" Ex: "Visualization Toolkit - X11 Vulkan" "Visualization Toolkit - X11 OpenGL" "Visualization Toolkit - Cocoa Metal" "Visualization Toolkit - Cocoa OpenGL" "Visualization Toolkit - Win32 D3D12".

Implements vtkWebGPURenderWindow.

◆ CreateAWindow()

void vtkXWebGPURenderWindow::CreateAWindow ( )
overrideprotectedvirtual

Create a not-off-screen window.

Implements vtkWebGPURenderWindow.

◆ DestroyWindow()

void vtkXWebGPURenderWindow::DestroyWindow ( )
overrideprotectedvirtual

Destroy a not-off-screen window.

Implements vtkWebGPURenderWindow.

◆ CloseDisplay()

void vtkXWebGPURenderWindow::CloseDisplay ( )
protected

Member Data Documentation

◆ ParentId

Window vtkXWebGPURenderWindow::ParentId
protected

Definition at line 275 of file vtkXWebGPURenderWindow.h.

◆ WindowId

Window vtkXWebGPURenderWindow::WindowId
protected

Definition at line 276 of file vtkXWebGPURenderWindow.h.

◆ NextWindowId

Window vtkXWebGPURenderWindow::NextWindowId
protected

Definition at line 277 of file vtkXWebGPURenderWindow.h.

◆ DisplayId

Display* vtkXWebGPURenderWindow::DisplayId
protected

Definition at line 278 of file vtkXWebGPURenderWindow.h.

◆ ColorMap

Colormap vtkXWebGPURenderWindow::ColorMap
protected

Definition at line 279 of file vtkXWebGPURenderWindow.h.

◆ OwnWindow

vtkTypeBool vtkXWebGPURenderWindow::OwnWindow
protected

Definition at line 280 of file vtkXWebGPURenderWindow.h.

◆ OwnDisplay

vtkTypeBool vtkXWebGPURenderWindow::OwnDisplay
protected

Definition at line 281 of file vtkXWebGPURenderWindow.h.

◆ CursorHidden

vtkTypeBool vtkXWebGPURenderWindow::CursorHidden
protected

Definition at line 282 of file vtkXWebGPURenderWindow.h.

◆ UsingHardware

vtkTypeBool vtkXWebGPURenderWindow::UsingHardware
protected

Definition at line 283 of file vtkXWebGPURenderWindow.h.

◆ XCCrosshair

Cursor vtkXWebGPURenderWindow::XCCrosshair
protected

Definition at line 286 of file vtkXWebGPURenderWindow.h.

◆ XCArrow

Cursor vtkXWebGPURenderWindow::XCArrow
protected

Definition at line 287 of file vtkXWebGPURenderWindow.h.

◆ XCSizeAll

Cursor vtkXWebGPURenderWindow::XCSizeAll
protected

Definition at line 288 of file vtkXWebGPURenderWindow.h.

◆ XCSizeNS

Cursor vtkXWebGPURenderWindow::XCSizeNS
protected

Definition at line 289 of file vtkXWebGPURenderWindow.h.

◆ XCSizeWE

Cursor vtkXWebGPURenderWindow::XCSizeWE
protected

Definition at line 290 of file vtkXWebGPURenderWindow.h.

◆ XCSizeNE

Cursor vtkXWebGPURenderWindow::XCSizeNE
protected

Definition at line 291 of file vtkXWebGPURenderWindow.h.

◆ XCSizeNW

Cursor vtkXWebGPURenderWindow::XCSizeNW
protected

Definition at line 292 of file vtkXWebGPURenderWindow.h.

◆ XCSizeSE

Cursor vtkXWebGPURenderWindow::XCSizeSE
protected

Definition at line 293 of file vtkXWebGPURenderWindow.h.

◆ XCSizeSW

Cursor vtkXWebGPURenderWindow::XCSizeSW
protected

Definition at line 294 of file vtkXWebGPURenderWindow.h.

◆ XCHand

Cursor vtkXWebGPURenderWindow::XCHand
protected

Definition at line 295 of file vtkXWebGPURenderWindow.h.

◆ XCCustom

Cursor vtkXWebGPURenderWindow::XCCustom
protected

Definition at line 296 of file vtkXWebGPURenderWindow.h.


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