VTK  9.4.20250219
vtkOpenGLRenderWindow.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
35#ifndef vtkOpenGLRenderWindow_h
36#define vtkOpenGLRenderWindow_h
37
38#include "vtkRect.h" // for vtkRecti
39#include "vtkRenderWindow.h"
40#include "vtkRenderingOpenGL2Module.h" // For export macro
41#include "vtkType.h" // for ivar
42#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
43#include <map> // for ivar
44#include <set> // for ivar
45#include <string> // for ivar
46
47VTK_ABI_NAMESPACE_BEGIN
48class vtkIdList;
51class vtkOpenGLHardwareSupport;
57class vtkTexture;
61class vtkOpenGLState;
62
63class VTKRENDERINGOPENGL2_EXPORT VTK_MARSHALAUTO vtkOpenGLRenderWindow : public vtkRenderWindow
64{
65public:
67 void PrintSelf(ostream& os, vtkIndent indent) override;
68#if !(defined(__APPLE__) || defined(__ANDROID__) || defined(__EMSCRIPTEN__))
70#endif
71
75 void Start() override;
76
81 void Frame() override;
82
86 const char* GetRenderingBackend() override;
87
89
95
97
102 unsigned char* GetPixelData(int x, int y, int x2, int y2, int front, int right) override;
104 int x, int y, int x2, int y2, int front, vtkUnsignedCharArray* data, int right) override;
106 int x, int y, int x2, int y2, unsigned char* data, int front, int right) override;
108 int x, int y, int x2, int y2, vtkUnsignedCharArray* data, int front, int right) override;
110
112
115 float* GetRGBAPixelData(int x, int y, int x2, int y2, int front, int right = 0) override;
117 int x, int y, int x2, int y2, int front, vtkFloatArray* data, int right = 0) override;
119 int x, int y, int x2, int y2, float* data, int front, int blend = 0, int right = 0) override;
120 int SetRGBAPixelData(int x, int y, int x2, int y2, vtkFloatArray* data, int front, int blend = 0,
121 int right = 0) override;
122 void ReleaseRGBAPixelData(float* data) override;
123 unsigned char* GetRGBACharPixelData(
124 int x, int y, int x2, int y2, int front, int right = 0) override;
126 int x, int y, int x2, int y2, int front, vtkUnsignedCharArray* data, int right = 0) override;
127 int SetRGBACharPixelData(int x, int y, int x2, int y2, unsigned char* data, int front,
128 int blend = 0, int right = 0) override;
129 int SetRGBACharPixelData(int x, int y, int x2, int y2, vtkUnsignedCharArray* data, int front,
130 int blend = 0, int right = 0) override;
132
134
137 float* GetZbufferData(int x1, int y1, int x2, int y2) override;
138 int GetZbufferData(int x1, int y1, int x2, int y2, float* z) override;
139 int GetZbufferData(int x1, int y1, int x2, int y2, vtkFloatArray* buffer) override;
140 int SetZbufferData(int x1, int y1, int x2, int y2, float* buffer) override;
141 int SetZbufferData(int x1, int y1, int x2, int y2, vtkFloatArray* buffer) override;
143
148
153
158
162 int GetDepthBufferSize() override;
163
168
173 int GetColorBufferSizes(int* rgba) override;
174
180 int GetColorBufferInternalFormat(int attachmentPoint);
181
185 virtual void OpenGLInit();
186
187 // Initialize the state of OpenGL that VTK wants for this window
188 virtual void OpenGLInitState();
189
190 // Initialize VTK for rendering in a new OpenGL context
191 virtual void OpenGLInitContext();
192
198 void GetOpenGLVersion(int& major, int& minor);
199
204
209
214
216
219 vtkGetObjectMacro(RenderFramebuffer, vtkOpenGLFramebufferObject);
221
225 vtkGetObjectMacro(DisplayFramebuffer, vtkOpenGLFramebufferObject);
226
232
237 void WaitForCompletion() override;
238
242 virtual void DrawPixels(
243 int x1, int y1, int x2, int y2, int numComponents, int dataType, void* data);
244
249 virtual void DrawPixels(int dstXmin, int dstYmin, int dstXmax, int dstYmax, int srcXmin,
250 int srcYmin, int srcXmax, int srcYmax, int srcWidth, int srcHeight, int numComponents,
251 int dataType, void* data);
252
257 virtual void DrawPixels(int srcWidth, int srcHeight, int numComponents, int dataType, void* data);
258
262 virtual float GetMaximumHardwareLineWidth() { return this->MaximumHardwareLineWidth; }
263
270 virtual bool IsPointSpriteBugPresent() { return false; }
271
282
289 int vtktype, int numComponents, bool needInteger, bool needFloat, bool needSRGB);
290
296 std::string GetOpenGLSupportMessage() { return this->OpenGLSupportMessage; }
297
301 int SupportsOpenGL() override;
302
306 const char* ReportCapabilities() override;
307
314 void Initialize() override {}
315
316 std::set<vtkGenericOpenGLResourceFreeCallback*> Resources;
317
319 {
320 std::set<vtkGenericOpenGLResourceFreeCallback*>::iterator it = this->Resources.find(cb);
321 if (it == this->Resources.end())
322 {
323 this->Resources.insert(cb);
324 }
325 }
326
328 {
329 std::set<vtkGenericOpenGLResourceFreeCallback*>::iterator it = this->Resources.find(cb);
330 if (it != this->Resources.end())
331 {
332 this->Resources.erase(it);
333 }
334 }
335
345 virtual void PushContext() { this->MakeCurrent(); }
346 virtual void PopContext() {}
347
353
363 virtual bool SetSwapControl(int) { return false; }
364
365 // Get the state object used to keep track of
366 // OpenGL state
367 virtual vtkOpenGLState* GetState() { return this->State; }
368
369 // Get a VBO that can be shared by many
370 // It consists of normalized display
371 // coordinates for a quad and tcoords
373
374 // Activate and return thje texture unit for a generic 2d 64x64
375 // float greyscale noise texture ranging from 0 to 1. The texture is
376 // a hard-coded blue noise texture. This texture unit will automatically
377 // be deactivated at the end of the render process.
379
383 void End() override;
384
388 void Render() override;
389
394 void StereoMidpoint() override;
395
396 // does VTKs framebuffer require resolving for reading pixels
398
404
410
416
420 void BlitDisplayFramebuffer(int right, int srcX, int srcY, int srcWidth, int srcHeight, int destX,
421 int destY, int destWidth, int destHeight, int bufferMode, int interpolation);
422
424
428 void BlitToRenderFramebuffer(bool includeDepth);
429 void BlitToRenderFramebuffer(int srcX, int srcY, int srcWidth, int srcHeight, int destX,
430 int destY, int destWidth, int destHeight, int bufferMode, int interpolation);
432
438 {
439 BlitToHardware, // hardware buffers
440 BlitToCurrent, // currently bound draw framebuffer, without depth buffer
441 BlitToCurrentWithDepth, // currently bound draw framebuffer, including depth buffer
442 NoBlit // no blit, GUI or external code will handle the blit
443 };
444
446
471 vtkSetClampMacro(FrameBlitMode, FrameBlitModes, BlitToHardware, NoBlit);
472 vtkGetMacro(FrameBlitMode, FrameBlitModes);
473 void SetFrameBlitModeToBlitToHardware() { this->SetFrameBlitMode(BlitToHardware); }
474 void SetFrameBlitModeToBlitToCurrent() { this->SetFrameBlitMode(BlitToCurrent); }
476 {
477 this->SetFrameBlitMode(BlitToCurrentWithDepth);
478 }
479 void SetFrameBlitModeToNoBlit() { this->SetFrameBlitMode(NoBlit); }
481
483
486 vtkSetMacro(FramebufferFlipY, bool);
487 vtkGetMacro(FramebufferFlipY, bool);
488 vtkBooleanMacro(FramebufferFlipY, bool);
490
492
495 vtkSetMacro(RenderBufferTargetDepthSize, int);
496 vtkGetMacro(RenderBufferTargetDepthSize, int);
498
500 // copy depth values from a source framebuffer to a destination framebuffer
501 // using texture maps to do the copy. The source framebufferobject must be texture
502 // backed. This method is designed to work around issues with trying to blit depth
503 // values between framebuffers that have different depth formats.
504
505 // blit entire source texture to active viewport
507
508 // blit specified source texels to active viewport
509 virtual void TextureDepthBlit(vtkTextureObject* source, int srcX, int srcY, int srcX2, int srcY2);
510
511 // blit specified source texels to specified viewport
512 virtual void TextureDepthBlit(vtkTextureObject* source, int srcX, int srcY, int srcX2, int srcY2,
513 int destX, int destY, int destX2, int destY2);
515
516 typedef void (*VTKOpenGLAPIProc)();
517 typedef VTKOpenGLAPIProc (*VTKOpenGLLoaderFunction)(void* userptr, const char* name);
528 void SetOpenGLSymbolLoader(VTKOpenGLLoaderFunction loader, void* userData);
529
530protected:
533
534 // blits the display buffers to the appropriate hardware buffers
536
537 // when frame is called, at the end blit to the hardware buffers
539
540 // a FSQ we use to resolve MSAA that handles gamma
542
543 // a FSQ we use to blit depth values
545
546 // a FSQ we use to flip framebuffer texture
548
549 // a FSQ we use to read depth component on platforms with OpenGL ES implementations
550 // because `glReadPixels` cannot be used to read GL_DEPTH_COMPONENT
552
553 // flip quad helpers Y tcoord
555
556 // resolve and flip renderframebuffer as needed
557 // when copying to displayframebuffer. Returns
558 // true if the color buffer was copied.
560
561 // On GLES, the depth attachment buffer cannot be downloaded from
562 // the GPU with `glReadPixels`.
563 // This method reads the depth buffer bits.
564 // The depth attachment size can be 8,16,24 or 32. The values are split into 4 8-bit numbers.
565 // These are stored in the form of an RGBA color attachment in DepthFrameBuffer.
566 // `glReadPixels` can read that RGBA format and reconstruct full 8,16,24 or 32-bit integer
567 // followed by scaling down to 0-1.
568 bool ReadDepthComponent(int depthSize);
569
570 // used in testing for opengl support
571 // in the SupportsOpenGL() method
575
576 virtual int ReadPixels(
577 const vtkRecti& rect, int front, int glFormat, int glType, void* data, int right = 0);
578
587 int CreateFramebuffers(int width, int height);
590
591 // used when we need to resolve a multisampled
592 // framebuffer
594
595 // used when we need to read depth component
596 // with OpenGL ES 3
598
602 virtual void CreateAWindow() = 0;
603
607 virtual void DestroyWindow() = 0;
608
613
618
619 std::map<std::string, int> GLStateIntegers;
620
625
627
629
631
633
634 // used for fast quad rendering
636
637 // noise texture
639
641
642 // keep track of in case we need to recreate the framebuffer
644
645 // how much bits to use for depth of created Framebuffers
647
648 int ScreenSize[2];
649
650 struct
651 {
652 VTKOpenGLLoaderFunction LoadFunction = nullptr;
653 void* UserData = nullptr;
654 } SymbolLoader;
655
656private:
658 void operator=(const vtkOpenGLRenderWindow&) = delete;
659
660 // Keeping `State` private so the only way to access it is through
661 // `this->GetState()`.
662 vtkOpenGLState* State;
663};
664
665VTK_ABI_NAMESPACE_END
666#endif
dynamic, self-adjusting array of float
list of point or cell ids
Definition vtkIdList.h:133
a simple class to control print indentation
Definition vtkIndent.h:108
OpenGL buffer object.
Internal class which encapsulates OpenGL FramebufferObject.
Class to make rendering a full screen quad easier.
OpenGL rendering window.
void Start() override
Begin the rendering process.
void ReleaseGraphicsResources(vtkWindow *) override
Free up any graphics resources associated with this window a value of NULL means the context may alre...
int GetColorBufferInternalFormat(int attachmentPoint)
Get the internal format of current attached texture or render buffer.
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...
virtual void DrawPixels(int dstXmin, int dstYmin, int dstXmax, int dstYmax, int srcXmin, int srcYmin, int srcXmax, int srcYmax, int srcWidth, int srcHeight, int numComponents, int dataType, void *data)
Replacement for the old glDrawPixels function, but it allows for scaling the data and using only part...
vtkOpenGLFramebufferObject * DisplayFramebuffer
std::map< std::string, int > GLStateIntegers
std::string GetOpenGLSupportMessage()
Return a message profiding additional details about the results of calling SupportsOpenGL() This can ...
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...
vtkTextureUnitManager * GetTextureUnitManager()
Returns its texture unit manager object.
bool ReadDepthComponent(int depthSize)
vtkOpenGLQuadHelper * DepthReadQuad
virtual void DrawPixels(int x1, int y1, int x2, int y2, int numComponents, int dataType, void *data)
Replacement for the old glDrawPixels function.
void Initialize() override
Initialize the rendering window.
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...
void SetOpenGLSymbolLoader(VTKOpenGLLoaderFunction loader, void *userData)
Provide a function pointer which can load OpenGL core/extension functions.
int GetTextureUnitForTexture(vtkTextureObject *)
Get the texture unit for a given texture object.
const char * GetRenderingBackend() override
What rendering backend has the user requested.
void RegisterGraphicsResources(vtkGenericOpenGLResourceFreeCallback *cb)
virtual void DestroyWindow()=0
Destroy a not-off-screen window.
FrameBlitModes
Define how the resulting image should be blitted when at the end of the Frame() call if SwapBuffers i...
float * GetZbufferData(int x1, int y1, int x2, int y2) override
Set/Get the zbuffer data from an image.
virtual void TextureDepthBlit(vtkTextureObject *source)
vtkTypeBool OwnContext
Flag telling if the context has been created here or was inherited.
int GetZbufferData(int x1, int y1, int x2, int y2, float *z) override
Set/Get the zbuffer data from an image.
virtual void TextureDepthBlit(vtkTextureObject *source, int srcX, int srcY, int srcX2, int srcY2, int destX, int destY, int destX2, int destY2)
void StereoMidpoint() override
Intermediate method performs operations required between the rendering of the left and right eye.
vtkTextureObject * NoiseTextureObject
vtkOpenGLFramebufferObject * ResolveFramebuffer
int GetZbufferData(int x1, int y1, int x2, int y2, vtkFloatArray *buffer) override
Set/Get the zbuffer data from an image.
void End() override
Update the system, if needed, at end of render process.
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...
void BlitToRenderFramebuffer(bool includeDepth)
Blit the currently bound read buffer to the renderbuffer.
static void SetGlobalMaximumNumberOfMultiSamples(int val)
Set/Get the maximum number of multisamples.
virtual float GetMaximumHardwareLineWidth()
Return the largest line width supported by the hardware.
int GetDefaultTextureInternalFormat(int vtktype, int numComponents, bool needInteger, bool needFloat, bool needSRGB)
Get a mapping of vtk data types to native texture formats for this window we put this on the RenderWi...
void ActivateTexture(vtkTextureObject *)
Activate a texture unit for this texture.
vtkTextureObject * DrawPixelsTextureObject
vtkOpenGLFramebufferObject * DepthFramebuffer
bool GetUsingSRGBColorSpace()
Is this window/fo in sRGB colorspace.
int GetColorBufferSizes(int *rgba) override
Get the size of the color 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...
static vtkOpenGLRenderWindow * New()
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...
vtkOpenGLBufferObject * GetTQuad2DVBO()
void Render() override
Handle opengl specific code and calls superclass.
void UnregisterGraphicsResources(vtkGenericOpenGLResourceFreeCallback *cb)
void BlitDisplayFramebuffer(int right, int srcX, int srcY, int srcWidth, int srcHeight, int destX, int destY, int destWidth, int destHeight, int bufferMode, int interpolation)
Blit a display buffer into a currently bound draw destination.
void Frame() override
A termination method performed at the end of the rendering process to do things like swapping buffers...
virtual bool IsPointSpriteBugPresent()
Returns true if driver has an EGL/OpenGL bug that makes vtkChartsCoreCxx-TestChartDoubleColors and ot...
void ReleaseRGBAPixelData(float *data) override
Set/Get the pixel data of an image, transmitted as RGBARGBA...
std::set< vtkGenericOpenGLResourceFreeCallback * > Resources
virtual void OpenGLInitContext()
vtkOpenGLQuadHelper * DepthBlitQuad
virtual void TextureDepthBlit(vtkTextureObject *source, int srcX, int srcY, int srcX2, int srcY2)
void WaitForCompletion() override
Block the thread until the actual rendering is finished().
virtual bool ResolveFlipRenderFramebuffer()
virtual void PushContext()
Ability to push and pop this window's context as the current context.
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...
vtkOpenGLQuadHelper * FlipQuad
virtual void OpenGLInitState()
vtkOpenGLFramebufferObject * RenderFramebuffer
static int GetGlobalMaximumNumberOfMultiSamples()
Set/Get the maximum number of multisamples.
virtual vtkOpenGLState * GetState()
virtual void CreateAWindow()=0
Create a not-off-screen window.
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...
void BlitToRenderFramebuffer(int srcX, int srcY, int srcWidth, int srcHeight, int destX, int destY, int destWidth, int destHeight, int bufferMode, int interpolation)
Blit the currently bound read buffer to the renderbuffer.
virtual int ReadPixels(const vtkRecti &rect, int front, int glFormat, int glType, void *data, int right=0)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int SupportsOpenGL() override
Does this render window support OpenGL? 0-false, 1-true.
int SetZbufferData(int x1, int y1, int x2, int y2, vtkFloatArray *buffer) override
Set/Get the zbuffer data from an image.
virtual vtkMTimeType GetContextCreationTime()
Get the time when the OpenGL context was created.
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...
int GetDepthBufferSize() override
Get the size of the depth buffer.
void SetFrameBlitModeToBlitToCurrent()
SetGet how to handle blits at the end of a Frame() call.
bool InitializeFromCurrentContext() override
Initialize the render window from the information associated with the currently activated OpenGL cont...
virtual bool SetSwapControl(int)
Set the number of vertical syncs required between frames.
vtkOpenGLBufferObject * TQuad2DVBO
~vtkOpenGLRenderWindow() override
void BlitDisplayFramebufferColorAndDepth()
Blit a display framebuffer into a currently bound draw destination, color and depth.
const char * ReportCapabilities() override
Get report of capabilities for the render window.
void SetFrameBlitModeToNoBlit()
SetGet how to handle blits at the end of a Frame() call.
vtkOpenGLShaderCache * GetShaderCache()
Returns an Shader Cache object.
vtkOpenGLVertexBufferObjectCache * GetVBOCache()
Returns the VBO Cache.
int CreateFramebuffers(int width, int height)
Create the offScreen framebuffers or resize them if they are already created.
bool IsPrimIDBugPresent()
On gl_PrimitiveID, the spec says it is a counter that is incremented after every individual point,...
virtual void OpenGLInit()
Initialize OpenGL for this window.
int SetZbufferData(int x1, int y1, int x2, int y2, float *buffer) override
Set/Get the zbuffer data from an image.
void BlitDisplayFramebuffer()
Blit a display framebuffer into a currently bound draw destination, color only.
virtual void BlitDisplayFramebuffersToHardware()
void DeactivateTexture(vtkTextureObject *)
Deactivate a previously activated texture.
void RestoreGLState()
Restore OpenGL state at end of the rendering.
void GetOpenGLVersion(int &major, int &minor)
Get the major and minor version numbers of the OpenGL context we are using ala 3.2,...
void SaveGLState()
Query and save OpenGL state.
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 SetFrameBlitModeToBlitToCurrentWithDepth()
SetGet how to handle blits at the end of a Frame() call.
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...
void SetFrameBlitModeToBlitToHardware()
SetGet how to handle blits at the end of a Frame() call.
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...
virtual void DrawPixels(int srcWidth, int srcHeight, int numComponents, int dataType, void *data)
Replacement for the old glDrawPixels function.
vtkOpenGLQuadHelper * ResolveQuad
manage Shader Programs within a context
OpenGL state storage.
The VertexArrayObject class uses, or emulates, vertex array objects.
manage vertex buffer objects shared within a context
create a window for renderers to draw into
The ShaderProgram uses one or more Shader objects.
abstracts an OpenGL texture object.
allocate/free texture units.
handles properties associated with a texture map
Definition vtkTexture.h:168
record modification and/or execution time
dynamic, self-adjusting array of unsigned char
window superclass for vtkRenderWindow
Definition vtkWindow.h:48
virtual void MakeCurrent()
Make the window current.
Definition vtkWindow.h:263
int vtkTypeBool
Definition vtkABI.h:64
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:270
#define VTK_MARSHALAUTO