VTK  9.3.1
vtkOSOpenGLRenderWindow.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
17 #ifndef vtkOSOpenGLRenderWindow_h
18 #define vtkOSOpenGLRenderWindow_h
19 
20 #include "vtkOpenGLRenderWindow.h"
21 #include "vtkRenderingOpenGL2Module.h" // For export macro
22 
23 VTK_ABI_NAMESPACE_BEGIN
24 class vtkIdList;
25 class vtkOSOpenGLRenderWindowInternal;
26 
27 class VTKRENDERINGOPENGL2_EXPORT vtkOSOpenGLRenderWindow : public vtkOpenGLRenderWindow
28 {
29 public:
30  static vtkOSOpenGLRenderWindow* New();
32  void PrintSelf(ostream& os, vtkIndent indent);
33 
37  virtual void Frame();
38 
42  virtual void WindowInitialize();
43 
50  void Initialize() override;
51 
57  virtual void Finalize();
58 
62  virtual void SetFullScreen(vtkTypeBool);
63 
65 
72  void SetSize(int width, int height) override;
73  void SetSize(int a[2]) override { this->SetSize(a[0], a[1]); }
75 
80  int* GetScreenSize() VTK_SIZEHINT(2) override;
81 
86  int* GetPosition() VTK_SIZEHINT(2) override;
87 
89 
92  void SetPosition(int x, int y) override;
93  void SetPosition(int a[2]) override { this->SetPosition(a[0], a[1]); }
95 
102  virtual void SetStereoCapableWindow(vtkTypeBool capable);
103 
107  void MakeCurrent();
108 
112  virtual bool IsCurrent();
113 
119  void SetForceMakeCurrent();
120 
124  const char* ReportCapabilities();
125 
129  int SupportsOpenGL();
130 
135 
139  virtual void WindowRemap();
140 
142 
145  virtual void* GetGenericDisplayId() { return 0; }
146  virtual void* GetGenericWindowId();
147  virtual void* GetGenericParentId() { return 0; }
148  virtual void* GetGenericContext();
149  virtual void* GetGenericDrawable() { return 0; }
151 
156  void SetDisplayId(void*) {}
157 
161  void SetParentId(void*);
162 
166  void SetWindowId(void*);
167 
173  void SetNextWindowId(void*);
174 
175  void SetWindowName(const char*);
176 
181  void HideCursor() {}
182  void ShowCursor() {}
183 
189  virtual vtkTypeBool GetEventPending();
190 
194  void SetWindowInfo(const char* info);
195 
199  void SetNextWindowInfo(const char* info);
200 
204  void SetParentInfo(const char* info);
205 
206 protected:
208  ~vtkOSOpenGLRenderWindow() override;
209 
210  vtkOSOpenGLRenderWindowInternal* Internal;
211 
216 
217  void CreateAWindow() override;
218  void DestroyWindow() override;
219  void CreateOffScreenWindow(int width, int height);
220  void DestroyOffScreenWindow();
221  void ResizeOffScreenWindow(int width, int height);
222 
223 private:
225  void operator=(const vtkOSOpenGLRenderWindow&) = delete;
226 };
227 
228 VTK_ABI_NAMESPACE_END
229 #endif
OpenGL rendering window.
virtual void SetForceMakeCurrent()
If called, allow MakeCurrent() to skip cache-check when called.
virtual void SetFullScreen(vtkTypeBool)
Turn on/off rendering full screen window size.
void * GetGenericContext() override
Dummy stubs for vtkWindow API.
virtual void WindowRemap()
Remap the rendering window.
virtual void SetNextWindowId(void *)
Dummy stubs for vtkWindow API.
static vtkRenderWindow * New()
Construct an instance of vtkRenderWindow with its screen size set to 300x300, borders turned on...
void * GetGenericWindowId() override
Dummy stubs for vtkWindow API.
vtkOSOpenGLRenderWindowInternal * Internal
OffScreen Mesa rendering window.
void SetWindowInfo(const char *) override
Dummy stubs for vtkWindow API.
virtual bool IsCurrent()
Tells if this window is the current graphics context for the calling thread.
virtual void Finalize()
Finalize the rendering process.
void SetParentId(void *) override
Dummy stubs for vtkWindow API.
int vtkTypeBool
Definition: vtkABI.h:64
void SetPosition(int a[2]) override
Move the window to a new position on the display.
virtual void SetStereoCapableWindow(vtkTypeBool capable)
Prescribe that the window be created in a stereo-capable mode.
virtual void SetNextWindowInfo(const char *)
Dummy stubs for vtkWindow API.
void HideCursor()
Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to di...
virtual void SetSize(int width, int height)
Set the size (width and height) of the rendering window in screen coordinates (in pixels)...
void SetWindowId(void *) override
Dummy stubs for vtkWindow API.
virtual void * GetGenericParentId()
Xwindow get set functions.
a simple class to control print indentation
Definition: vtkIndent.h:28
virtual void DestroyWindow()=0
Destroy a not-off-screen window.
list of point or cell ids
Definition: vtkIdList.h:22
virtual int * GetScreenSize()
Get the current size of the screen in pixels.
Definition: vtkWindow.h:94
int SupportsOpenGL() override
Does this render window support OpenGL? 0-false, 1-true.
virtual void Initialize()
Initialize the rendering window.
virtual void MakeCurrent()
Make the window current.
Definition: vtkWindow.h:235
#define VTK_SIZEHINT(...)
const char * ReportCapabilities() override
Get report of capabilities for the render window.
void Frame() override
A termination method performed at the end of the rendering process to do things like swapping buffers...
void ShowCursor()
Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to di...
virtual vtkTypeBool GetEventPending()
Check to see if a mouse button has been pressed.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetDisplayId(void *)
Set the X display id for this RenderWindow to use to a pre-existing X display id. ...
virtual void * GetGenericDisplayId()
Xwindow get set functions.
virtual void SetWindowName(const char *)
Get name of rendering window.
void SetParentInfo(const char *) override
Dummy stubs for vtkWindow API.
virtual void CreateAWindow()=0
Create a not-off-screen window.
void SetSize(int a[2]) override
Set the size of the window in screen coordinates in pixels.
virtual vtkTypeBool IsDirect()
Is this render window using hardware acceleration? 0-false, 1-true.
virtual void * GetGenericDrawable()
Xwindow get set functions.