0024023: Revamp the OCCT Handle -- automatic
[occt.git] / src / OpenGl / OpenGl_FrameBuffer.hxx
1 // Created by: Kirill GAVRILOV
2 // Copyright (c) 2011-2014 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef OPENGL_FRAME_BUFFER_H
16 #define OPENGL_FRAME_BUFFER_H
17
18 #include <OpenGl_Context.hxx>
19 #include <OpenGl_Resource.hxx>
20 #include <OpenGl_Texture.hxx>
21
22 #include <Standard_Boolean.hxx>
23 #include <InterfaceGraphic.hxx>
24
25
26 //! Class implements FrameBuffer Object (FBO) resource
27 //! intended for off-screen rendering.
28 class OpenGl_FrameBuffer : public OpenGl_Resource
29 {
30
31 public:
32
33   //! Helpful constants
34   static const GLuint NO_FRAMEBUFFER  = 0;
35   static const GLuint NO_RENDERBUFFER = 0;
36
37 public:
38
39   //! Empty constructor
40   Standard_EXPORT OpenGl_FrameBuffer (GLint theTextureFormat = GL_RGBA8);
41
42   //! Destructor
43   Standard_EXPORT virtual ~OpenGl_FrameBuffer();
44
45   //! Destroy object - will release GPU memory if any.
46   Standard_EXPORT virtual void Release (OpenGl_Context* theGlCtx);
47
48   //! Textures width.
49   GLsizei GetSizeX() const
50   {
51     return myColorTexture->SizeX();
52   }
53
54   //! Textures height.
55   GLsizei GetSizeY() const
56   {
57     return myColorTexture->SizeY();
58   }
59
60   //! Viewport width.
61   GLsizei GetVPSizeX() const
62   {
63     return myVPSizeX;
64   }
65
66   //! Viewport height.
67   GLsizei GetVPSizeY() const
68   {
69     return myVPSizeY;
70   }
71
72   //! Returns true if current object was initialized
73   Standard_Boolean IsValid() const
74   {
75     return isValidFrameBuffer();
76   }
77
78   //! Notice! Obsolete hardware (GeForce FX etc)
79   //! doesn't support rectangular textures!
80   //! There are 3 possible results if you are trying
81   //! to create non power-of-two FBO on these cards:
82   //! 1) FBO creation will fail,
83   //!    current implementation will try to generate compatible FBO;
84   //! 2) FBO rendering will be done in software mode (ForceWare 'hack');
85   //! 3) FBO rendering will be incorrect (some obsolete Catalyst drivers).
86   Standard_EXPORT Standard_Boolean Init (const Handle(OpenGl_Context)& theGlCtx,
87                                          const GLsizei                 theViewportSizeX,
88                                          const GLsizei                 theViewportSizeY);
89
90   //! (Re-)initialize FBO with specified dimensions.
91   Standard_EXPORT Standard_Boolean InitLazy (const Handle(OpenGl_Context)& theGlCtx,
92                                              const GLsizei                 theViewportSizeX,
93                                              const GLsizei                 theViewportSizeY);
94
95   //! (Re-)initialize FBO with specified dimensions.
96   //! The Render Buffer Objects will be used for Color, Depth and Stencil attachments (as opposite to textures).
97   //! @param theGlCtx         currently bound OpenGL context
98   //! @param theViewportSizeX required viewport size, the actual dimensions of FBO might be greater
99   //! @param theViewportSizeY required viewport size, the actual dimensions of FBO might be greater
100   //! @param theColorRBufferFromWindow when specified - should be ID of already initialized RB object, which will be released within this class
101   Standard_EXPORT Standard_Boolean InitWithRB (const Handle(OpenGl_Context)& theGlCtx,
102                                                const GLsizei                 theViewportSizeX,
103                                                const GLsizei                 theViewportSizeY,
104                                                const GLuint                  theColorRBufferFromWindow = 0);
105
106   //! Initialize class from currently bound FBO.
107   //! Retrieved OpenGL objects will not be destroyed on Release.
108   Standard_EXPORT Standard_Boolean InitWrapper (const Handle(OpenGl_Context)& theGlCtx);
109
110   //! Setup viewport to render into FBO
111   Standard_EXPORT void SetupViewport (const Handle(OpenGl_Context)& theGlCtx);
112
113   //! Override viewport settings
114   Standard_EXPORT void ChangeViewport (const GLsizei theVPSizeX,
115                                        const GLsizei theVPSizeY);
116
117   //! Bind frame buffer for drawing and reading (to render into the texture).
118   Standard_EXPORT virtual void BindBuffer (const Handle(OpenGl_Context)& theGlCtx);
119
120   //! Bind frame buffer for drawing GL_DRAW_FRAMEBUFFER (to render into the texture).
121   Standard_EXPORT virtual void BindDrawBuffer (const Handle(OpenGl_Context)& theGlCtx);
122
123   //! Bind frame buffer for reading GL_READ_FRAMEBUFFER
124   Standard_EXPORT virtual void BindReadBuffer (const Handle(OpenGl_Context)& theGlCtx);
125
126   //! Unbind frame buffer.
127   Standard_EXPORT virtual void UnbindBuffer (const Handle(OpenGl_Context)& theGlCtx);
128
129   //! Returns the color texture.
130   inline const Handle(OpenGl_Texture)& ColorTexture() const
131   {
132     return myColorTexture;
133   }
134
135   //! Returns the depth-stencil texture.
136   inline const Handle(OpenGl_Texture)& DepthStencilTexture() const
137   {
138     return myDepthStencilTexture;
139   }
140
141   //! Returns the color Render Buffer.
142   GLuint ColorRenderBuffer() const
143   {
144     return myGlColorRBufferId;
145   }
146
147   //! Returns the depth Render Buffer.
148   GLuint DepthStencilRenderBuffer() const
149   {
150     return myGlDepthRBufferId;
151   }
152
153 protected:
154
155   Standard_Boolean isValidFrameBuffer() const
156   {
157     return myGlFBufferId != NO_FRAMEBUFFER;
158   }
159
160 protected:
161
162   GLsizei                myVPSizeX;             //!< viewport width  (should be <= texture width)
163   GLsizei                myVPSizeY;             //!< viewport height (should be <= texture height)
164   GLint                  myTextFormat;          //!< GL_RGB, GL_RGBA,...
165   GLuint                 myGlFBufferId;         //!< FBO object ID
166   GLuint                 myGlColorRBufferId;    //!< color         Render Buffer object (alternative to myColorTexture)
167   GLuint                 myGlDepthRBufferId;    //!< depth-stencil Render Buffer object (alternative to myDepthStencilTexture)
168   bool                   myIsOwnBuffer;         //!< flag indicating that FBO should be deallocated by this class
169   Handle(OpenGl_Texture) myColorTexture;        //!< color texture object
170   Handle(OpenGl_Texture) myDepthStencilTexture; //!< depth-stencil texture object
171
172 public:
173
174   DEFINE_STANDARD_RTTI(OpenGl_FrameBuffer, OpenGl_Resource) // Type definition
175
176 };
177
178 #endif // OPENGL_FRAME_BUFFER_H