VTK  9.5.20251214
vtkGenericOpenGLRenderWindow.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
112
113#ifndef vtkGenericOpenGLRenderWindow_h
114#define vtkGenericOpenGLRenderWindow_h
115
117#include "vtkRenderingOpenGL2Module.h" // For export macro
118
119VTK_ABI_NAMESPACE_BEGIN
120class VTKRENDERINGOPENGL2_EXPORT vtkGenericOpenGLRenderWindow : public vtkOpenGLRenderWindow
121{
122public:
125 void PrintSelf(ostream& os, vtkIndent indent) override;
126
127protected:
130
131public:
133 void Finalize() override;
134
137 void Frame() override;
138
141 void MakeCurrent() override;
142
146 bool IsCurrent() override;
147
151 int SupportsOpenGL() override;
152
157
158 // {@
160 void SetFrontLeftBuffer(unsigned int);
161 void SetFrontRightBuffer(unsigned int);
162 void SetBackLeftBuffer(unsigned int);
163 void SetBackRightBuffer(unsigned int);
164 // }@
165
167
169 void PushState() {}
171 void PopState() {}
172
173 // {@
175 void SetWindowId(void*) override;
176 void* GetGenericWindowId() override;
177 void SetDisplayId(void*) override;
178 void SetParentId(void*) override;
179 void* GetGenericDisplayId() override;
180 void* GetGenericParentId() override;
181 void* GetGenericContext() override;
182 void* GetGenericDrawable() override;
183 void SetWindowInfo(const char*) override;
184 void SetParentInfo(const char*) override;
185 int* GetScreenSize() VTK_SIZEHINT(2) override;
186 void HideCursor() override;
187 void ShowCursor() override;
189 void WindowRemap() override;
191 void SetNextWindowId(void*) override;
192 void SetNextWindowInfo(const char*) override;
193 void CreateAWindow() override;
194 void DestroyWindow() override;
195 // }@
196
198
202 void SetIsDirect(vtkTypeBool newValue);
203 void SetSupportsOpenGL(int newValue);
204 void SetIsCurrent(bool newValue);
206
214 void Render() override;
215
220
222
226 vtkSetClampMacro(ForceMaximumHardwareLineWidth, float, 0, VTK_FLOAT_MAX);
227 vtkGetMacro(ForceMaximumHardwareLineWidth, float);
229
231
236 vtkSetMacro(ReadyForRendering, bool);
237 vtkGetMacro(ReadyForRendering, bool);
238
243 vtkSetVector2Macro(ScreenSize, int);
244
248 void SetCurrentCursor(int cShape) override;
249
250 // since we are using an external context it must
251 // specify if the window is mapped or not.
252 vtkSetMacro(Mapped, vtkTypeBool);
253
257 void OpenGLInit() override;
258
259protected:
266 const vtkRecti& rect, int front, int glFormat, int glType, void* data, int right) override;
267
269 int x1, int y1, int x2, int y2, unsigned char* data, int front, int right) override;
271 int x1, int y1, int x2, int y2, vtkUnsignedCharArray* data, int front, int right) override;
273 int x1, int y1, int x2, int y2, unsigned char* data, int front, int blend, int right) override;
274 int SetRGBACharPixelData(int x, int y, int x2, int y2, vtkUnsignedCharArray* data, int front,
275 int blend = 0, int right = 0) override;
276
282
283private:
285 void operator=(const vtkGenericOpenGLRenderWindow&) = delete;
286};
287
288VTK_ABI_NAMESPACE_END
289#endif
void * GetGenericWindowId() override
These are window system independent methods that are used to help interface vtkWindow to native windo...
void Finalize() override
Cleans up graphics resources allocated in the context for this VTK scene.
void CreateAWindow() override
Create a not-off-screen window.
int SetRGBACharPixelData(int x1, int y1, int x2, int y2, unsigned char *data, int front, int blend, int right) override
Set this to true to indicate that the context is now ready.
void WindowRemap() override
Remap the rendering window.
void SetWindowId(void *) override
does nothing
int SetPixelData(int x1, int y1, int x2, int y2, unsigned char *data, int front, int right) override
Set this to true to indicate that the context is now ready.
float GetMaximumHardwareLineWidth() override
Overridden to pass explicitly specified MaximumHardwareLineWidth, if any.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
bool ReadyForRendering
Set this to true to indicate that the context is now ready.
void SetIsDirect(vtkTypeBool newValue)
Allow to update state within observer callback without changing data argument and MTime.
static vtkGenericOpenGLRenderWindow * New()
~vtkGenericOpenGLRenderWindow() override
vtkTypeBool IsDirect() override
Returns if the context is direct.
void SetParentInfo(const char *) override
These are window system independent methods that are used to help interface vtkWindow to native windo...
void SetDisplayId(void *) override
These are window system independent methods that are used to help interface vtkWindow to native windo...
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 di...
void SetSupportsOpenGL(int newValue)
Allow to update state within observer callback without changing data argument and MTime.
void Frame() override
flush the pending drawing operations Class user may to watch for WindowFrameEvent and act on it
void SetParentId(void *) override
These are window system independent methods that are used to help interface vtkWindow to native windo...
int DirectStatus
Set this to true to indicate that the context is now ready.
void SetWindowInfo(const char *) override
These are window system independent methods that are used to help interface vtkWindow to native windo...
void SetBackRightBuffer(unsigned int)
void MakeCurrent() override
Makes the context current.
float ForceMaximumHardwareLineWidth
Set this to true to indicate that the context is now ready.
void SetNextWindowInfo(const char *) override
Dummy stubs for vtkWindow API.
int SupportsOpenGL() override
Returns if OpenGL is supported.
void PopState()
no-op (for API compat with OpenGL1).
bool CurrentStatus
Set this to true to indicate that the context is now ready.
void SetFrontRightBuffer(unsigned int)
void * GetGenericContext() override
These are window system independent methods that are used to help interface vtkWindow to native windo...
void SetIsCurrent(bool newValue)
Allow to update state within observer callback without changing data argument and MTime.
void OpenGLInit() override
Initialize OpenGL for this window.
vtkTypeBool GetEventPending() override
Check to see if a mouse button has been pressed.
void Render() override
Override the Render method to do some state management.
void SetNextWindowId(void *) override
Dummy stubs for vtkWindow API.
void * GetGenericParentId() override
These are window system independent methods that are used to help interface vtkWindow to native windo...
int * GetScreenSize() override
Get the current size of the screen in pixels.
void SetOwnContext(vtkTypeBool)
int ReadPixels(const vtkRecti &rect, int front, int glFormat, int glType, void *data, int right) override
Overridden to not attempt to read pixels if this->ReadyForRendering is false.
void DestroyWindow() override
Destroy a not-off-screen window.
void * GetGenericDisplayId() override
These are window system independent methods that are used to help interface vtkWindow to native windo...
void SetFrontLeftBuffer(unsigned int)
set the drawing buffers to use
int SupportsOpenGLStatus
Set this to true to indicate that the context is now ready.
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 di...
void SetBackLeftBuffer(unsigned int)
void PushState()
no-op (for API compat with OpenGL1).
bool IsCurrent() override
Returns if the context is current.
void SetCurrentCursor(int cShape) override
Overridden to invoke vtkCommand::CursorChangedEvent.
void * GetGenericDrawable() override
These are window system independent methods that are used to help interface vtkWindow to native windo...
void SetFullScreen(vtkTypeBool) override
Turn on/off rendering full screen window size.
a simple class to control print indentation
Definition vtkIndent.h:108
dynamic, self-adjusting array of unsigned char
vtkTypeBool Mapped
Definition vtkWindow.h:290
int vtkTypeBool
Definition vtkABI.h:64
#define VTK_FLOAT_MAX
Definition vtkType.h:204
#define VTK_SIZEHINT(...)