Project

General

Profile

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

library / src / main / java / org / distorted / library / main / DistortedOutputSurface.java @ 2f35828c

1 c5369f1b leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
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 fe82a979 Leszek Koltunski
package org.distorted.library.main;
21 c5369f1b leszek
22 e6519ac8 Leszek Koltunski
import android.opengl.GLES31;
23 af4cc5db Leszek Koltunski
import android.opengl.Matrix;
24 86e99907 leszek
25 3521c6fe leszek
import org.distorted.library.effect.EffectQuality;
26
27 a09ada4c Leszek Koltunski
import java.util.ArrayList;
28 af4cc5db Leszek Koltunski
29
///////////////////////////////////////////////////////////////////////////////////////////////////
30 70b6a155 Leszek Koltunski
/**
31
 * This is not really part of the public API.
32
 *
33
 * @y.exclude
34
 */
35
public abstract class DistortedOutputSurface extends DistortedSurface implements DistortedMaster.Slave
36 af4cc5db Leszek Koltunski
{
37 86e99907 leszek
//////////// DEBUG FLAGS /////////////////////////////////////////////
38
/**
39
 * When rendering a Screen, show FPS in the upper-left corner?
40
 */
41
public static final int DEBUG_FPS = 1;
42
//////////// END DEBUG FLAGS /////////////////////////////////////////
43
44 89de975c leszek
/**
45
 * Do not create DEPTH or STENCIL attachment
46
 */
47 23eecbd9 Leszek Koltunski
  public static final int NO_DEPTH_NO_STENCIL = 0;
48 89de975c leszek
/**
49
 * Create DEPTH, but not STENCIL
50
 */
51 23eecbd9 Leszek Koltunski
  public static final int DEPTH_NO_STENCIL    = 1;
52 89de975c leszek
/**
53
 * Create both DEPTH and STENCIL
54
 */
55 23eecbd9 Leszek Koltunski
  public static final int BOTH_DEPTH_STENCIL  = 2;
56 89de975c leszek
57 efe3d8fe leszek
  private static final int ATTACH = 0;
58
  private static final int DETACH = 1;
59
  private static final int DETALL = 2;
60
  private static final int SORT   = 3;
61
62 a09ada4c Leszek Koltunski
  private ArrayList<DistortedNode> mChildren;
63
  private int mNumChildren;   // ==mChildren.length(), but we only create mChildren if the first one gets added
64
65 efe3d8fe leszek
  private class Job
66
    {
67
    int type;
68
    DistortedNode node;
69
70 ffbe7ecf Leszek Koltunski
    Job(int t, DistortedNode n)
71 efe3d8fe leszek
      {
72
      type = t;
73
      node = n;
74
      }
75
    }
76
77
  private ArrayList<Job> mJobs = new ArrayList<>();
78
79 ce154014 Leszek Koltunski
  // Global buffers used for postprocessing.
80 b0f04e72 Leszek Koltunski
  private static DistortedOutputSurface[] mBuffer = new DistortedOutputSurface[EffectQuality.LENGTH];
81 60c1c622 leszek
82 95c441a2 leszek
  private long mTime;
83 c2c08950 leszek
  private float mFOV;
84
  float mDistance, mNear;
85 af4cc5db Leszek Koltunski
  float[] mProjectionMatrix;
86
87 89de975c leszek
  int mDepthStencilCreated;
88
  int mDepthStencil;
89
  int[] mDepthStencilH = new int[1];
90
  int[] mFBOH          = new int[1];
91 a436ccc5 leszek
92 a9f41fa3 leszek
  private float mClearR, mClearG, mClearB, mClearA;
93
  private float mClearDepth;
94 23eecbd9 Leszek Koltunski
  private int mClearStencil;
95 ad16ed3b Leszek Koltunski
  private int mClear;
96 78db8663 Leszek Koltunski
  float mMipmap;
97
98 86e99907 leszek
  private int mDebugLevel;
99
100 61441ce2 Leszek Koltunski
  int mRealWidth;   // the Surface can be backed up with a texture that is
101
  int mRealHeight;  // larger than the viewport we have to it.
102
                    // mWidth,mHeight are the sizes of the Viewport, those -
103
                    // sizes of the backing up texture.
104 a4b182d4 Leszek Koltunski
105 86e99907 leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
106
107
  abstract void prepareDebug(long time);
108
  abstract void renderDebug(long time);
109
110 af4cc5db Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
111
112 9ed80185 Leszek Koltunski
  DistortedOutputSurface(int width, int height, int createColor, int numcolors, int depthStencil, int fbo, int type)
113 af4cc5db Leszek Koltunski
    {
114 9ed80185 Leszek Koltunski
    super(width,height,createColor,numcolors,type);
115 af4cc5db Leszek Koltunski
116 a4b182d4 Leszek Koltunski
    mRealWidth = width;
117
    mRealHeight= height;
118
119 af4cc5db Leszek Koltunski
    mProjectionMatrix = new float[16];
120
121
    mFOV = 60.0f;
122 54fe333a leszek
    mNear=  0.5f;
123 af4cc5db Leszek Koltunski
124 23eecbd9 Leszek Koltunski
    mDepthStencilCreated= (depthStencil== NO_DEPTH_NO_STENCIL ? DONT_CREATE:NOT_CREATED_YET);
125 89de975c leszek
    mDepthStencil = depthStencil;
126
127
    mFBOH[0]         = fbo;
128
    mDepthStencilH[0]= 0;
129 a436ccc5 leszek
130 95c441a2 leszek
    mTime = 0;
131 86e99907 leszek
    mDebugLevel = 0;
132 95c441a2 leszek
133 a9f41fa3 leszek
    mClearR = 0.0f;
134
    mClearG = 0.0f;
135
    mClearB = 0.0f;
136
    mClearA = 0.0f;
137
138
    mClearDepth = 1.0f;
139 23eecbd9 Leszek Koltunski
    mClearStencil = 0;
140 e6519ac8 Leszek Koltunski
    mClear = GLES31.GL_DEPTH_BUFFER_BIT | GLES31.GL_COLOR_BUFFER_BIT;
141 a9f41fa3 leszek
142 8426bd6a Leszek Koltunski
    mMipmap = 1.0f;
143 78db8663 Leszek Koltunski
144 af4cc5db Leszek Koltunski
    createProjection();
145
    }
146
147 c5369f1b leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
148
149 be60d4ff leszek
  private void createProjection()
150 af4cc5db Leszek Koltunski
    {
151
    if( mWidth>0 && mHeight>1 )
152
      {
153
      if( mFOV>0.0f )  // perspective projection
154
        {
155 54fe333a leszek
        float a = 2.0f*(float)Math.tan(mFOV*Math.PI/360);
156 8426bd6a Leszek Koltunski
        float q = mWidth*mNear;
157
        float c = mHeight*mNear;
158 54fe333a leszek
159 c2c08950 leszek
        float left   = -q/2;
160
        float right  = +q/2;
161
        float bottom = -c/2;
162
        float top    = +c/2;
163
        float near   =  c/a;
164 54fe333a leszek
165 8426bd6a Leszek Koltunski
        mDistance    = mHeight/a;
166 af4cc5db Leszek Koltunski
        float far    = 2*mDistance-near;
167
168
        Matrix.frustumM(mProjectionMatrix, 0, left, right, bottom, top, near, far);
169
        }
170
      else             // parallel projection
171
        {
172 8426bd6a Leszek Koltunski
        float left   = -mWidth/2.0f;
173
        float right  = +mWidth/2.0f;
174
        float bottom = -mHeight/2.0f;
175
        float top    = +mHeight/2.0f;
176
        float near   = mWidth+mHeight-mHeight*(1.0f-mNear);
177
        mDistance    = mWidth+mHeight;
178
        float far    = mWidth+mHeight+mHeight*(1.0f-mNear);
179 af4cc5db Leszek Koltunski
180
        Matrix.orthoM(mProjectionMatrix, 0, left, right, bottom, top, near, far);
181
        }
182
      }
183
    }
184
185 1d6d261e Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
186
187 ce154014 Leszek Koltunski
  private static void createBuffers(int width, int height, float near)
188 1d6d261e Leszek Koltunski
    {
189
    float mipmap=1.0f;
190
191
    for(int j=0; j<EffectQuality.LENGTH; j++)
192
      {
193 ce154014 Leszek Koltunski
      mBuffer[j] = new DistortedFramebuffer(2,BOTH_DEPTH_STENCIL,TYPE_SYST, (int)(width*mipmap), (int)(height*mipmap) );
194 0f011027 Leszek Koltunski
      mBuffer[j].mMipmap = mipmap;
195 ce154014 Leszek Koltunski
      mBuffer[j].mNear   = near;  // copy mNear as well (for blitting- see PostprocessEffect.apply() )
196 7ad20cce Leszek Koltunski
      mBuffer[j].glClearColor(1.0f,1.0f,1.0f,0.0f);
197 a4b182d4 Leszek Koltunski
198 1d6d261e Leszek Koltunski
      mipmap *= EffectQuality.MULTIPLIER;
199
      }
200
201
    DistortedObject.toDo(); // create the FBOs immediately. This is safe as we must be holding the OpenGL context now.
202
203 e6519ac8 Leszek Koltunski
    GLES31.glStencilMask(0xff);
204
    GLES31.glDepthMask(true);
205
    GLES31.glColorMask(true,true,true,true);
206 9455da17 Leszek Koltunski
    GLES31.glClearColor(1.0f,1.0f,1.0f,0.0f);
207 e6519ac8 Leszek Koltunski
    GLES31.glClearDepthf(1.0f);
208
    GLES31.glClearStencil(0);
209 1d6d261e Leszek Koltunski
210
    for(int j=0; j<EffectQuality.LENGTH; j++)
211
      {
212 0f011027 Leszek Koltunski
      mBuffer[j].setAsOutput();
213 e6519ac8 Leszek Koltunski
      GLES31.glFramebufferTexture2D(GLES31.GL_FRAMEBUFFER, GLES31.GL_COLOR_ATTACHMENT0, GLES31.GL_TEXTURE_2D, mBuffer[j].mColorH[1], 0);
214
      GLES31.glClear(GLES31.GL_COLOR_BUFFER_BIT|GLES31.GL_DEPTH_BUFFER_BIT|GLES31.GL_STENCIL_BUFFER_BIT);
215
      GLES31.glFramebufferTexture2D(GLES31.GL_FRAMEBUFFER, GLES31.GL_COLOR_ATTACHMENT0, GLES31.GL_TEXTURE_2D, mBuffer[j].mColorH[0], 0);
216
      GLES31.glClear(GLES31.GL_COLOR_BUFFER_BIT);
217 1d6d261e Leszek Koltunski
      }
218
    }
219
220 a4b182d4 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
221
222 ce154014 Leszek Koltunski
  static synchronized void onDestroy()
223 a4b182d4 Leszek Koltunski
    {
224 b0f04e72 Leszek Koltunski
    for(int j=0; j<EffectQuality.LENGTH; j++)
225 ce154014 Leszek Koltunski
      {
226
      mBuffer[j] = null;
227
      }
228
    }
229 a4b182d4 Leszek Koltunski
230 ce154014 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
231 ae2802b1 Leszek Koltunski
// The postprocessing buffers mBuffer[] are generally speaking too large (there's just one static
232
// set of them) so before we use them for output, we need to adjust the Vieport as if they were
233
// smaller. That takes care of outputting pixels to them. When we use them as input, we have to
234
// adjust the texture coords - see the get{Width|Height}Correction functions.
235 a4b182d4 Leszek Koltunski
236 ce154014 Leszek Koltunski
  private static void cloneViewport(DistortedOutputSurface from)
237
    {
238 b0f04e72 Leszek Koltunski
    if( mBuffer[0].mWidth != from.mWidth )
239 a4b182d4 Leszek Koltunski
      {
240 ce154014 Leszek Koltunski
      DistortedOutputSurface surface;
241
242
      for(int i=0; i<EffectQuality.LENGTH; i++)
243
        {
244
        surface = mBuffer[i];
245
246
        surface.mWidth  = (int)(from.mWidth *surface.mMipmap);
247
        surface.mHeight = (int)(from.mHeight*surface.mMipmap);
248
249
        surface.mNear   = from.mNear;  // Near plane is independent of the mipmap level
250
251 ae2802b1 Leszek Koltunski
        //android.util.Log.e("surface", "viewport "+i+" to ("+from.mWidth+"x"+from.mHeight+")");
252 b0f04e72 Leszek Koltunski
253 ce154014 Leszek Koltunski
        surface.createProjection();
254
255
        int maxw = surface.mWidth  > surface.mRealWidth  ? surface.mWidth  : surface.mRealWidth;
256
        int maxh = surface.mHeight > surface.mRealHeight ? surface.mHeight : surface.mRealHeight;
257 a4b182d4 Leszek Koltunski
258 ce154014 Leszek Koltunski
        if (maxw > surface.mRealWidth || maxh > surface.mRealHeight)
259
          {
260
          surface.mRealWidth = maxw;
261
          surface.mRealHeight = maxh;
262
263 2f35828c Leszek Koltunski
          surface.recreate();
264
          surface.create();
265 ce154014 Leszek Koltunski
          }
266
        }
267 a4b182d4 Leszek Koltunski
      }
268
    }
269
270 6b962e80 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
271
272 70b6a155 Leszek Koltunski
  private int blitWithDepth(long currTime, DistortedOutputSurface buffer)
273 6b962e80 Leszek Koltunski
    {
274 e6519ac8 Leszek Koltunski
    GLES31.glViewport(0, 0, mWidth, mHeight);
275 6b962e80 Leszek Koltunski
    setAsOutput(currTime);
276 e6519ac8 Leszek Koltunski
    GLES31.glActiveTexture(GLES31.GL_TEXTURE0);
277
    GLES31.glBindTexture(GLES31.GL_TEXTURE_2D, buffer.mColorH[0]);
278
    GLES31.glActiveTexture(GLES31.GL_TEXTURE1);
279
    GLES31.glBindTexture(GLES31.GL_TEXTURE_2D, buffer.mDepthStencilH[0]);
280 6b962e80 Leszek Koltunski
281 e6519ac8 Leszek Koltunski
    GLES31.glDisable(GLES31.GL_STENCIL_TEST);
282
    GLES31.glStencilMask(0x00);
283 6b962e80 Leszek Koltunski
284 ae2802b1 Leszek Koltunski
    DistortedEffects.blitDepthPriv(this, buffer.getWidthCorrection(), buffer.getHeightCorrection() );
285 e6519ac8 Leszek Koltunski
    GLES31.glActiveTexture(GLES31.GL_TEXTURE0);
286
    GLES31.glBindTexture(GLES31.GL_TEXTURE_2D, 0);
287
    GLES31.glActiveTexture(GLES31.GL_TEXTURE1);
288
    GLES31.glBindTexture(GLES31.GL_TEXTURE_2D, 0);
289 6b962e80 Leszek Koltunski
290 8777ce17 Leszek Koltunski
    return 1;
291
    }
292
293
///////////////////////////////////////////////////////////////////////////////////////////////////
294
295
  private int blitWithDepthRender(long currTime, DistortedOutputSurface buffer)
296
    {
297
    GLES31.glViewport(0, 0, mWidth, mHeight);
298
    setAsOutput(currTime);
299
    GLES31.glActiveTexture(GLES31.GL_TEXTURE1);
300
    GLES31.glBindTexture(GLES31.GL_TEXTURE_2D, buffer.mDepthStencilH[0]);
301
302
    DistortedRenderState.enableStencil();
303
304
    DistortedEffects.blitDepthRenderPriv(this, buffer.getWidthCorrection(), buffer.getHeightCorrection() );
305
    GLES31.glActiveTexture(GLES31.GL_TEXTURE1);
306
    GLES31.glBindTexture(GLES31.GL_TEXTURE_2D, 0);
307
308
    DistortedRenderState.restoreStencil();
309
310
    return 1;
311
    }
312
313
///////////////////////////////////////////////////////////////////////////////////////////////////
314
315
  private void clearBuffer(DistortedOutputSurface buffer)
316
    {
317 e6519ac8 Leszek Koltunski
    GLES31.glStencilMask(0xff);
318
    GLES31.glDepthMask(true);
319
    GLES31.glColorMask(true,true,true,true);
320
    GLES31.glClearColor(0.0f,0.0f,0.0f,0.0f);
321
    GLES31.glClearDepthf(1.0f);
322
    GLES31.glClearStencil(0);
323 6b962e80 Leszek Koltunski
324
    buffer.setAsOutput();
325 e6519ac8 Leszek Koltunski
    GLES31.glFramebufferTexture2D(GLES31.GL_FRAMEBUFFER, GLES31.GL_COLOR_ATTACHMENT0, GLES31.GL_TEXTURE_2D, buffer.mColorH[1], 0);
326
    GLES31.glClear(GLES31.GL_COLOR_BUFFER_BIT|GLES31.GL_DEPTH_BUFFER_BIT|GLES31.GL_STENCIL_BUFFER_BIT);
327
    GLES31.glFramebufferTexture2D(GLES31.GL_FRAMEBUFFER, GLES31.GL_COLOR_ATTACHMENT0, GLES31.GL_TEXTURE_2D, buffer.mColorH[0], 0);
328
    GLES31.glClear(GLES31.GL_COLOR_BUFFER_BIT);
329 6b962e80 Leszek Koltunski
    }
330
331 af4cc5db Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
332 e02264ff leszek
// Render all children, one by one. If there are no postprocessing effects, just render to THIS.
333
// Otherwise, render to a buffer and on each change of Postprocessing Bucket, apply the postprocessing
334 9455da17 Leszek Koltunski
// to a whole buffer (lastQueue.postprocess) and merge it (this.blitWithDepth).
335 39086ebb leszek
336 8e28b6ff leszek
  int renderChildren(long time, int numChildren, ArrayList<DistortedNode> children)
337 b2939df4 Leszek Koltunski
    {
338 7266d8ef Leszek Koltunski
    int quality=0, internalQuality = 0, numRenders = 0, bucketChange = 0;
339 3f44e745 Leszek Koltunski
    DistortedNode child1, child2;
340 70b6a155 Leszek Koltunski
    EffectQueuePostprocess lastQueue=null, currQueue;
341 915b7b2b leszek
    long lastBucket=0, currBucket;
342 0afc143a leszek
343 8e28b6ff leszek
    for(int i=0; i<numChildren; i++)
344 39086ebb leszek
      {
345 3f44e745 Leszek Koltunski
      child1 = children.get(i);
346 70b6a155 Leszek Koltunski
      currQueue = child1.getPostprocessQueue();
347
      currBucket= currQueue.getID();
348 b9798977 leszek
349 915b7b2b leszek
      if( currBucket==0 ) numRenders += child1.draw(time,this);
350 60c1c622 leszek
      else
351
        {
352 ce154014 Leszek Koltunski
        if( mBuffer[0]==null ) createBuffers(mWidth,mHeight,mNear);
353 c9a24bfb Leszek Koltunski
354 915b7b2b leszek
        if( lastBucket!=currBucket )
355 c9a24bfb Leszek Koltunski
          {
356 915b7b2b leszek
          if( lastBucket!=0 )
357 c9a24bfb Leszek Koltunski
            {
358
            for(int j=bucketChange; j<i; j++)
359
              {
360 3f44e745 Leszek Koltunski
              child2 = children.get(j);
361 70b6a155 Leszek Koltunski
              numRenders += child2.markStencilAndDepth(time,mBuffer[internalQuality],lastQueue);
362 c9a24bfb Leszek Koltunski
              }
363
364 61441ce2 Leszek Koltunski
            numRenders += lastQueue.postprocess(mBuffer);
365 bed13bea leszek
            numRenders += blitWithDepth(time, mBuffer[quality]);
366 8777ce17 Leszek Koltunski
            clearBuffer(mBuffer[quality]);
367 c9a24bfb Leszek Koltunski
            }
368 660cd468 leszek
369 70b6a155 Leszek Koltunski
          internalQuality = currQueue.getInternalQuality();
370
          quality         = currQueue.getQuality();
371
          bucketChange    = i;
372 ce154014 Leszek Koltunski
373
          cloneViewport(this);
374 c9a24bfb Leszek Koltunski
          }
375
376 8dccc3c2 Leszek Koltunski
        child1.drawNoBlend(time,mBuffer[quality]);
377 c9a24bfb Leszek Koltunski
378 8e28b6ff leszek
        if( i==numChildren-1 )
379 cf7394cc leszek
          {
380 8e28b6ff leszek
          for(int j=bucketChange; j<numChildren; j++)
381 c9a24bfb Leszek Koltunski
            {
382 3f44e745 Leszek Koltunski
            child2 = children.get(j);
383 70b6a155 Leszek Koltunski
            numRenders += child2.markStencilAndDepth(time,mBuffer[internalQuality],currQueue);
384 c9a24bfb Leszek Koltunski
            }
385
386 61441ce2 Leszek Koltunski
          numRenders += currQueue.postprocess(mBuffer);
387 7266d8ef Leszek Koltunski
          numRenders += blitWithDepth(time, mBuffer[quality]);
388 cee0369a Leszek Koltunski
          GLES31.glMemoryBarrier(GLES31.GL_ALL_BARRIER_BITS);
389
          //GLES31.glFinish();
390 8777ce17 Leszek Koltunski
          numRenders += blitWithDepthRender(time,mBuffer[quality]);  // merge the OIT linked list
391
          clearBuffer(mBuffer[quality]);
392 cee0369a Leszek Koltunski
          GLES31.glMemoryBarrier(GLES31.GL_ALL_BARRIER_BITS);
393
          //GLES31.glFlush();
394 cf7394cc leszek
          }
395 60c1c622 leszek
        }
396 b9798977 leszek
397 70b6a155 Leszek Koltunski
      lastQueue = currQueue;
398
      lastBucket= currBucket;
399 95c441a2 leszek
      }
400 270c27bc Leszek Koltunski
401 39086ebb leszek
    return numRenders;
402
    }
403
404 be60d4ff leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
405
406 26a4e5f6 leszek
  ArrayList<DistortedNode> getChildren()
407 be60d4ff leszek
    {
408 26a4e5f6 leszek
    return mChildren;
409 be60d4ff leszek
    }
410
411 ae2802b1 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
412
/**
413
 * Not part of the Public API.
414
 *
415
 * @y.exclude
416
 */
417
  public float getWidthCorrection()
418
    {
419
    return (float)mWidth/mRealWidth;
420
    }
421
422
///////////////////////////////////////////////////////////////////////////////////////////////////
423
/**
424
 * Not part of the Public API.
425
 *
426
 * @y.exclude
427
 */
428
  public float getHeightCorrection()
429
    {
430
    return (float)mHeight/mRealHeight;
431
    }
432
433 b2939df4 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
434
// PUBLIC API
435 39086ebb leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
436 86e99907 leszek
/**
437
 * Make the library show various debugging information.
438
 * <p>
439
 * Currently only DEBUG_FPS - show FPS in the upper-left corner of every Screen - is defined.
440
 *
441
 * @param bitmask 0, or a bitmask of DEBUG_** flags to enable (currently only DEBUG_FPS defined)
442
 */
443
  public void setDebug(int bitmask)
444
    {
445 26a4e5f6 leszek
    if( this instanceof DistortedScreen )
446
      mDebugLevel = bitmask;
447 86e99907 leszek
    }
448
449
///////////////////////////////////////////////////////////////////////////////////////////////////
450
451 c5369f1b leszek
/**
452 d9706fd2 Leszek Koltunski
 * Draws all the attached children to this OutputSurface.
453 af4cc5db Leszek Koltunski
 * <p>
454
 * Must be called from a thread holding OpenGL Context.
455
 *
456 d9706fd2 Leszek Koltunski
 * @param time Current time, in milliseconds. This will be passed to all the Effects stored in the children Nodes.
457 7691a39f leszek
 * @return Number of objects rendered.
458 c5369f1b leszek
 */
459 b2939df4 Leszek Koltunski
  public int render(long time)
460 af4cc5db Leszek Koltunski
    {
461 26a4e5f6 leszek
    if( mDebugLevel!=0 ) prepareDebug(time);
462 86e99907 leszek
463 c204c69d leszek
    // change tree topology (attach and detach children)
464 889cce10 Leszek Koltunski
/*
465 42571056 Leszek Koltunski
    boolean changed1 =
466 889cce10 Leszek Koltunski
*/
467 efe3d8fe leszek
    DistortedMaster.toDo();
468 eadf0859 leszek
/*
469 42571056 Leszek Koltunski
    if( changed1 )
470 c204c69d leszek
      {
471
      for(int i=0; i<mNumChildren; i++)
472
        {
473 af27df87 leszek
        mChildren.get(i).debug(0);
474 c204c69d leszek
        }
475 af27df87 leszek
476 7691a39f leszek
      DistortedNode.debugMap();
477 c204c69d leszek
      }
478 eadf0859 leszek
*/
479 09ab7524 Leszek Koltunski
    // create and delete all underlying OpenGL resources
480
    // Watch out: FIRST change topology, only then deal
481
    // with OpenGL resources. That's because changing Tree
482
    // can result in additional Framebuffers that would need
483
    // to be created immediately, before the calls to drawRecursive()
484 42571056 Leszek Koltunski
/*
485
    boolean changed2 =
486
*/
487 f8377ef8 leszek
    toDo();
488 eadf0859 leszek
/*
489 42571056 Leszek Koltunski
    if( changed2 )
490 af27df87 leszek
      {
491 226144d0 leszek
      DistortedObject.debugLists();
492 42571056 Leszek Koltunski
      }
493 eadf0859 leszek
*/
494 c834348d leszek
    // mark OpenGL state as unknown
495
    DistortedRenderState.reset();
496 2ed1c692 leszek
497 b2939df4 Leszek Koltunski
    int numRenders=0;
498 7691a39f leszek
499 d9706fd2 Leszek Koltunski
    for(int i=0; i<mNumChildren; i++)
500 af4cc5db Leszek Koltunski
      {
501 b2939df4 Leszek Koltunski
      numRenders += mChildren.get(i).renderRecursive(time);
502 af4cc5db Leszek Koltunski
      }
503 7691a39f leszek
504 070695a5 Leszek Koltunski
    setAsOutput(time);
505 b2939df4 Leszek Koltunski
    numRenders += renderChildren(time,mNumChildren,mChildren);
506
507 26a4e5f6 leszek
    if( mDebugLevel != 0 ) renderDebug(time);
508 b28c6c21 leszek
509 7691a39f leszek
    return numRenders;
510 af4cc5db Leszek Koltunski
    }
511
512
///////////////////////////////////////////////////////////////////////////////////////////////////
513 c5369f1b leszek
/**
514
 * Bind this Surface as a Framebuffer we can render to.
515 02ab6f9d leszek
 *
516
 * @param time Present time, in milliseconds. The point: looking at this param the library can figure
517
 *             out if this is the first time during present frame that this FBO is being set as output.
518
 *             If so, the library, in addition to binding the Surface for output, also clears the
519
 *             Surface's color and depth attachments.
520 c5369f1b leszek
 */
521 95c441a2 leszek
  public void setAsOutput(long time)
522 a436ccc5 leszek
    {
523 e6519ac8 Leszek Koltunski
    GLES31.glBindFramebuffer(GLES31.GL_FRAMEBUFFER, mFBOH[0]);
524 95c441a2 leszek
525
    if( mTime!=time )
526
      {
527
      mTime = time;
528 23eecbd9 Leszek Koltunski
      DistortedRenderState.colorDepthStencilOn();
529 e6519ac8 Leszek Koltunski
      GLES31.glClearColor(mClearR, mClearG, mClearB, mClearA);
530
      GLES31.glClearDepthf(mClearDepth);
531
      GLES31.glClearStencil(mClearStencil);
532
      GLES31.glClear(mClear);
533 144d252c Leszek Koltunski
      DistortedRenderState.colorDepthStencilRestore();
534 95c441a2 leszek
      }
535 a436ccc5 leszek
    }
536 af4cc5db Leszek Koltunski
537 1dfc9074 leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
538
/**
539
 * Bind this Surface as a Framebuffer we can render to.
540
 * <p>
541
 * This version does not attempt to clear anything.
542
 */
543
544
  public void setAsOutput()
545
    {
546 e6519ac8 Leszek Koltunski
    GLES31.glBindFramebuffer(GLES31.GL_FRAMEBUFFER, mFBOH[0]);
547 1dfc9074 leszek
    }
548
549
///////////////////////////////////////////////////////////////////////////////////////////////////
550
/**
551
 * Return the Near plane of the Projection included in the Surface.
552
 *
553
 * @return the Near plane.
554
 */
555
  public float getNear()
556
    {
557
    return mNear;
558
    }
559
560 638b5b5c leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
561
/**
562
 * Set mipmap level.
563
 * <p>
564
 * Trick for speeding up your renders - one can create a pyramid of OutputSurface objects, each next
565
 * one some constant FACTOR smaller than the previous (0.5 is the common value), then set the Mipmap
566
 * Level of the i-th object to be FACTOR^i (we start counting from 0). When rendering any scene into
567
 * such prepared OutputSurface, the library will make sure to scale any Effects used so that the end
568
 * scene will end up looking identical no matter which object we render to. Identical, that is, except
569
 * for the loss of quality and gain in speed associated with rendering to a smaller Surface.
570 8426bd6a Leszek Koltunski
 * <p>
571
 * Example: if you create two FBOs, one 1000x1000 and another 500x500 in size, and set the second one
572
 * mipmap to 0.5 (the first one's is 1.0 by default), define Effects to be a single move by (100,100),
573
 * and render a skinned Mesh into both FBO, the end result will look proportionally the same, because
574
 * in the second case the move vector (100,100) will be auto-scaled to (50,50).
575 638b5b5c leszek
 *
576
 * @param mipmap The mipmap level. Acceptable range: 0&lt;mipmap&lt;infinity, although mipmap&gt;1
577
 *               does not make any sense (that would result in loss of speed and no gain in quality)
578
 */
579
  public void setMipmap(float mipmap)
580
    {
581
    mMipmap = mipmap;
582
    }
583
584 a9f41fa3 leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
585
/**
586 e6519ac8 Leszek Koltunski
 * Set the (R,G,B,A) values of GLES31.glClearColor() to set up color with which to clear
587 ad16ed3b Leszek Koltunski
 * this Surface at the beginning of each frame.
588 a9f41fa3 leszek
 *
589
 * @param r the Red component. Default: 0.0f
590
 * @param g the Green component. Default: 0.0f
591
 * @param b the Blue component. Default: 0.0f
592
 * @param a the Alpha component. Default: 0.0f
593
 */
594
  public void glClearColor(float r, float g, float b, float a)
595
    {
596
    mClearR = r;
597
    mClearG = g;
598
    mClearB = b;
599
    mClearA = a;
600
    }
601
602
///////////////////////////////////////////////////////////////////////////////////////////////////
603
/**
604 23eecbd9 Leszek Koltunski
 * Uses glClearDepthf() to set up a value with which to clear
605
 * the Depth buffer of our Surface at the beginning of each frame.
606 a9f41fa3 leszek
 *
607
 * @param d the Depth. Default: 1.0f
608
 */
609
  public void glClearDepthf(float d)
610
    {
611
    mClearDepth = d;
612
    }
613
614 23eecbd9 Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
615
/**
616
 * Uses glClearStencil() to set up a value with which to clear the
617
 * Stencil buffer of our Surface at the beginning of each frame.
618
 *
619
 * @param s the Stencil. Default: 0
620
 */
621
  public void glClearStencil(int s)
622
    {
623
    mClearStencil = s;
624
    }
625
626 ad16ed3b Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
627
/**
628
 * Which buffers to Clear at the beginning of each frame?
629
 * <p>
630
 * Valid values: 0, or bitwise OR of one or more values from the set GL_COLOR_BUFFER_BIT,
631
 *               GL_DEPTH_BUFFER_BIT, GL_STENCIL_BUFFER_BIT.
632
 * Default: GL_DEPTH_BUFFER_BIT | GL_COLOR_BUFFER_BIT.
633
 *
634
 * @param mask bitwise OR of BUFFER_BITs to clear.
635
 */
636
  public void glClear(int mask)
637
    {
638
    mClear = mask;
639
    }
640
641 af4cc5db Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
642
/**
643
 * Create new Projection matrix.
644
 *
645
 * @param fov Vertical 'field of view' of the Projection frustrum (in degrees).
646 54fe333a leszek
 *            Valid values: 0<=fov<180. FOV==0 means 'parallel projection'.
647
 * @param near Distance between the screen plane and the near plane.
648 61441ce2 Leszek Koltunski
 *             Valid vaules: 0<near<1. When near==0 (illegal!), the Near Plane is exactly at the tip of
649
 *             the pyramid. When near==1 (illegal!) the near plane is equivalent to the screen plane.
650 af4cc5db Leszek Koltunski
 */
651 54fe333a leszek
  public void setProjection(float fov, float near)
652 af4cc5db Leszek Koltunski
    {
653 8069e806 Leszek Koltunski
    if( fov < 180.0f && fov >=0.0f )
654
      {
655
      mFOV = fov;
656
      }
657
658
    if( near<   1.0f && near> 0.0f )
659
      {
660
      mNear= near;
661
      }
662
    else if( near<=0.0f )
663
      {
664
      mNear = 0.01f;
665
      }
666
    else if( near>=1.0f )
667
      {
668
      mNear=0.99f;
669
      }
670 af4cc5db Leszek Koltunski
671 1dfc9074 leszek
    if( mBuffer[0]!=null )
672
      {
673
      for(int j=0; j<EffectQuality.LENGTH; j++) mBuffer[j].mNear = mNear;
674
      }
675
676 af4cc5db Leszek Koltunski
    createProjection();
677
    }
678
679
///////////////////////////////////////////////////////////////////////////////////////////////////
680 c5369f1b leszek
/**
681 af4cc5db Leszek Koltunski
 * Resize the underlying Framebuffer.
682 c7da4e65 leszek
 * <p>
683
 * This method can be safely called mid-render as it doesn't interfere with rendering.
684 af4cc5db Leszek Koltunski
 *
685
 * @param width The new width.
686
 * @param height The new height.
687 c5369f1b leszek
 */
688 af4cc5db Leszek Koltunski
  public void resize(int width, int height)
689
    {
690
    if( mWidth!=width || mHeight!=height )
691
      {
692 a4b182d4 Leszek Koltunski
      mWidth = mRealWidth = width;
693
      mHeight= mRealHeight= height;
694 f8377ef8 leszek
695
      createProjection();
696
697 c7da4e65 leszek
      if( mColorCreated==CREATED )
698 f8377ef8 leszek
        {
699 f28fffc2 Leszek Koltunski
        markForCreation();
700 f8377ef8 leszek
        recreate();
701
        }
702 af4cc5db Leszek Koltunski
      }
703
    }
704 a09ada4c Leszek Koltunski
705 a436ccc5 leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
706
/**
707 89de975c leszek
 * Return true if the Surface contains a DEPTH attachment.
708 a436ccc5 leszek
 *
709 89de975c leszek
 * @return <bold>true</bold> if the Surface contains a DEPTH attachment.
710 a436ccc5 leszek
 */
711 89de975c leszek
  public boolean hasDepth()
712 a436ccc5 leszek
    {
713 89de975c leszek
    return mDepthStencilCreated==CREATED;
714 a436ccc5 leszek
    }
715
716
///////////////////////////////////////////////////////////////////////////////////////////////////
717
/**
718 89de975c leszek
 * Return true if the Surface contains a STENCIL attachment.
719 a436ccc5 leszek
 *
720 89de975c leszek
 * @return <bold>true</bold> if the Surface contains a STENCIL attachment.
721 a436ccc5 leszek
 */
722 89de975c leszek
  public boolean hasStencil()
723 a436ccc5 leszek
    {
724 89de975c leszek
    return (mDepthStencilCreated==CREATED && mDepthStencil==BOTH_DEPTH_STENCIL);
725 a436ccc5 leszek
    }
726
727 a09ada4c Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
728
/**
729
 * Adds a new child to the last position in the list of our Surface's children.
730 c204c69d leszek
 * <p>
731
 * We cannot do this mid-render - actual attachment will be done just before the next render, by the
732 efe3d8fe leszek
 * DistortedMaster (by calling doWork())
733 a09ada4c Leszek Koltunski
 *
734
 * @param node The new Node to add.
735
 */
736 c204c69d leszek
  public void attach(DistortedNode node)
737 a09ada4c Leszek Koltunski
    {
738 ffbe7ecf Leszek Koltunski
    mJobs.add(new Job(ATTACH,node));
739 efe3d8fe leszek
    DistortedMaster.newSlave(this);
740 a09ada4c Leszek Koltunski
    }
741
742
///////////////////////////////////////////////////////////////////////////////////////////////////
743
/**
744
 * Adds a new child to the last position in the list of our Surface's children.
745 c204c69d leszek
 * <p>
746
 * We cannot do this mid-render - actual attachment will be done just before the next render, by the
747 efe3d8fe leszek
 * DistortedMaster (by calling doWork())
748 a09ada4c Leszek Koltunski
 *
749
 * @param surface InputSurface to initialize our child Node with.
750
 * @param effects DistortedEffects to initialize our child Node with.
751
 * @param mesh MeshObject to initialize our child Node with.
752
 * @return the newly constructed child Node, or null if we couldn't allocate resources.
753
 */
754 c204c69d leszek
  public DistortedNode attach(DistortedInputSurface surface, DistortedEffects effects, MeshObject mesh)
755 a09ada4c Leszek Koltunski
    {
756
    DistortedNode node = new DistortedNode(surface,effects,mesh);
757 ffbe7ecf Leszek Koltunski
    mJobs.add(new Job(ATTACH,node));
758 efe3d8fe leszek
    DistortedMaster.newSlave(this);
759 c204c69d leszek
    return node;
760
    }
761
762 af27df87 leszek
///////////////////////////////////////////////////////////////////////////////////////////////////
763
/**
764
 * Removes the first occurrence of a specified child from the list of children of our Surface.
765
 * <p>
766
 * A bit questionable method as there can be many different Nodes attached as children, some
767
 * of them having the same Effects but - for instance - different Mesh. Use with care.
768
 * <p>
769
 * We cannot do this mid-render - actual detachment will be done just before the next render, by the
770 efe3d8fe leszek
 * DistortedMaster (by calling doWork())
771 af27df87 leszek
 *
772
 * @param effects DistortedEffects to remove.
773
 */
774
  public void detach(DistortedEffects effects)
775
    {
776
    long id = effects.getID();
777
    DistortedNode node;
778 8baa1fe6 Leszek Koltunski
    boolean detached = false;
779 af27df87 leszek
780
    for(int i=0; i<mNumChildren; i++)
781
      {
782
      node = mChildren.get(i);
783
784
      if( node.getEffects().getID()==id )
785
        {
786 8baa1fe6 Leszek Koltunski
        detached = true;
787 ffbe7ecf Leszek Koltunski
        mJobs.add(new Job(DETACH,node));
788 efe3d8fe leszek
        DistortedMaster.newSlave(this);
789 af27df87 leszek
        break;
790
        }
791
      }
792 8baa1fe6 Leszek Koltunski
793
    if( !detached )
794
      {
795
      // if we failed to detach any, it still might be the case that
796 efe3d8fe leszek
      // there's an ATTACH job that we need to cancel.
797
      int num = mJobs.size();
798
      Job job;
799
800
      for(int i=0; i<num; i++)
801
        {
802
        job = mJobs.get(i);
803
804
        if( job.type==ATTACH && job.node.getEffects()==effects )
805
          {
806
          mJobs.remove(i);
807
          break;
808
          }
809
        }
810 8baa1fe6 Leszek Koltunski
      }
811 af27df87 leszek
    }
812
813 a09ada4c Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
814
/**
815
 * Removes the first occurrence of a specified child from the list of children of our Surface.
816 c204c69d leszek
 * <p>
817
 * We cannot do this mid-render - actual attachment will be done just before the next render, by the
818 efe3d8fe leszek
 * DistortedMaster (by calling doWork())
819 c204c69d leszek
 *
820
 * @param node The Node to remove.
821
 */
822
  public void detach(DistortedNode node)
823
    {
824 ffbe7ecf Leszek Koltunski
    mJobs.add(new Job(DETACH,node));
825 efe3d8fe leszek
    DistortedMaster.newSlave(this);
826 a09ada4c Leszek Koltunski
    }
827
828
///////////////////////////////////////////////////////////////////////////////////////////////////
829
/**
830
 * Removes all children Nodes.
831 c204c69d leszek
 * <p>
832
 * We cannot do this mid-render - actual attachment will be done just before the next render, by the
833 efe3d8fe leszek
 * DistortedMaster (by calling doWork())
834 c204c69d leszek
 */
835
  public void detachAll()
836
    {
837 ffbe7ecf Leszek Koltunski
    mJobs.add(new Job(DETALL,null));
838 efe3d8fe leszek
    DistortedMaster.newSlave(this);
839 c204c69d leszek
    }
840
841
///////////////////////////////////////////////////////////////////////////////////////////////////
842
/**
843
 * This is not really part of the public API. Has to be public only because it is a part of the
844 efe3d8fe leszek
 * DistortedSlave interface, which should really be a class that we extend here instead but
845 c204c69d leszek
 * Java has no multiple inheritance.
846 43fbf0dd leszek
 *
847
 * @y.exclude
848 a09ada4c Leszek Koltunski
 */
849 efe3d8fe leszek
  public void doWork()
850 a09ada4c Leszek Koltunski
    {
851 efe3d8fe leszek
    int num = mJobs.size();
852
    Job job;
853
854
    for(int i=0; i<num; i++)
855
      {
856
      job = mJobs.remove(0);
857
858
      switch(job.type)
859
        {
860 be60d4ff leszek
        case ATTACH: if( mChildren==null ) mChildren = new ArrayList<>(2);
861
                     job.node.setSurfaceParent(this);
862
                     DistortedMaster.addSorted(mChildren,job.node);
863 efe3d8fe leszek
                     mNumChildren++;
864
                     break;
865 be60d4ff leszek
        case DETACH: if( mNumChildren>0 && mChildren.remove(job.node) )
866 efe3d8fe leszek
                       {
867 be60d4ff leszek
                       job.node.setSurfaceParent(null);
868 efe3d8fe leszek
                       mNumChildren--;
869
                       }
870
                     break;
871 be60d4ff leszek
        case DETALL: if( mNumChildren>0 )
872 efe3d8fe leszek
                       {
873 be60d4ff leszek
                       DistortedNode tmp;
874
875
                       for(int j=mNumChildren-1; j>=0; j--)
876
                         {
877
                         tmp = mChildren.remove(j);
878
                         tmp.setSurfaceParent(null);
879
                         }
880
881 efe3d8fe leszek
                       mNumChildren = 0;
882
                       }
883
                     break;
884 ffbe7ecf Leszek Koltunski
        case SORT  : mChildren.remove(job.node);
885 be60d4ff leszek
                     DistortedMaster.addSorted(mChildren,job.node);
886 efe3d8fe leszek
                     break;
887
        }
888
      }
889 a09ada4c Leszek Koltunski
    }
890 af4cc5db Leszek Koltunski
}