[#187] API changes to render pipeline to avoid creation of frame buffers, closes #187

Author: bitbrain

CHANGELOG.md

@@ -1,3 +1,10 @@
+# Version 0.5.5
+
+* [[#187](https://github.com/bitbrain/braingdx/issues/187)] do not create frame buffers when no shaders are being used
+* remove `RenderPipeline.getPipe` method
+* add `RenderPipeline.addEffects` method
+* add `RenderPipe.hasEffects` method
+
 # Version 0.5.4
 
 * [[#185](https://github.com/bitbrain/braingdx/issues/185)] add new `setDistanceStoppingThreshold` method to `GameCamera` which allows defining a threshold to avoid flickering

core/src/main/java/de/bitbrain/braingdx/graphics/pipeline/CombinedRenderPipe.java

@@ -59,9 +59,16 @@ public void setEffects(PostProcessorEffect[] effects) {
       batchPostProcessor.addEffects(effects);
    }
 
+   @Override
+   public boolean hasEffects() {
+      return batchPostProcessor.hasEffects();
+   }
+
    public void render(Batch batch, float delta, FrameBuffer buffer) {
       if (isEnabled()) {
-         if (batchPostProcessor.hasEffects()) {
+         if (buffer == null) {
+            layer.render(batch, delta);
+         } else if (batchPostProcessor.hasEffects()) {
             batchPostProcessor.begin();
             this.batch.begin();
             this.batch.draw(buffer.getColorBufferTexture(), 0f, 0f);

core/src/main/java/de/bitbrain/braingdx/graphics/pipeline/CombinedRenderPipeline.java

@@ -59,6 +59,9 @@ public class CombinedRenderPipeline implements RenderPipeline {
    private final SpriteBatch internalBatch;
    private FrameBuffer buffer;
    private OrthographicCamera camera;
+   private boolean hasEffects;
+   private int bufferWidth;
+   private int bufferHeight;
 
    public CombinedRenderPipeline(ShaderConfig config, SpriteBatch internalBatch, OrthographicCamera camera) {
       this(config, new PostProcessor(true, true, isDesktop), new FrameBufferFactory() {
@@ -114,14 +117,16 @@ public void resize(int width, int height) {
       if (buffer != null) {
          buffer.dispose();
       }
-      buffer = bufferFactory.create(width, height);
+      this.bufferWidth = width;
+      this.bufferHeight = height;
       camera.setToOrtho(true, width, height);
    }
 
    @Override
    public void put(String id, RenderLayer layer, PostProcessorEffect... effects) {
       CombinedRenderPipe pipe = new CombinedRenderPipe(layer, processor, internalBatch, effects);
       orderedPipes.put(id, pipe);
+      this.hasEffects = hasEffects || effects.length > 0;
    }
 
    @Override
@@ -132,6 +137,7 @@ public void putAfter(String existing, String id, RenderLayer layer, PostProcesso
          return;
       }
       orderedPipes.put(index + 1, id, new CombinedRenderPipe(layer, processor, internalBatch, effects));
+      this.hasEffects = hasEffects || effects.length > 0;
    }
 
    @Override
@@ -142,6 +148,7 @@ public void putBefore(String existing, String id, RenderLayer layer, PostProcess
          return;
       }
       orderedPipes.put(index > 0 ? index - 1 : index, id, new CombinedRenderPipe(layer, processor, internalBatch, effects));
+      this.hasEffects = hasEffects || effects.length > 0;
    }
 
    @Override
@@ -152,6 +159,13 @@ public void remove(String existingSourceId) {
          return;
       }
       orderedPipes.remove(existingSourceId);
+      for (Object o : orderedPipes.valueList()) {
+         CombinedRenderPipe pipe = (CombinedRenderPipe)o;
+         if (pipe.hasEffects()) {
+            return;
+         }
+      }
+      this.hasEffects = false;
    }
 
    @Override
@@ -162,6 +176,7 @@ public void setEffects(String existingSourceId, PostProcessorEffect... effects)
          return;
       }
       getPipe(existingSourceId).setEffects(effects);
+      orderedPipes.remove(existingSourceId);
    }
 
    @Override
@@ -200,8 +215,12 @@ public void moveAfter(String existingSourceId, String existingTargetId) {
    }
 
    @Override
-   public RenderPipe getPipe(String id) {
-      return (RenderPipe) (orderedPipes.containsKey(id) ? orderedPipes.get(id) : null);
+   public void addEffects(String existingSourceId, PostProcessorEffect... effects) {
+      RenderPipe pipe = getPipe(existingSourceId);
+      if (pipe != null) {
+         pipe.addEffects(effects);
+         this.hasEffects = hasEffects || effects.length > 0;
+      }
    }
 
    @SuppressWarnings("unchecked")
@@ -213,19 +232,24 @@ public Collection<String> getPipeIds() {
    @SuppressWarnings("unchecked")
    @Override
    public void render(Batch batch, float delta) {
-      if (buffer == null) {
-         return;
+      if (buffer == null && hasEffects) {
+         buffer = bufferFactory.create(this.bufferWidth, this.bufferHeight);
+      } else if (buffer != null && !hasEffects) {
+         buffer.dispose();
+         buffer = null;
       }
       clearBuffer();
       for (CombinedRenderPipe pipe : (Collection<CombinedRenderPipe>) orderedPipes.values()) {
          pipe.beforeRender();
          pipe.render(batch, delta, buffer);
       }
-      internalBatch.setProjectionMatrix(camera.combined);
-      internalBatch.begin();
-      internalBatch.setColor(Color.WHITE);
-      internalBatch.draw(buffer.getColorBufferTexture(), 0f, 0f);
-      internalBatch.end();
+      if (hasEffects) {
+         internalBatch.setProjectionMatrix(camera.combined);
+         internalBatch.begin();
+         internalBatch.setColor(Color.WHITE);
+         internalBatch.draw(buffer.getColorBufferTexture(), 0f, 0f);
+         internalBatch.end();
+      }
    }
 
    private void clearBuffer() {
@@ -236,4 +260,8 @@ private void clearBuffer() {
          buffer.end();
       }
    }
+
+   private RenderPipe getPipe(String id) {
+      return (RenderPipe) (orderedPipes.containsKey(id) ? orderedPipes.get(id) : null);
+   }
 }

core/src/main/java/de/bitbrain/braingdx/graphics/pipeline/LayeredRenderPipe.java

@@ -84,6 +84,11 @@ public void setEffects(PostProcessorEffect[] effects) {
       batchPostProcessor.addEffects(effects);
    }
 
+   @Override
+   public boolean hasEffects() {
+      return batchPostProcessor.hasEffects();
+   }
+
    @Override
    public void dispose() {
       buffer.dispose();

core/src/main/java/de/bitbrain/braingdx/graphics/pipeline/LayeredRenderPipeline.java

@@ -105,8 +105,8 @@ public void moveAfter(String existingSourceId, String existingTargetId) {
    }
 
    @Override
-   public RenderPipe getPipe(String id) {
-      return pipes.get(id);
+   public void addEffects(String existingSourceId, PostProcessorEffect... effects) {
+      throw new UnsupportedOperationException("Not implemented yet!");
    }
 
    @Override

core/src/main/java/de/bitbrain/braingdx/graphics/pipeline/RenderPipe.java

@@ -31,4 +31,6 @@ public interface RenderPipe {
    void addEffects(PostProcessorEffect... effects);
 
    void setEffects(PostProcessorEffect[] effects);
+
+   boolean hasEffects();
 }

core/src/main/java/de/bitbrain/braingdx/graphics/pipeline/RenderPipeline.java

@@ -17,6 +17,7 @@
 import com.badlogic.gdx.graphics.g2d.Batch;
 import com.badlogic.gdx.utils.Disposable;
 import de.bitbrain.braingdx.graphics.postprocessing.PostProcessorEffect;
+import de.bitbrain.braingdx.graphics.postprocessing.filters.CrtScreen;
 import de.bitbrain.braingdx.util.Resizeable;
 
 import java.util.Collection;
@@ -95,7 +96,7 @@ public interface RenderPipeline extends Disposable, Resizeable {
     * @param existingSourceId an existing layer
     * @return an existing {@link RenderPipe}
     */
-   RenderPipe getPipe(String existingSourceId);
+   void addEffects(String existingSourceId, PostProcessorEffect... effects);
 
    /**
     * Returns an ordered collection of all registered layers

core/src/test/java/de/bitbrain/braingdx/graphics/pipeline/RenderPipelineTest.java

@@ -51,7 +51,7 @@ public void beforeTest() {
    public void testAddLayer() {
       final String id = "my-id";
       pipeline.put(id, mock(RenderLayer.class));
-      assertThat(pipeline.getPipe(id)).isNotNull();
+      assertThat(pipeline.getPipeIds()).contains("my-id");
    }
 
    @Test