Project

General

Profile

Download (10.3 KB) Statistics
| Branch: | Revision:

library / src / main / java / org / distorted / library / DistortedFramebuffer.java @ a09ada4c

1 f6fb3c6d Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
2
// Copyright 2016 Leszek Koltunski                                                               //
3
//                                                                                               //
4
// This file is part of Distorted.                                                               //
5
//                                                                                               //
6
// Distorted is free software: you can redistribute it and/or modify                             //
7
// it under the terms of the GNU General Public License as published by                          //
8
// the Free Software Foundation, either version 2 of the License, or                             //
9
// (at your option) any later version.                                                           //
10
//                                                                                               //
11
// Distorted is distributed in the hope that it will be useful,                                  //
12
// but WITHOUT ANY WARRANTY; without even the implied warranty of                                //
13
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                                 //
14
// GNU General Public License for more details.                                                  //
15
//                                                                                               //
16
// You should have received a copy of the GNU General Public License                             //
17
// along with Distorted.  If not, see <http://www.gnu.org/licenses/>.                            //
18
///////////////////////////////////////////////////////////////////////////////////////////////////
19
20
package org.distorted.library;
21
22 194ab46f Leszek Koltunski
import android.opengl.GLES30;
23 f6fb3c6d Leszek Koltunski
24
///////////////////////////////////////////////////////////////////////////////////////////////////
25 dedacd82 Leszek Koltunski
/**
26
 * Class which represents a OpenGL Framebuffer object.
27 71c3fecc Leszek Koltunski
 * <p>
28 c5369f1b leszek
 * User is able to create offscreen FBOs and both a) render to them b) use their COLOR0 attachment as
29
 * an input texture.
30 dedacd82 Leszek Koltunski
 */
31 af4cc5db Leszek Koltunski
public class DistortedFramebuffer extends DistortedOutputSurface implements DistortedInputSurface
32 f6fb3c6d Leszek Koltunski
  {
33 133cbb2b Leszek Koltunski
  private int[] mDepthH = new int[1];
34
  private int[] mFBOH   = new int[1];
35 cdd5e827 Leszek Koltunski
  private boolean mDepthEnabled;
36 bd3da5b2 Leszek Koltunski
37 f6fb3c6d Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
38 6537ba91 Leszek Koltunski
// Must be called from a thread holding OpenGL Context
39 227ac49a Leszek Koltunski
// Watch out - this has the side-effect of binding a Texture and a Framebuffer!
40 f6fb3c6d Leszek Koltunski
41 c5369f1b leszek
  public void create()
42 f6fb3c6d Leszek Koltunski
    {
43 133cbb2b Leszek Koltunski
    if( mColorH[0]==NOT_CREATED_YET )
44 7cf783cb Leszek Koltunski
      {
45 133cbb2b Leszek Koltunski
      GLES30.glGenTextures(1, mColorH, 0);
46
      GLES30.glBindTexture(GLES30.GL_TEXTURE_2D, mColorH[0]);
47 194ab46f Leszek Koltunski
      GLES30.glTexParameteri(GLES30.GL_TEXTURE_2D, GLES30.GL_TEXTURE_WRAP_S, GLES30.GL_REPEAT);
48
      GLES30.glTexParameteri(GLES30.GL_TEXTURE_2D, GLES30.GL_TEXTURE_WRAP_T, GLES30.GL_REPEAT);
49
      GLES30.glTexParameterf(GLES30.GL_TEXTURE_2D, GLES30.GL_TEXTURE_MIN_FILTER, GLES30.GL_NEAREST);
50
      GLES30.glTexParameterf(GLES30.GL_TEXTURE_2D, GLES30.GL_TEXTURE_MAG_FILTER, GLES30.GL_LINEAR);
51 133cbb2b Leszek Koltunski
      GLES30.glTexImage2D(GLES30.GL_TEXTURE_2D, 0, GLES30.GL_RGBA, mSizeX, mSizeY, 0, GLES30.GL_RGBA, GLES30.GL_UNSIGNED_BYTE, null);
52 194ab46f Leszek Koltunski
53 133cbb2b Leszek Koltunski
      GLES30.glGenFramebuffers(1, mFBOH, 0);
54
      GLES30.glBindFramebuffer(GLES30.GL_FRAMEBUFFER, mFBOH[0]);
55
      GLES30.glFramebufferTexture2D(GLES30.GL_FRAMEBUFFER, GLES30.GL_COLOR_ATTACHMENT0, GLES30.GL_TEXTURE_2D, mColorH[0], 0);
56 dedacd82 Leszek Koltunski
57 8337fa41 Leszek Koltunski
      checkStatus("color");
58 7cf783cb Leszek Koltunski
      }
59 133cbb2b Leszek Koltunski
    if( mDepthEnabled && mDepthH[0]==NOT_CREATED_YET ) // we need to create a new DEPTH attachment
60 8c327653 Leszek Koltunski
      {
61 133cbb2b Leszek Koltunski
      GLES30.glGenTextures(1, mDepthH, 0);
62
      GLES30.glBindTexture(GLES30.GL_TEXTURE_2D, mDepthH[0]);
63 194ab46f Leszek Koltunski
      GLES30.glTexParameteri(GLES30.GL_TEXTURE_2D, GLES30.GL_TEXTURE_WRAP_S, GLES30.GL_REPEAT);
64
      GLES30.glTexParameteri(GLES30.GL_TEXTURE_2D, GLES30.GL_TEXTURE_WRAP_T, GLES30.GL_REPEAT);
65
      GLES30.glTexParameteri(GLES30.GL_TEXTURE_2D, GLES30.GL_TEXTURE_MIN_FILTER, GLES30.GL_NEAREST);
66
      GLES30.glTexParameteri(GLES30.GL_TEXTURE_2D, GLES30.GL_TEXTURE_MAG_FILTER, GLES30.GL_NEAREST);
67 133cbb2b Leszek Koltunski
      GLES30.glTexImage2D(GLES30.GL_TEXTURE_2D, 0, GLES30.GL_DEPTH_COMPONENT, mSizeX, mSizeY, 0, GLES30.GL_DEPTH_COMPONENT, GLES30.GL_UNSIGNED_SHORT, null);
68 8c327653 Leszek Koltunski
69 133cbb2b Leszek Koltunski
      GLES30.glBindFramebuffer(GLES30.GL_FRAMEBUFFER, mFBOH[0]);
70
      GLES30.glFramebufferTexture2D(GLES30.GL_FRAMEBUFFER, GLES30.GL_DEPTH_ATTACHMENT, GLES30.GL_TEXTURE_2D, mDepthH[0], 0);
71 8c327653 Leszek Koltunski
72 8337fa41 Leszek Koltunski
      checkStatus("depth");
73 8c327653 Leszek Koltunski
      }
74 133cbb2b Leszek Koltunski
    if( !mDepthEnabled && mDepthH[0]!=NOT_CREATED_YET ) // we need to detach and destroy the DEPTH attachment.
75 8c327653 Leszek Koltunski
      {
76 133cbb2b Leszek Koltunski
      GLES30.glDeleteTextures(1, mDepthH, 0);
77
      mDepthH[0]=NOT_CREATED_YET;
78 8c327653 Leszek Koltunski
      }
79 8337fa41 Leszek Koltunski
    }
80
81
///////////////////////////////////////////////////////////////////////////////////////////////////
82
83
  private boolean checkStatus(String message)
84
    {
85 194ab46f Leszek Koltunski
    int status = GLES30.glCheckFramebufferStatus(GLES30.GL_FRAMEBUFFER);
86 8337fa41 Leszek Koltunski
87 194ab46f Leszek Koltunski
    if(status != GLES30.GL_FRAMEBUFFER_COMPLETE)
88 8337fa41 Leszek Koltunski
      {
89
      android.util.Log.e("DistortedFramebuffer", "FRAMEBUFFER INCOMPLETE, "+message+" error="+status);
90
91 133cbb2b Leszek Koltunski
      GLES30.glDeleteTextures(1, mColorH, 0);
92
      GLES30.glDeleteTextures(1, mDepthH, 0);
93
      GLES30.glDeleteFramebuffers(1, mFBOH, 0);
94
      mFBOH[0]   = 0;
95
      mColorH[0] = FAILED_TO_CREATE;
96
      mDepthH[0] = FAILED_TO_CREATE;
97 8337fa41 Leszek Koltunski
98
      return false;
99
      }
100 8c327653 Leszek Koltunski
101 f6fb3c6d Leszek Koltunski
    return true;
102
    }
103
104
///////////////////////////////////////////////////////////////////////////////////////////////////
105 6537ba91 Leszek Koltunski
// Must be called from a thread holding OpenGL Context
106 f6fb3c6d Leszek Koltunski
107 227ac49a Leszek Koltunski
  void delete()
108 f6fb3c6d Leszek Koltunski
    {
109 133cbb2b Leszek Koltunski
    if( mColorH[0]>=0 )
110 e6cf7d50 Leszek Koltunski
      {
111 133cbb2b Leszek Koltunski
      if( mDepthH[0]>=0 )
112 8c327653 Leszek Koltunski
        {
113 133cbb2b Leszek Koltunski
        GLES30.glDeleteTextures(1, mDepthH, 0);
114
        mDepthH[0]=NOT_CREATED_YET;
115 8c327653 Leszek Koltunski
        }
116
117 133cbb2b Leszek Koltunski
      GLES30.glDeleteTextures(1, mColorH, 0);
118
      mColorH[0] = NOT_CREATED_YET;
119 bd3da5b2 Leszek Koltunski
120 133cbb2b Leszek Koltunski
      GLES30.glDeleteFramebuffers(1, mFBOH, 0);
121
      mFBOH[0] = 0;
122 e6cf7d50 Leszek Koltunski
      }
123 bd3da5b2 Leszek Koltunski
    }
124
125 4ebbb17a Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
126
// called from onDestroy(); mark OpenGL assets as 'not created'
127
128
  void destroy()
129
    {
130
    if( mColorH[0]!=DONT_CREATE ) mColorH[0] = NOT_CREATED_YET;
131
    if( mDepthEnabled           ) mDepthH[0] = NOT_CREATED_YET;
132
    }
133
134 86eb00a9 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
135
// if new size fits into the size of the underlying Texture, just change the projection without
136
// reallocating the Texture. Otherwise, we need to reallocate.
137
//
138 af4cc5db Leszek Koltunski
// Must be called from a thread holding the OpenGL context.
139 86eb00a9 Leszek Koltunski
140
  void resizeFast(int width, int height)
141
    {
142 af4cc5db Leszek Koltunski
    if( mWidth!=width || mHeight!=height )
143 86eb00a9 Leszek Koltunski
      {
144 af4cc5db Leszek Koltunski
      mWidth = width;
145
      mHeight= height;
146
      createProjection();
147
148 c5369f1b leszek
      if( width> mSizeX || height> mSizeY)
149 86eb00a9 Leszek Koltunski
        {
150 c5369f1b leszek
        mSizeX = width;
151
        mSizeY = height;
152 133cbb2b Leszek Koltunski
        delete();
153 86eb00a9 Leszek Koltunski
        }
154
      }
155 cc0734e7 Leszek Koltunski
156 133cbb2b Leszek Koltunski
    create();
157 86eb00a9 Leszek Koltunski
    }
158
159 f6fb3c6d Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
160
// PUBLIC API
161 dedacd82 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
162 cdd5e827 Leszek Koltunski
/**
163
 * Create a new offscreen Framebuffer.
164
 *
165
 * @param width Width of the COLOR attachment.
166
 * @param height Height of the COLOR attachment.
167
 * @param depthEnabled Add DEPTH attachment?
168
 */
169
  @SuppressWarnings("unused")
170
  public DistortedFramebuffer(int width, int height, boolean depthEnabled)
171
    {
172 2e49718d Leszek Koltunski
    super(width,height,NOT_CREATED_YET);
173 cdd5e827 Leszek Koltunski
    mDepthEnabled= depthEnabled;
174 2e49718d Leszek Koltunski
    mFBOH[0]     = NOT_CREATED_YET;
175
    mDepthH[0]   = NOT_CREATED_YET;
176 cdd5e827 Leszek Koltunski
    }
177
178 133cbb2b Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
179
180 dedacd82 Leszek Koltunski
/**
181 57578636 Leszek Koltunski
 * Create a new offscreen Framebuffer.
182 dedacd82 Leszek Koltunski
 *
183
 * @param width Width of the COLOR attachment.
184
 * @param height Height of the COLOR attachment.
185
 */
186 1942537e Leszek Koltunski
  @SuppressWarnings("unused")
187 ed13a5de Leszek Koltunski
  public DistortedFramebuffer(int width, int height)
188 f6fb3c6d Leszek Koltunski
    {
189 2e49718d Leszek Koltunski
    super(width,height,NOT_CREATED_YET);
190 cdd5e827 Leszek Koltunski
    mDepthEnabled= false;
191 2e49718d Leszek Koltunski
    mFBOH[0]     = NOT_CREATED_YET;
192
    mDepthH[0]   = NOT_CREATED_YET;
193 f6fb3c6d Leszek Koltunski
    }
194
195 b448e6b9 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
196 dedacd82 Leszek Koltunski
/**
197 c5369f1b leszek
 * Bind the underlying rectangle of pixels as a OpenGL Texture.
198 af4cc5db Leszek Koltunski
 *
199
 * @returns <code>true</code> if successful.
200 dedacd82 Leszek Koltunski
 */
201 c5369f1b leszek
  public boolean setAsInput()
202 b448e6b9 Leszek Koltunski
    {
203 c5369f1b leszek
    if( mColorH[0]>0 )
204
      {
205
      GLES30.glBindTexture(GLES30.GL_TEXTURE_2D, mColorH[0]);
206
      return true;
207
      }
208
209
    return false;
210
    }
211 2e49718d Leszek Koltunski
212 c5369f1b leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
213
/**
214
 * Bind this Surface as a Framebuffer we can render to.
215
 */
216
  public void setAsOutput()
217
    {
218
    GLES30.glBindFramebuffer(GLES30.GL_FRAMEBUFFER, mFBOH[0]);
219 b448e6b9 Leszek Koltunski
220 c5369f1b leszek
    if( mDepthH[0]!=NOT_CREATED_YET )
221
      {
222
      GLES30.glEnable(GLES30.GL_DEPTH_TEST);
223
      GLES30.glDepthMask(true);
224
      }
225
    else
226
      {
227
      GLES30.glDisable(GLES30.GL_DEPTH_TEST);
228
      GLES30.glDepthMask(false);
229
      }
230 8c327653 Leszek Koltunski
    }
231
232
///////////////////////////////////////////////////////////////////////////////////////////////////
233
/**
234
 * Create a new DEPTH buffer and attach it or (param=false) detach an existing DEPTh attachment and destroy it.
235
 *
236 cdd5e827 Leszek Koltunski
 * @param enable <bold>true</bold> if we want to attach a new DEPTH buffer to the FBO.<br>
237
 *               <bold>false</bold> if we want to detach the DEPTH attachment.
238 8c327653 Leszek Koltunski
 */
239 cdd5e827 Leszek Koltunski
  public void enableDepthAttachment(boolean enable)
240 8c327653 Leszek Koltunski
    {
241 cdd5e827 Leszek Koltunski
    mDepthEnabled = enable;
242 b448e6b9 Leszek Koltunski
    }
243
244 d1e740c5 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
245
/**
246 09d4f4b1 Leszek Koltunski
 * Return the ID of the Texture (COLOR attachment 0) that's backing this FBO.
247
 * <p>
248
 * Catch: this will only work if the library has had time to actually create the texture. Remember
249
 * that the texture gets created only on first render, thus creating a Texture object and immediately
250
 * calling this method will return an invalid (negative) result.
251
 *
252 ab12f06b Leszek Koltunski
 * @return If there was not a single render between creation of the Object and calling this method on
253
 *         it, return a negative value. Otherwise, return ID of COLOR attachment 0.
254 d1e740c5 Leszek Koltunski
 */
255 09d4f4b1 Leszek Koltunski
  public int getTextureID()
256 d1e740c5 Leszek Koltunski
    {
257 133cbb2b Leszek Koltunski
    return mColorH[0];
258 8c327653 Leszek Koltunski
    }
259
260
///////////////////////////////////////////////////////////////////////////////////////////////////
261
/**
262
 * Return true if the FBO contains a DEPTH attachment.
263
 *
264
 * @return <bold>true</bold> if the FBO contains a DEPTH attachment.
265
 */
266
  public boolean hasDepth()
267
    {
268 cdd5e827 Leszek Koltunski
    return mDepthEnabled;
269 d1e740c5 Leszek Koltunski
    }
270 f6fb3c6d Leszek Koltunski
  }