VTK  9.3.20240329
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSDL2WebGPURenderWindow Class Reference

OpenGL rendering window. More...

#include <vtkSDL2WebGPURenderWindow.h>

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

Public Types

typedef vtkWebGPURenderWindow Superclass
 
- Public Types inherited from vtkWebGPURenderWindow
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. More...
 
vtkSDL2WebGPURenderWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool Initialize () override
 Initialize the rendering window. More...
 
void Finalize () override
 Finalize the rendering window. More...
 
void SetFullScreen (vtkTypeBool) override
 Change the window to fill the entire screen. More...
 
void SetShowWindow (bool val) override
 Show or not Show the window. More...
 
int * GetSize () override
 Get the current size of the window in pixels. More...
 
int * GetScreenSize () override
 Get the current size of the screen in pixels. More...
 
int * GetPosition () override
 Get the position in screen coordinates of the window. More...
 
void SetWindowName (const char *) override
 Set the name of the window. More...
 
void * GetGenericWindowId () override
 Dummy stubs for vtkWindow API. More...
 
void * GetGenericDrawable () override
 Dummy stubs for vtkWindow API. More...
 
void MakeCurrent () override
 Make the window current. More...
 
void ReleaseCurrent () override
 Release the current context. More...
 
bool IsCurrent () override
 Tells if this window is the current OpenGL context for the calling thread. More...
 
void Clean ()
 Clean up device contexts, rendering contexts, etc. More...
 
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. More...
 
int GetColorBufferSizes (int *rgba) override
 Get the size of the color buffer. More...
 
void SetSize (int, int) override
 Set the size of the window in pixels. More...
 
void SetSize (int a[2]) override
 Set the size of the window in pixels. More...
 
void SetPosition (int, int) override
 Set the position of the window. More...
 
void SetPosition (int a[2]) override
 Set the position of the window. More...
 
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. More...
 
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. More...
 
- Public Member Functions inherited from vtkWebGPURenderWindow
vtkWebGPURenderWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Start () override
 Start the rendering process for a frame. More...
 
void End () override
 Update the system, if needed, at end of render process. More...
 
void Render () override
 Handle opengl specific code and calls superclass. More...
 
void StereoMidpoint () override
 Intermediate method performs operations required between the rendering of the left and right eye. More...
 
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. More...
 
const char * GetRenderingBackend () override
 What rendering backend has the user requested. More...
 
void ReadPixels ()
 Reads pixels into the CachedPixelBytes variable. More...
 
int GetColorBufferSizes (int *rgba) override
 Get the size of the color buffer. More...
 
void WaitForCompletion () override
 Block the thread until work queue completes all submitted work. More...
 
int SupportsOpenGL () override
 Does this render window support OpenGL? 0-false, 1-true. More...
 
const char * ReportCapabilities () override
 Get report of capabilities for the render window. More...
 
bool InitializeFromCurrentContext () override
 Initialize the render window from the information associated with the currently activated OpenGL context. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Free up any graphics resources associated with this window a value of NULL means the context may already be destroyed. More...
 
wgpu::RenderPassEncoder NewRenderPass (wgpu::RenderPassDescriptor &descriptor)
 
wgpu::RenderBundleEncoder NewRenderBundleEncoder (wgpu::RenderBundleEncoderDescriptor &descriptor)
 
wgpu::CommandEncoder GetCommandEncoder ()
 
wgpu::TextureView GetOffscreenColorAttachmentView ()
 
wgpu::TextureView GetDepthStencilView ()
 
wgpu::TextureFormat GetDepthStencilFormat ()
 
bool HasStencil ()
 
wgpu::Device GetDevice ()
 
wgpu::TextureFormat GetPreferredSwapChainTextureFormat ()
 
void PreferHighPerformanceAdapter ()
 Set preference for a high-performance or low-power device. More...
 
void PreferLowPowerAdapter ()
 Set preference for a high-performance or low-power device. More...
 
void SetBackendTypeToD3D11 ()
 Get/Set backend type. More...
 
void SetBackendTypeToD3D12 ()
 Get/Set backend type. More...
 
void SetBackendTypeToMetal ()
 Get/Set backend type. More...
 
void SetBackendTypeToVulkan ()
 Get/Set backend type. More...
 
void SetBackendTypeToOpenGL ()
 Get/Set backend type. More...
 
void SetBackendTypeToOpenGLES ()
 Get/Set backend type. More...
 
std::string GetBackendTypeAsString ()
 Get/Set backend type. More...
 
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... More...
 
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... More...
 
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... More...
 
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... More...
 
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... More...
 
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... More...
 
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... More...
 
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... More...
 
void ReleaseRGBAPixelData (float *data) override
 Set/Get the pixel data of an image, transmitted as RGBARGBA... More...
 
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... More...
 
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... More...
 
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... More...
 
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... More...
 
float * GetZbufferData (int x1, int y1, int x2, int y2) override
 Set/Get the zbuffer data from an image. More...
 
int GetZbufferData (int x1, int y1, int x2, int y2, float *z) override
 Set/Get the zbuffer data from an image. More...
 
int GetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *buffer) override
 Set/Get the zbuffer data from an image. More...
 
int SetZbufferData (int x1, int y1, int x2, int y2, float *buffer) override
 Set/Get the zbuffer data from an image. More...
 
int SetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *buffer) override
 Set/Get the zbuffer data from an image. More...
 
- Public Member Functions inherited from vtkRenderWindow
vtkRenderWindowNewInstance () const
 
virtual void AddRenderer (vtkRenderer *)
 Add a renderer to the list of renderers. More...
 
void RemoveRenderer (vtkRenderer *)
 Remove a renderer from the list of renderers. More...
 
vtkTypeBool HasRenderer (vtkRenderer *)
 Query if a renderer is in the list of renderers. More...
 
 vtkGetNewMacro (RenderTimer, vtkRenderTimerLog)
 Get the render timer log for this window. More...
 
vtkRendererCollectionGetRenderers ()
 Return the collection of renderers in the render window. More...
 
void CaptureGL2PSSpecialProps (vtkCollection *specialProps)
 The GL2PS exporter must handle certain props in a special way (e.g. More...
 
virtual void CopyResultFrame ()
 Performed at the end of the rendering process to generate image. More...
 
virtual vtkRenderWindowInteractorMakeRenderWindowInteractor ()
 Create an interactor to control renderers in this window. More...
 
virtual void StereoUpdate ()
 Update the system, if needed, due to stereo rendering. More...
 
virtual void StereoRenderComplete ()
 Handles work required once both views have been rendered when using stereo rendering. More...
 
virtual void WindowRemap ()
 Remap the rendering window. More...
 
virtual vtkTypeBool GetEventPending ()
 Check to see if a mouse button has been pressed. More...
 
virtual int CheckInRenderStatus ()
 Are we rendering at the moment. More...
 
virtual void ClearInRenderStatus ()
 Clear status (after an exception was thrown for example) More...
 
virtual void SetInteractor (vtkRenderWindowInteractor *)
 Set the interactor to the render window. More...
 
void UnRegister (vtkObjectBase *o) override
 This Method detects loops of RenderWindow<->Interactor, so objects are freed properly. More...
 
virtual void SetForceMakeCurrent ()
 If called, allow MakeCurrent() to skip cache-check when called. More...
 
virtual vtkTypeBool IsDirect ()
 Is this render window using hardware acceleration? 0-false, 1-true. More...
 
virtual int GetDepthBufferSize ()
 This method should be defined by the subclass. More...
 
virtual int GetNumberOfDevices ()
 Returns the number of devices (graphics cards) on a system. More...
 
virtual void GetPhysicalToWorldMatrix (vtkMatrix4x4 *matrix)
 Get physical to world transform matrix. More...
 
virtual bool GetDeviceToWorldMatrixForDevice (vtkEventDataDevice device, vtkMatrix4x4 *deviceToWorldMatrix)
 Store in deviceToWorldMatrix the matrix that goes from device coordinates to world coordinates. More...
 
virtual int GetCapturingGL2PSSpecialProps ()
 Returns true if the render process is capturing text actors. More...
 
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. More...
 
virtual void SetCurrentCursor (int)
 Change the shape of the cursor. More...
 
virtual int GetCurrentCursor ()
 Change the shape of the cursor. More...
 
 vtkSetFilePathMacro (CursorFileName)
 Set/Get the full path to the custom cursor. More...
 
 vtkGetFilePathMacro (CursorFileName)
 Set/Get the full path to the custom cursor. More...
 
virtual vtkTypeBool GetFullScreen ()
 Turn on/off rendering full screen window size. More...
 
virtual void FullScreenOn ()
 Turn on/off rendering full screen window size. More...
 
virtual void FullScreenOff ()
 Turn on/off rendering full screen window size. More...
 
virtual void SetBorders (vtkTypeBool)
 Turn on/off window manager borders. More...
 
virtual vtkTypeBool GetBorders ()
 Turn on/off window manager borders. More...
 
virtual void BordersOn ()
 Turn on/off window manager borders. More...
 
virtual void BordersOff ()
 Turn on/off window manager borders. More...
 
virtual vtkTypeBool GetStereoCapableWindow ()
 Prescribe that the window be created in a stereo-capable mode. More...
 
virtual void StereoCapableWindowOn ()
 Prescribe that the window be created in a stereo-capable mode. More...
 
virtual void StereoCapableWindowOff ()
 Prescribe that the window be created in a stereo-capable mode. More...
 
virtual void SetStereoCapableWindow (vtkTypeBool capable)
 Prescribe that the window be created in a stereo-capable mode. More...
 
virtual vtkTypeBool GetStereoRender ()
 Turn on/off stereo rendering. More...
 
void SetStereoRender (vtkTypeBool stereo)
 Turn on/off stereo rendering. More...
 
virtual void StereoRenderOn ()
 Turn on/off stereo rendering. More...
 
virtual void StereoRenderOff ()
 Turn on/off stereo rendering. More...
 
virtual void SetAlphaBitPlanes (vtkTypeBool)
 Turn on/off the use of alpha bitplanes. More...
 
virtual vtkTypeBool GetAlphaBitPlanes ()
 Turn on/off the use of alpha bitplanes. More...
 
virtual void AlphaBitPlanesOn ()
 Turn on/off the use of alpha bitplanes. More...
 
virtual void AlphaBitPlanesOff ()
 Turn on/off the use of alpha bitplanes. More...
 
virtual void SetPointSmoothing (vtkTypeBool)
 Turn on/off point smoothing. More...
 
virtual vtkTypeBool GetPointSmoothing ()
 Turn on/off point smoothing. More...
 
virtual void PointSmoothingOn ()
 Turn on/off point smoothing. More...
 
virtual void PointSmoothingOff ()
 Turn on/off point smoothing. More...
 
virtual void SetLineSmoothing (vtkTypeBool)
 Turn on/off line smoothing. More...
 
virtual vtkTypeBool GetLineSmoothing ()
 Turn on/off line smoothing. More...
 
virtual void LineSmoothingOn ()
 Turn on/off line smoothing. More...
 
virtual void LineSmoothingOff ()
 Turn on/off line smoothing. More...
 
virtual void SetPolygonSmoothing (vtkTypeBool)
 Turn on/off polygon smoothing. More...
 
virtual vtkTypeBool GetPolygonSmoothing ()
 Turn on/off polygon smoothing. More...
 
virtual void PolygonSmoothingOn ()
 Turn on/off polygon smoothing. More...
 
virtual void PolygonSmoothingOff ()
 Turn on/off polygon smoothing. More...
 
virtual int GetStereoType ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoType (int)
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToCrystalEyes ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToRedBlue ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToInterlaced ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToLeft ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToRight ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToDresden ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToAnaglyph ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToCheckerboard ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToSplitViewportHorizontal ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToFake ()
 Set/Get what type of stereo rendering to use. More...
 
void SetStereoTypeToEmulate ()
 Set/Get what type of stereo rendering to use. More...
 
virtual void SetAnaglyphColorSaturation (float)
 Set/get the anaglyph color saturation factor. More...
 
virtual float GetAnaglyphColorSaturation ()
 Set/get the anaglyph color saturation factor. More...
 
virtual void SetAnaglyphColorMask (int, int)
 Set/get the anaglyph color mask values. More...
 
void SetAnaglyphColorMask (int[2])
 Set/get the anaglyph color mask values. More...
 
virtual int * GetAnaglyphColorMask ()
 Set/get the anaglyph color mask values. More...
 
virtual void GetAnaglyphColorMask (int data[2])
 Set/get the anaglyph color mask values. More...
 
virtual void SetSwapBuffers (vtkTypeBool)
 Turn on/off buffer swapping between images. More...
 
virtual vtkTypeBool GetSwapBuffers ()
 Turn on/off buffer swapping between images. More...
 
virtual void SwapBuffersOn ()
 Turn on/off buffer swapping between images. More...
 
virtual void SwapBuffersOff ()
 Turn on/off buffer swapping between images. More...
 
float GetZbufferDataAtPoint (int x, int y)
 Set/Get the zbuffer data from the frame buffer. More...
 
virtual int GetNeverRendered ()
 This flag is set if the window hasn't rendered since it was created. More...
 
virtual int GetAbortRender ()
 This is a flag that can be set to interrupt a rendering that is in progress. More...
 
virtual void SetAbortRender (int)
 This is a flag that can be set to interrupt a rendering that is in progress. More...
 
virtual int GetInAbortCheck ()
 This is a flag that can be set to interrupt a rendering that is in progress. More...
 
virtual void SetInAbortCheck (int)
 This is a flag that can be set to interrupt a rendering that is in progress. More...
 
virtual int CheckAbortStatus ()
 This is a flag that can be set to interrupt a rendering that is in progress. More...
 
virtual void SetDesiredUpdateRate (double)
 Set/Get the desired update rate. More...
 
virtual double GetDesiredUpdateRate ()
 Set/Get the desired update rate. More...
 
virtual int GetNumberOfLayers ()
 Get the number of layers for renderers. More...
 
virtual void SetNumberOfLayers (int)
 Get the number of layers for renderers. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 Get the interactor associated with this render window. More...
 
void SetDisplayId (void *) override
 Dummy stubs for vtkWindow API. More...
 
void SetWindowId (void *) override
 Dummy stubs for vtkWindow API. More...
 
virtual void SetNextWindowId (void *)
 Dummy stubs for vtkWindow API. More...
 
void SetParentId (void *) override
 Dummy stubs for vtkWindow API. More...
 
void * GetGenericDisplayId () override
 Dummy stubs for vtkWindow API. More...
 
void * GetGenericParentId () override
 Dummy stubs for vtkWindow API. More...
 
void * GetGenericContext () override
 Dummy stubs for vtkWindow API. More...
 
void SetWindowInfo (const char *) override
 Dummy stubs for vtkWindow API. More...
 
virtual void SetNextWindowInfo (const char *)
 Dummy stubs for vtkWindow API. More...
 
void SetParentInfo (const char *) override
 Dummy stubs for vtkWindow API. More...
 
virtual void SetSharedRenderWindow (vtkRenderWindow *)
 Set/Get an already existing window that this window should share data with if possible. More...
 
virtual vtkRenderWindowGetSharedRenderWindow ()
 Set/Get an already existing window that this window should share data with if possible. More...
 
virtual bool GetPlatformSupportsRenderWindowSharing ()
 Set/Get an already existing window that this window should share data with if possible. More...
 
virtual void SetMultiSamples (int)
 Set / Get the number of multisamples to use for hardware antialiasing. More...
 
virtual int GetMultiSamples ()
 Set / Get the number of multisamples to use for hardware antialiasing. More...
 
virtual void SetStencilCapable (vtkTypeBool)
 Set / Get the availability of the stencil buffer. More...
 
virtual vtkTypeBool GetStencilCapable ()
 Set / Get the availability of the stencil buffer. More...
 
virtual void StencilCapableOn ()
 Set / Get the availability of the stencil buffer. More...
 
virtual void StencilCapableOff ()
 Set / Get the availability of the stencil buffer. More...
 
virtual void SetDeviceIndex (int)
 If there are several graphics card installed on a system, this index can be used to specify which card you want to render to. More...
 
virtual int GetDeviceIndex ()
 If there are several graphics card installed on a system, this index can be used to specify which card you want to render to. More...
 
virtual bool GetUseSRGBColorSpace ()
 Set/Get if we want this window to use the sRGB color space. More...
 
virtual void SetUseSRGBColorSpace (bool)
 Set/Get if we want this window to use the sRGB color space. More...
 
virtual void UseSRGBColorSpaceOn ()
 Set/Get if we want this window to use the sRGB color space. More...
 
virtual void UseSRGBColorSpaceOff ()
 Set/Get if we want this window to use the sRGB color space. More...
 
const char * GetStereoTypeAsString ()
 Returns the stereo type as a string. More...
 
- Public Member Functions inherited from vtkWindow
vtkWindowNewInstance () const
 
int * GetActualSize ()
 GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale. More...
 
virtual void SetIcon (vtkImageData *)
 Set the icon used in title bar and task bar. More...
 
virtual bool DetectDPI ()
 Attempt to detect and set the DPI of the display device by querying the system. More...
 
vtkTypeBool GetOffScreenRendering ()
 Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead. More...
 
virtual vtkTypeBool GetMapped ()
 Keep track of whether the rendering window has been mapped to screen. More...
 
virtual bool GetShowWindow ()
 Show or not Show the window. More...
 
virtual void ShowWindowOn ()
 Show or not Show the window. More...
 
virtual void ShowWindowOff ()
 Show or not Show the window. More...
 
virtual void SetUseOffScreenBuffers (bool)
 Render to an offscreen destination such as a framebuffer. More...
 
virtual bool GetUseOffScreenBuffers ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void UseOffScreenBuffersOn ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void UseOffScreenBuffersOff ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void SetErase (vtkTypeBool)
 Turn on/off erasing the screen between images. More...
 
virtual vtkTypeBool GetErase ()
 Turn on/off erasing the screen between images. More...
 
virtual void EraseOn ()
 Turn on/off erasing the screen between images. More...
 
virtual void EraseOff ()
 Turn on/off erasing the screen between images. More...
 
virtual void SetDoubleBuffer (vtkTypeBool)
 Keep track of whether double buffering is on or off. More...
 
virtual vtkTypeBool GetDoubleBuffer ()
 Keep track of whether double buffering is on or off. More...
 
virtual void DoubleBufferOn ()
 Keep track of whether double buffering is on or off. More...
 
virtual void DoubleBufferOff ()
 Keep track of whether double buffering is on or off. More...
 
virtual char * GetWindowName ()
 Get name of rendering window. More...
 
virtual int GetDPI ()
 Return a best estimate to the dots per inch of the display device being rendered (or printed). More...
 
virtual void SetDPI (int)
 Return a best estimate to the dots per inch of the display device being rendered (or printed). More...
 
void SetOffScreenRendering (vtkTypeBool val)
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOn ()
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOff ()
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void SetTileScale (int, int)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
void SetTileScale (int[2])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual int * GetTileScale ()
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void GetTileScale (int &, int &)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void GetTileScale (int[2])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
void SetTileScale (int s)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
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. More...
 
virtual void SetTileViewport (double[4])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual double * GetTileViewport ()
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
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. More...
 
virtual void GetTileViewport (double[4])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkSDL2WebGPURenderWindowNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkSDL2WebGPURenderWindowSafeDownCast (vtkObjectBase *o)
 
- 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. More...
 
static const char * GetRenderLibrary ()
 What rendering library has the user requested. More...
 
static const char * GetStereoTypeAsString (int type)
 Returns the stereo type as a string. More...
 
- Static Public Member Functions inherited from vtkWindow
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkSDL2WebGPURenderWindow ()
 
 ~vtkSDL2WebGPURenderWindow () 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". More...
 
void CleanUpRenderers ()
 
void CreateAWindow () override
 Create a not-off-screen window. More...
 
void DestroyWindow () override
 Destroy a not-off-screen window. More...
 
- Protected Member Functions inherited from vtkWebGPURenderWindow
 vtkWebGPURenderWindow ()
 
 ~vtkWebGPURenderWindow () override
 
bool WGPUInit ()
 
void WGPUFinalize ()
 
void CreateSwapChain ()
 
void DestroySwapChain ()
 
void CreateOffscreenColorAttachments ()
 
void DestroyOffscreenColorAttachments ()
 
void CreateDepthStencilTexture ()
 
void DestroyDepthStencilTexture ()
 
void CreateFSQGraphicsPipeline ()
 
void DestroyFSQGraphicsPipeline ()
 
void RenderOffscreenTexture ()
 
void FlushCommandBuffers (vtkTypeUInt32 count, wgpu::CommandBuffer *buffers)
 
- Protected Member Functions inherited from vtkRenderWindow
 vtkRenderWindow ()
 
 ~vtkRenderWindow () override
 
virtual void DoStereoRender ()
 
- Protected Member Functions inherited from vtkWindow
 vtkWindow ()
 
 ~vtkWindow () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

void * WindowId = nullptr
 
- Protected Attributes inherited from vtkWebGPURenderWindow
bool WGPUInitialized = false
 
wgpu::PowerPreference PowerPreference = wgpu::PowerPreference::HighPerformance
 
wgpu::BackendType RenderingBackendType = wgpu::BackendType::Vulkan
 
wgpu::Adapter Adapter
 
wgpu::Device Device
 
wgpu::Surface Surface
 
wgpu::CommandEncoder CommandEncoder
 
vtkWGPUSwapChain SwapChain
 
vtkWGPUDeptStencil DepthStencil
 
vtkWGPUColorAttachment ColorAttachment
 
vtkWGPUUserStagingPixelData StagingPixelData
 
vtkWGPUFullScreenQuad FSQ
 
struct vtkWebGPURenderWindow::MappingContext BufferMapReadContext
 
vtkNew< vtkTypeUInt8Array > CachedPixelBytes
 
int ScreenSize [2]
 
- Protected Attributes inherited from vtkRenderWindow
vtkRendererCollectionRenderers
 
vtkNew< vtkRenderTimerLogRenderTimer
 
vtkTypeBool Borders
 
vtkTypeBool FullScreen
 
int OldScreen [5]
 
vtkTypeBool PointSmoothing
 
vtkTypeBool LineSmoothing
 
vtkTypeBool PolygonSmoothing
 
vtkTypeBool StereoRender
 
int StereoType
 
vtkTypeBool StereoCapableWindow
 
vtkTypeBool AlphaBitPlanes
 
vtkRenderWindowInteractorInteractor
 
vtkSmartPointer< vtkUnsignedCharArrayStereoBuffer
 
vtkSmartPointer< vtkUnsignedCharArrayResultFrame
 
vtkTypeBool SwapBuffers
 
double DesiredUpdateRate
 
int AbortRender
 
int InAbortCheck
 
int InRender
 
int NeverRendered
 
int NumberOfLayers
 
int CurrentCursor
 
float AnaglyphColorSaturation
 
int AnaglyphColorMask [2]
 
int MultiSamples
 
vtkTypeBool StencilCapable
 
int CapturingGL2PSSpecialProps
 
int DeviceIndex
 
bool UseSRGBColorSpace
 
char * CursorFileName
 
double AbortCheckTime
 The universal time since the last abort check occurred. More...
 
vtkRenderWindowSharedRenderWindow
 
- Protected Attributes inherited from vtkWindow
char * WindowName
 
int Size [2]
 
int Position [2]
 
vtkTypeBool Mapped
 
bool ShowWindow
 
bool UseOffScreenBuffers
 
vtkTypeBool Erase
 
vtkTypeBool DoubleBuffer
 
int DPI
 
double TileViewport [4]
 
int TileSize [2]
 
int TileScale [2]
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

OpenGL rendering window.

vtkSDL2WebGPURenderWindow is a concrete implementation of the abstract class vtkRenderWindow. vtkSDL2OpenGL2Renderer interfaces to the standard OpenGL graphics library using SDL2

Definition at line 24 of file vtkSDL2WebGPURenderWindow.h.

Member Typedef Documentation

◆ Superclass

Definition at line 28 of file vtkSDL2WebGPURenderWindow.h.

Constructor & Destructor Documentation

◆ vtkSDL2WebGPURenderWindow()

vtkSDL2WebGPURenderWindow::vtkSDL2WebGPURenderWindow ( )
protected

◆ ~vtkSDL2WebGPURenderWindow()

vtkSDL2WebGPURenderWindow::~vtkSDL2WebGPURenderWindow ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSDL2WebGPURenderWindow* vtkSDL2WebGPURenderWindow::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkSDL2WebGPURenderWindow::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 vtkWebGPURenderWindow.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSDL2WebGPURenderWindow::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkWebGPURenderWindow.

◆ NewInstance()

vtkSDL2WebGPURenderWindow* vtkSDL2WebGPURenderWindow::NewInstance ( ) const

◆ PrintSelf()

void vtkSDL2WebGPURenderWindow::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.

◆ Initialize()

bool vtkSDL2WebGPURenderWindow::Initialize ( )
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 vtkSDL2WebGPURenderWindow::Finalize ( )
overridevirtual

Finalize 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 vtkSDL2WebGPURenderWindow::SetFullScreen ( vtkTypeBool  )
overridevirtual

Change the window to fill the entire screen.

Reimplemented from vtkRenderWindow.

◆ SetShowWindow()

void vtkSDL2WebGPURenderWindow::SetShowWindow ( bool  val)
overridevirtual

Show or not Show the window.

Reimplemented from vtkWindow.

◆ SetSize() [1/2]

void vtkSDL2WebGPURenderWindow::SetSize ( int  ,
int   
)
overridevirtual

Set the size of the window in pixels.

Reimplemented from vtkWindow.

◆ SetSize() [2/2]

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

Set the size of the window in pixels.

Reimplemented from vtkWindow.

Definition at line 61 of file vtkSDL2WebGPURenderWindow.h.

◆ GetSize()

int* vtkSDL2WebGPURenderWindow::GetSize ( )
overridevirtual

Get the current size of the window in pixels.

Reimplemented from vtkWindow.

◆ SetPosition() [1/2]

void vtkSDL2WebGPURenderWindow::SetPosition ( int  ,
int   
)
overridevirtual

Set the position of the window.

Reimplemented from vtkWindow.

◆ SetPosition() [2/2]

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

Set the position of the window.

Reimplemented from vtkWindow.

Definition at line 74 of file vtkSDL2WebGPURenderWindow.h.

◆ GetScreenSize()

int* vtkSDL2WebGPURenderWindow::GetScreenSize ( )
overridevirtual

Get the current size of the screen in pixels.

Reimplemented from vtkWindow.

◆ GetPosition()

int* vtkSDL2WebGPURenderWindow::GetPosition ( )
overridevirtual

Get the position in screen coordinates of the window.

Reimplemented from vtkWindow.

◆ SetWindowName()

void vtkSDL2WebGPURenderWindow::SetWindowName ( const char *  )
overridevirtual

Set the name of the window.

This appears at the top of the window normally.

Reimplemented from vtkWindow.

◆ GetGenericWindowId()

void* vtkSDL2WebGPURenderWindow::GetGenericWindowId ( )
inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkRenderWindow.

Definition at line 93 of file vtkSDL2WebGPURenderWindow.h.

◆ GetGenericDrawable()

void* vtkSDL2WebGPURenderWindow::GetGenericDrawable ( )
inlineoverridevirtual

Dummy stubs for vtkWindow API.

Reimplemented from vtkRenderWindow.

Definition at line 94 of file vtkSDL2WebGPURenderWindow.h.

◆ MakeCurrent()

void vtkSDL2WebGPURenderWindow::MakeCurrent ( )
inlineoverridevirtual

Make the window current.

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

Reimplemented from vtkWindow.

Definition at line 96 of file vtkSDL2WebGPURenderWindow.h.

◆ ReleaseCurrent()

void vtkSDL2WebGPURenderWindow::ReleaseCurrent ( )
inlineoverridevirtual

Release the current context.

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

Reimplemented from vtkWindow.

Definition at line 98 of file vtkSDL2WebGPURenderWindow.h.

◆ IsCurrent()

bool vtkSDL2WebGPURenderWindow::IsCurrent ( )
inlineoverridevirtual

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

Reimplemented from vtkRenderWindow.

Definition at line 103 of file vtkSDL2WebGPURenderWindow.h.

◆ Clean()

void vtkSDL2WebGPURenderWindow::Clean ( )

Clean up device contexts, rendering contexts, etc.

◆ Frame()

void vtkSDL2WebGPURenderWindow::Frame ( )
overridevirtual

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

Reimplemented from vtkRenderWindow.

◆ GetColorBufferSizes()

int vtkSDL2WebGPURenderWindow::GetColorBufferSizes ( int *  rgba)
overridevirtual

Get the size of the color buffer.

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

Reimplemented from vtkRenderWindow.

◆ HideCursor()

void vtkSDL2WebGPURenderWindow::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 vtkSDL2WebGPURenderWindow::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.

◆ MakeDefaultWindowNameWithBackend()

std::string vtkSDL2WebGPURenderWindow::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.

◆ CleanUpRenderers()

void vtkSDL2WebGPURenderWindow::CleanUpRenderers ( )
protected

◆ CreateAWindow()

void vtkSDL2WebGPURenderWindow::CreateAWindow ( )
overrideprotectedvirtual

Create a not-off-screen window.

Implements vtkWebGPURenderWindow.

◆ DestroyWindow()

void vtkSDL2WebGPURenderWindow::DestroyWindow ( )
overrideprotectedvirtual

Destroy a not-off-screen window.

Implements vtkWebGPURenderWindow.

Member Data Documentation

◆ WindowId

void* vtkSDL2WebGPURenderWindow::WindowId = nullptr
protected

Definition at line 135 of file vtkSDL2WebGPURenderWindow.h.


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