0022819: Redesign of OpenGl driver
[occt.git] / src / OpenGl / OpenGl_FrameBuffer.cxx
1 // File:      OpenGl_FrameBuffer.cxx
2 // Author:    Kirill GAVRILOV
3 // Copyright: OPEN CASCADE 2011
4
5 #include <OpenGl_FrameBuffer.hxx>
6
7 #ifdef DEB
8   #include <iostream>
9 #endif
10
11 static inline bool isOddNumber (const GLsizei theNumber)
12 {
13   return theNumber & 0x01;
14 }
15
16 static inline GLsizei getEvenNumber (const GLsizei theNumber)
17 {
18   return isOddNumber (theNumber) ? (theNumber + 1) : theNumber;
19 }
20
21 //! Notice - 0 is not power of two here
22 static inline bool isPowerOfTwo (const GLsizei theNumber)
23 {
24         return !(theNumber & (theNumber - 1));
25 }
26
27 static inline GLsizei getPowerOfTwo (const GLsizei theNumber,
28                                      const GLsizei theThreshold)
29 {
30   for (GLsizei p2 = 2; p2 <= theThreshold; p2 <<= 1)
31   {
32     if (theNumber <= p2)
33     {
34       return p2;
35     }
36   }
37   return theThreshold;
38 }
39
40 OpenGl_FrameBuffer::OpenGl_FrameBuffer (GLint theTextureFormat)
41 : mySizeX (0),
42   mySizeY (0),
43   myVPSizeX (0),
44   myVPSizeY (0),
45   myTextFormat (theTextureFormat),
46   myGlTextureId (NO_TEXTURE),
47   myGlFBufferId (NO_FRAMEBUFFER),
48   myGlDepthRBId (NO_RENDERBUFFER)
49 {
50   //
51 }
52
53 Standard_Boolean OpenGl_FrameBuffer::Init (const Handle(OpenGl_Context)& theGlContext,
54                                            GLsizei theViewportSizeX,
55                                            GLsizei theViewportSizeY,
56                                            GLboolean toForcePowerOfTwo)
57 {
58   if (theGlContext->extFBO == NULL)
59   {
60   #ifdef DEB
61     std::cerr << "OpenGl_FrameBuffer, FBO extension not supported!\n";
62   #endif
63     return Standard_False;
64   }
65
66   // clean up previous state
67   Release (theGlContext);
68
69   // upscale width/height if numbers are odd
70   if (toForcePowerOfTwo)
71   {
72     GLint aMaxTexDim = 2048;
73     glGetIntegerv (GL_MAX_TEXTURE_SIZE, &aMaxTexDim);
74     mySizeX = getPowerOfTwo (theViewportSizeX, aMaxTexDim);
75     mySizeY = getPowerOfTwo (theViewportSizeY, aMaxTexDim);
76   }
77   else
78   {
79     mySizeX = getEvenNumber (theViewportSizeX);
80     mySizeY = getEvenNumber (theViewportSizeY);
81   }
82
83   // setup viewport sizes as is
84   myVPSizeX = theViewportSizeX;
85   myVPSizeY = theViewportSizeY;
86
87   // Create the texture (will be used as color buffer)
88   if (!InitTrashTexture (theGlContext))
89   {
90     if (!isPowerOfTwo (mySizeX) || !isPowerOfTwo (mySizeY))
91     {
92       return Init (theGlContext, theViewportSizeX, theViewportSizeY, GL_TRUE);
93     }
94     Release (theGlContext);
95     return Standard_False;
96   }
97
98   // Create RenderBuffer (will be used as depth buffer)
99   theGlContext->extFBO->glGenRenderbuffersEXT (1, &myGlDepthRBId);
100   theGlContext->extFBO->glBindRenderbufferEXT (GL_RENDERBUFFER_EXT, myGlDepthRBId);
101   theGlContext->extFBO->glRenderbufferStorageEXT (GL_RENDERBUFFER_EXT, GL_DEPTH_COMPONENT, mySizeX, mySizeY);
102
103   // Build FBO and setup it as texture
104   theGlContext->extFBO->glGenFramebuffersEXT (1, &myGlFBufferId);
105   theGlContext->extFBO->glBindFramebufferEXT (GL_FRAMEBUFFER_EXT, myGlFBufferId);
106   glEnable (GL_TEXTURE_2D);
107   glBindTexture (GL_TEXTURE_2D, myGlTextureId);
108   theGlContext->extFBO->glFramebufferTexture2DEXT (GL_FRAMEBUFFER_EXT, GL_COLOR_ATTACHMENT0_EXT, GL_TEXTURE_2D, myGlTextureId, 0);
109   theGlContext->extFBO->glFramebufferRenderbufferEXT (GL_FRAMEBUFFER_EXT, GL_DEPTH_ATTACHMENT_EXT, GL_RENDERBUFFER_EXT, myGlFBufferId);
110   if (theGlContext->extFBO->glCheckFramebufferStatusEXT (GL_FRAMEBUFFER_EXT) != GL_FRAMEBUFFER_COMPLETE_EXT)
111   {
112     if (!isPowerOfTwo (mySizeX) || !isPowerOfTwo (mySizeY))
113     {
114       return Init (theGlContext, theViewportSizeX, theViewportSizeY, GL_TRUE);
115     }
116     Release (theGlContext);
117     return Standard_False;
118   }
119
120   UnbindBuffer (theGlContext);
121   UnbindTexture();
122   theGlContext->extFBO->glBindRenderbufferEXT (GL_RENDERBUFFER_EXT, NO_RENDERBUFFER);
123
124   #ifdef DEB
125     std::cerr << "OpenGl_FrameBuffer, created FBO " << mySizeX << "x" << mySizeY
126               << " for viewport " << theViewportSizeX << "x" << theViewportSizeY << "\n";
127   #endif
128   return Standard_True;
129 }
130
131 void OpenGl_FrameBuffer::Release (const Handle(OpenGl_Context)& theGlContext)
132 {
133   if (IsValidDepthBuffer())
134   {
135     if (!theGlContext.IsNull() && theGlContext->extFBO != NULL)
136     {
137       theGlContext->extFBO->glDeleteRenderbuffersEXT (1, &myGlDepthRBId);
138       myGlDepthRBId = NO_RENDERBUFFER;
139     }
140     else
141     {
142       std::cerr << "OpenGl_FrameBuffer::Release() called with invalid OpenGl_Context!\n";
143     }
144   }
145   if (IsValidTexture())
146   {
147     glDeleteTextures (1, &myGlTextureId);
148     myGlTextureId = NO_TEXTURE;
149   }
150   mySizeX = mySizeY = myVPSizeX = myVPSizeY = 0;
151   if (IsValidFrameBuffer())
152   {
153     if (!theGlContext.IsNull() && theGlContext->extFBO != NULL)
154     {
155       theGlContext->extFBO->glDeleteFramebuffersEXT (1, &myGlFBufferId);
156       myGlFBufferId = NO_FRAMEBUFFER;
157     }
158     else
159     {
160       std::cerr << "OpenGl_FrameBuffer::Release() called with invalid OpenGl_Context!\n";
161     }
162   }
163 }
164
165 Standard_Boolean OpenGl_FrameBuffer::IsProxySuccess() const
166 {
167   // use proxy to check texture could be created or not
168   glTexImage2D (GL_PROXY_TEXTURE_2D,
169                 0,                // LOD number: 0 - base image level; n is the nth mipmap reduction image
170                 myTextFormat,     // internalformat
171                 mySizeX, mySizeY, 0,
172                 GL_RGBA, GL_UNSIGNED_BYTE, NULL);
173   GLint aTestParamX (0), aTestParamY (0);
174   glGetTexLevelParameteriv (GL_PROXY_TEXTURE_2D, 0, GL_TEXTURE_WIDTH, &aTestParamX);
175   glGetTexLevelParameteriv (GL_PROXY_TEXTURE_2D, 0, GL_TEXTURE_WIDTH, &aTestParamY);
176   return aTestParamX != 0 && aTestParamY != 0;
177 }
178
179 Standard_Boolean OpenGl_FrameBuffer::InitTrashTexture (const Handle(OpenGl_Context)& theGlContext)
180 {
181   // Check texture size is fit dimension maximum
182   GLint aMaxTexDim = 2048;
183   glGetIntegerv (GL_MAX_TEXTURE_SIZE, &aMaxTexDim);
184   if (mySizeX > aMaxTexDim || mySizeY > aMaxTexDim)
185   {
186     return Standard_False;
187   }
188
189   // generate new id
190   glEnable (GL_TEXTURE_2D);
191   if (!IsValidTexture())
192   {
193     glGenTextures (1, &myGlTextureId); // Create The Texture
194   }
195   glBindTexture (GL_TEXTURE_2D, myGlTextureId);
196
197   // texture interpolation parameters - could be overridden later
198   glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
199   glTexParameteri (GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
200
201   if (!IsProxySuccess())
202   {
203     Release (theGlContext);
204     return Standard_False;
205   }
206
207   glTexImage2D (GL_TEXTURE_2D,
208                 0,                // LOD number: 0 - base image level; n is the nth mipmap reduction image
209                 myTextFormat,     // internalformat
210                 mySizeX, mySizeY, 0,
211                 GL_RGBA, GL_UNSIGNED_BYTE, NULL); // NULL pointer supported from OpenGL 1.1
212   return Standard_True;
213 }