VTK  9.3.0
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
16#ifndef vtkOpenGLRenderWindow_h
17#define vtkOpenGLRenderWindow_h
18
19#include "vtkRect.h" // for vtkRecti
20#include "vtkRenderWindow.h"
21#include "vtkRenderingOpenGL2Module.h" // For export macro
22#include "vtkType.h" // for ivar
23#include <map> // for ivar
24#include <set> // for ivar
25#include <string> // for ivar
26
27VTK_ABI_NAMESPACE_BEGIN
28class vtkIdList;
31class vtkOpenGLHardwareSupport;
37class vtkTexture;
41class vtkOpenGLState;
42
43class VTKRENDERINGOPENGL2_EXPORT vtkOpenGLRenderWindow : public vtkRenderWindow
44{
45public:
47 void PrintSelf(ostream& os, vtkIndent indent) override;
48
52 void Start() override;
53
58 void Frame() override;
59
63 const char* GetRenderingBackend() override;
64
66
72
74
79 unsigned char* GetPixelData(int x, int y, int x2, int y2, int front, int right) override;
81 int x, int y, int x2, int y2, int front, vtkUnsignedCharArray* data, int right) override;
83 int x, int y, int x2, int y2, unsigned char* data, int front, int right) override;
85 int x, int y, int x2, int y2, vtkUnsignedCharArray* data, int front, int right) override;
87
89
92 float* GetRGBAPixelData(int x, int y, int x2, int y2, int front, int right = 0) override;
94 int x, int y, int x2, int y2, int front, vtkFloatArray* data, int right = 0) override;
96 int x, int y, int x2, int y2, float* data, int front, int blend = 0, int right = 0) override;
97 int SetRGBAPixelData(int x, int y, int x2, int y2, vtkFloatArray* data, int front, int blend = 0,
98 int right = 0) override;
99 void ReleaseRGBAPixelData(float* data) override;
100 unsigned char* GetRGBACharPixelData(
101 int x, int y, int x2, int y2, int front, int right = 0) override;
103 int x, int y, int x2, int y2, int front, vtkUnsignedCharArray* data, int right = 0) override;
104 int SetRGBACharPixelData(int x, int y, int x2, int y2, unsigned char* data, int front,
105 int blend = 0, int right = 0) override;
106 int SetRGBACharPixelData(int x, int y, int x2, int y2, vtkUnsignedCharArray* data, int front,
107 int blend = 0, int right = 0) override;
109
111
114 float* GetZbufferData(int x1, int y1, int x2, int y2) override;
115 int GetZbufferData(int x1, int y1, int x2, int y2, float* z) override;
116 int GetZbufferData(int x1, int y1, int x2, int y2, vtkFloatArray* buffer) override;
117 int SetZbufferData(int x1, int y1, int x2, int y2, float* buffer) override;
118 int SetZbufferData(int x1, int y1, int x2, int y2, vtkFloatArray* buffer) override;
120
125
130
135
139 int GetDepthBufferSize() override;
140
145
150 int GetColorBufferSizes(int* rgba) override;
151
157 int GetColorBufferInternalFormat(int attachmentPoint);
158
162 virtual void OpenGLInit();
163
164 // Initialize the state of OpenGL that VTK wants for this window
165 virtual void OpenGLInitState();
166
167 // Initialize VTK for rendering in a new OpenGL context
168 virtual void OpenGLInitContext();
169
175 void GetOpenGLVersion(int& major, int& minor);
176
181
186
191
193
196 vtkGetObjectMacro(RenderFramebuffer, vtkOpenGLFramebufferObject);
198
202 vtkGetObjectMacro(DisplayFramebuffer, vtkOpenGLFramebufferObject);
203
209
214 void WaitForCompletion() override;
215
219 virtual void DrawPixels(
220 int x1, int y1, int x2, int y2, int numComponents, int dataType, void* data);
221
226 virtual void DrawPixels(int dstXmin, int dstYmin, int dstXmax, int dstYmax, int srcXmin,
227 int srcYmin, int srcXmax, int srcYmax, int srcWidth, int srcHeight, int numComponents,
228 int dataType, void* data);
229
234 virtual void DrawPixels(int srcWidth, int srcHeight, int numComponents, int dataType, void* data);
235
239 virtual float GetMaximumHardwareLineWidth() { return this->MaximumHardwareLineWidth; }
240
247 virtual bool IsPointSpriteBugPresent() { return false; }
248
255 int vtktype, int numComponents, bool needInteger, bool needFloat, bool needSRGB);
256
262 std::string GetOpenGLSupportMessage() { return this->OpenGLSupportMessage; }
263
267 int SupportsOpenGL() override;
268
272 const char* ReportCapabilities() override;
273
280 virtual void Initialize() {}
281
282 std::set<vtkGenericOpenGLResourceFreeCallback*> Resources;
283
285 {
286 std::set<vtkGenericOpenGLResourceFreeCallback*>::iterator it = this->Resources.find(cb);
287 if (it == this->Resources.end())
288 {
289 this->Resources.insert(cb);
290 }
291 }
292
294 {
295 std::set<vtkGenericOpenGLResourceFreeCallback*>::iterator it = this->Resources.find(cb);
296 if (it != this->Resources.end())
297 {
298 this->Resources.erase(it);
299 }
300 }
301
311 virtual void PushContext() { this->MakeCurrent(); }
312 virtual void PopContext() {}
313
319
329 virtual bool SetSwapControl(int) { return false; }
330
331 // Get the state object used to keep track of
332 // OpenGL state
333 virtual vtkOpenGLState* GetState() { return this->State; }
334
335 // Get a VBO that can be shared by many
336 // It consists of normalized display
337 // coordinates for a quad and tcoords
339
340 // Activate and return thje texture unit for a generic 2d 64x64
341 // float greyscale noise texture ranging from 0 to 1. The texture is
342 // a hard-coded blue noise texture. This texture unit will automatically
343 // be deactivated at the end of the render process.
345
349 void End() override;
350
354 void Render() override;
355
360 void StereoMidpoint() override;
361
362 // does VTKs framebuffer require resolving for reading pixels
364
370
375
379 void BlitDisplayFramebuffer(int right, int srcX, int srcY, int srcWidth, int srcHeight, int destX,
380 int destY, int destWidth, int destHeight, int bufferMode, int interpolation);
381
383
387 void BlitToRenderFramebuffer(bool includeDepth);
388 void BlitToRenderFramebuffer(int srcX, int srcY, int srcWidth, int srcHeight, int destX,
389 int destY, int destWidth, int destHeight, int bufferMode, int interpolation);
391
397 {
398 BlitToHardware, // hardware buffers
399 BlitToCurrent, // currently bound draw framebuffer
400 NoBlit // no blit, GUI or external code will handle the blit
401 };
402
404
427 vtkSetClampMacro(FrameBlitMode, FrameBlitModes, BlitToHardware, NoBlit);
428 vtkGetMacro(FrameBlitMode, FrameBlitModes);
429 void SetFrameBlitModeToBlitToHardware() { this->SetFrameBlitMode(BlitToHardware); }
430 void SetFrameBlitModeToBlitToCurrent() { this->SetFrameBlitMode(BlitToCurrent); }
431 void SetFrameBlitModeToNoBlit() { this->SetFrameBlitMode(NoBlit); }
433
435
438 vtkSetMacro(FramebufferFlipY, bool);
439 vtkGetMacro(FramebufferFlipY, bool);
440 vtkBooleanMacro(FramebufferFlipY, bool);
442
444 // copy depth values from a source framebuffer to a destination framebuffer
445 // using texture maps to do the copy. The source framebufferobject must be texture
446 // backed. This method is designed to work around issues with trying to blit depth
447 // values between framebuffers that have different depth formats.
448
449 // blit entire source texture to active viewport
451
452 // blit specified source texels to active viewport
453 virtual void TextureDepthBlit(vtkTextureObject* source, int srcX, int srcY, int srcX2, int srcY2);
454
455 // blit specified source texels to specified viewport
456 virtual void TextureDepthBlit(vtkTextureObject* source, int srcX, int srcY, int srcX2, int srcY2,
457 int destX, int destY, int destX2, int destY2);
459
460protected:
463
464 // blits the display buffers to the appropriate hardware buffers
466
467 // when frame is called, at the end blit to the hardware buffers
469
470 // a FSQ we use to resolve MSAA that handles gamma
472
473 // a FSQ we use to blit depth values
475
476 // a FSQ we use to flip framebuffer texture
478
479 // a FSQ we use to read depth component on platforms with OpenGL ES implementations
480 // because `glReadPixels` cannot be used to read GL_DEPTH_COMPONENT
482
483 // flip quad helpers Y tcoord
485
486 // resolve and flip renderframebuffer as needed
487 // when copying to displayframebuffer. Returns
488 // true if the color buffer was copied.
490
491 // On GLES, the depth attachment buffer cannot be downloaded from
492 // the GPU with `glReadPixels`.
493 // This method reads the depth buffer bits.
494 // The depth attachment size can be 8,16,24 or 32. The values are split into 4 8-bit numbers.
495 // These are stored in the form of an RGBA color attachment in DepthFrameBuffer.
496 // `glReadPixels` can read that RGBA format and reconstruct full 8,16,24 or 32-bit integer
497 // followed by scaling down to 0-1.
498 bool ReadDepthComponent(int depthSize);
499
500 // used in testing for opengl support
501 // in the SupportsOpenGL() method
505
506 virtual int ReadPixels(
507 const vtkRecti& rect, int front, int glFormat, int glType, void* data, int right = 0);
508
517 int CreateFramebuffers(int width, int height);
520
521 // used when we need to resolve a multisampled
522 // framebuffer
524
525 // used when we need to read depth component
526 // with OpenGL ES 3
528
532 virtual void CreateAWindow() = 0;
533
537 virtual void DestroyWindow() = 0;
538
543
548
549 std::map<std::string, int> GLStateIntegers;
550
555
557
559
560 bool Initialized; // ensure glewinit has been called
561 bool GlewInitValid; // Did glewInit initialize with a valid state?
562
564
566
567 // used for fast quad rendering
569
570 // noise texture
572
574
575 // keep track of in case we need to recreate the framebuffer
577
578 int ScreenSize[2];
579
580private:
582 void operator=(const vtkOpenGLRenderWindow&) = delete;
583
584 // Keeping `State` private so the only way to access it is through
585 // `this->GetState()`.
586 vtkOpenGLState* State;
587};
588
589VTK_ABI_NAMESPACE_END
590#endif
dynamic, self-adjusting array of float
list of point or cell ids
Definition vtkIdList.h:23
a simple class to control print indentation
Definition vtkIndent.h:29
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.
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 GetTextureUnitForTexture(vtkTextureObject *)
Get the texture unit for a given texture object.
virtual void Initialize()
Initialize the rendering window.
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...
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
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 framebuffer Return if the creation was successful or not.
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.
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...
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:58
record modification and/or execution time
dynamic, self-adjusting array of unsigned char
window superclass for vtkRenderWindow
Definition vtkWindow.h:25
virtual void MakeCurrent()
Make the window current.
Definition vtkWindow.h:232
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