Refactor shader program cache

When multiple targets stamp, one of them might use the wrong shader program (with uniforms set by another target).

Author: adazem009

src/renderedtarget.cpp

@@ -546,7 +546,7 @@ void RenderedTarget::render(double scale) const
     ShaderManager *shaderManager = ShaderManager::instance();
 
     if (!m_shaderProgram) {
-        m_shaderProgram = shaderManager->getShaderProgram(m_graphicEffects);
+        m_shaderProgram = shaderManager->getShaderProgram(this, m_graphicEffects);
         Q_ASSERT(m_shaderProgram);
         Q_ASSERT(m_shaderProgram->isLinked());
 

src/shadermanager.cpp

@@ -97,7 +97,7 @@ ShaderManager *ShaderManager::instance()
     return globalInstance;
 }
 
-QOpenGLShaderProgram *ShaderManager::getShaderProgram(const std::unordered_map<Effect, double> &effectValues)
+QOpenGLShaderProgram *ShaderManager::getShaderProgram(const IRenderedTarget *target, const std::unordered_map<Effect, double> &effectValues)
 {
     int effectBits = 0;
     bool firstSet = false;
@@ -115,11 +115,24 @@ QOpenGLShaderProgram *ShaderManager::getShaderProgram(const std::unordered_map<E
         QOpenGLShaderProgram *program = createShaderProgram(effectValues);
 
         if (program)
-            m_shaderPrograms[effectBits] = program;
+            m_shaderPrograms[effectBits] = { { target, program } };
 
         return program;
-    } else
-        return it->second;
+    } else {
+        const auto &map = it->second;
+        auto it = map.find(target);
+
+        if (it == map.cend()) {
+            // Create a new shader program if this combination doesn't exist for the given target
+            QOpenGLShaderProgram *program = createShaderProgram(effectValues);
+
+            if (program)
+                m_shaderPrograms[effectBits][target] = program;
+
+            return program;
+        } else
+            return it->second;
+    }
 }
 
 void ShaderManager::getUniformValuesForEffects(const std::unordered_map<Effect, double> &effectValues, std::unordered_map<Effect, float> &dst)

src/shadermanager.h

@@ -12,6 +12,8 @@ class QOpenGLShader;
 namespace scratchcpprender
 {
 
+class IRenderedTarget;
+
 class ShaderManager : public QObject
 {
     public:
@@ -31,7 +33,7 @@ class ShaderManager : public QObject
 
         static ShaderManager *instance();
 
-        QOpenGLShaderProgram *getShaderProgram(const std::unordered_map<Effect, double> &effectValues);
+        QOpenGLShaderProgram *getShaderProgram(const IRenderedTarget *target, const std::unordered_map<Effect, double> &effectValues);
         static void getUniformValuesForEffects(const std::unordered_map<Effect, double> &effectValues, std::unordered_map<Effect, float> &dst);
         static void setUniforms(QOpenGLShaderProgram *program, int textureUnit, const QSize skinSize, const std::unordered_map<Effect, double> &effectValues);
 
@@ -52,7 +54,7 @@ class ShaderManager : public QObject
         static std::unordered_set<Effect> m_effects;
 
         QOpenGLShader *m_vertexShader = nullptr;
-        std::unordered_map<int, QOpenGLShaderProgram *> m_shaderPrograms;
+        std::unordered_map<int, std::unordered_map<const IRenderedTarget *, QOpenGLShaderProgram *>> m_shaderPrograms;
         QByteArray m_fragmentShaderSource;
 };
 

src/targetpainter.cpp

@@ -62,7 +62,7 @@ void TargetPainter::paint(QNanoPainter *painter)
     ShaderManager *shaderManager = ShaderManager::instance();
 
     const auto &effects = m_target->graphicEffects();
-    QOpenGLShaderProgram *shaderProgram = shaderManager->getShaderProgram(effects);
+    QOpenGLShaderProgram *shaderProgram = shaderManager->getShaderProgram(m_target, effects);
     Q_ASSERT(shaderProgram);
     Q_ASSERT(shaderProgram->isLinked());
 

test/shadermanager/CMakeLists.txt

@@ -6,8 +6,11 @@ add_executable(
 target_link_libraries(
   shadermanager_test
   GTest::gtest_main
+  GTest::gmock_main
   scratchcpp
   scratchcpp-render
+  scratchcpprender_mocks
+  qnanopainter
   ${QT_LIBS}
 )
 

test/shadermanager/shadermanager_test.cpp

@@ -6,6 +6,7 @@
 #include <scratchcpp/scratchconfiguration.h>
 #include <shadermanager.h>
 #include <graphicseffect.h>
+#include <renderedtargetmock.h>
 
 #include "../common.h"
 
@@ -34,6 +35,7 @@ class ShaderManagerTest : public testing::Test
 
         QOpenGLContext m_context;
         QOffscreenSurface m_surface;
+        RenderedTargetMock m_target;
 };
 
 TEST_F(ShaderManagerTest, RegisteredEffects)
@@ -71,7 +73,7 @@ TEST_F(ShaderManagerTest, GetShaderProgram)
     ShaderManager manager;
     const std::unordered_map<ShaderManager::Effect, double> effects = { { ShaderManager::Effect::Color, 64.9 }, { ShaderManager::Effect::Ghost, 12.5 } };
 
-    QOpenGLShaderProgram *program = manager.getShaderProgram(effects);
+    QOpenGLShaderProgram *program = manager.getShaderProgram(&m_target, effects);
     ASSERT_EQ(program->parent(), &manager);
     ASSERT_TRUE(program->isLinked());
 
@@ -83,21 +85,36 @@ TEST_F(ShaderManagerTest, GetShaderProgram)
     ASSERT_EQ(frag->shaderType(), QOpenGLShader::Fragment);
 
     // Test shader program cache
-    program = manager.getShaderProgram(effects);
+    program = manager.getShaderProgram(&m_target, effects);
     ASSERT_EQ(program, program);
 
-    program = manager.getShaderProgram(effects);
+    program = manager.getShaderProgram(&m_target, effects);
     ASSERT_EQ(program, program);
 }
 
+TEST_F(ShaderManagerTest, GetShaderProgram_AnotherTarget)
+{
+    ShaderManager manager;
+    const std::unordered_map<ShaderManager::Effect, double> effects = { { ShaderManager::Effect::Color, 64.9 }, { ShaderManager::Effect::Ghost, 12.5 } };
+
+    QOpenGLShaderProgram *program = manager.getShaderProgram(&m_target, effects);
+
+    RenderedTargetMock anotherTarget;
+    QOpenGLShaderProgram *anotherProgram = manager.getShaderProgram(&anotherTarget, effects);
+    ASSERT_NE(anotherProgram, nullptr);
+    ASSERT_NE(anotherProgram, program);
+
+    ASSERT_EQ(manager.getShaderProgram(&anotherTarget, effects), anotherProgram);
+}
+
 TEST_F(ShaderManagerTest, SetUniforms)
 {
     QOpenGLFunctions glF(&m_context);
     glF.initializeOpenGLFunctions();
     ShaderManager manager;
 
     std::unordered_map<ShaderManager::Effect, double> effects = { { ShaderManager::Effect::Color, 64.9 }, { ShaderManager::Effect::Ghost, 12.5 } };
-    QOpenGLShaderProgram *program = manager.getShaderProgram(effects);
+    QOpenGLShaderProgram *program = manager.getShaderProgram(&m_target, effects);
     program->bind();
     manager.setUniforms(program, 4, QSize(), effects);
 
@@ -130,7 +147,7 @@ TEST_F(ShaderManagerTest, ColorEffectValue)
 
     // In range
     std::unordered_map<ShaderManager::Effect, double> effects = { { effect, 64.9 } };
-    QOpenGLShaderProgram *program = manager.getShaderProgram(effects);
+    QOpenGLShaderProgram *program = manager.getShaderProgram(&m_target, effects);
     program->bind();
     manager.setUniforms(program, 0, QSize(), effects);
     manager.getUniformValuesForEffects(effects, values);
@@ -142,7 +159,7 @@ TEST_F(ShaderManagerTest, ColorEffectValue)
 
     // Below the minimum
     effects[effect] = -395.7;
-    program = manager.getShaderProgram(effects);
+    program = manager.getShaderProgram(&m_target, effects);
     program->bind();
     manager.setUniforms(program, 0, QSize(), effects);
     manager.getUniformValuesForEffects(effects, values);
@@ -154,7 +171,7 @@ TEST_F(ShaderManagerTest, ColorEffectValue)
 
     // Above the maximum
     effects[effect] = 579.05;
-    program = manager.getShaderProgram(effects);
+    program = manager.getShaderProgram(&m_target, effects);
     program->bind();
     manager.setUniforms(program, 0, QSize(), effects);
     manager.getUniformValuesForEffects(effects, values);
@@ -181,7 +198,7 @@ TEST_F(ShaderManagerTest, BrightnessEffectValue)
 
     // In range
     std::unordered_map<ShaderManager::Effect, double> effects = { { effect, 4.6 } };
-    QOpenGLShaderProgram *program = manager.getShaderProgram(effects);
+    QOpenGLShaderProgram *program = manager.getShaderProgram(&m_target, effects);
     program->bind();
     manager.setUniforms(program, 0, QSize(), effects);
     manager.getUniformValuesForEffects(effects, values);
@@ -193,7 +210,7 @@ TEST_F(ShaderManagerTest, BrightnessEffectValue)
 
     // Below the minimum
     effects[effect] = -102.9;
-    program = manager.getShaderProgram(effects);
+    program = manager.getShaderProgram(&m_target, effects);
     program->bind();
     manager.setUniforms(program, 0, QSize(), effects);
     manager.getUniformValuesForEffects(effects, values);
@@ -205,7 +222,7 @@ TEST_F(ShaderManagerTest, BrightnessEffectValue)
 
     // Above the maximum
     effects[effect] = 353.2;
-    program = manager.getShaderProgram(effects);
+    program = manager.getShaderProgram(&m_target, effects);
     program->bind();
     manager.setUniforms(program, 0, QSize(), effects);
     manager.getUniformValuesForEffects(effects, values);
@@ -232,7 +249,7 @@ TEST_F(ShaderManagerTest, GhostEffectValue)
 
     // In range
     std::unordered_map<ShaderManager::Effect, double> effects = { { effect, 58.5 } };
-    QOpenGLShaderProgram *program = manager.getShaderProgram(effects);
+    QOpenGLShaderProgram *program = manager.getShaderProgram(&m_target, effects);
     program->bind();
     manager.setUniforms(program, 0, QSize(), effects);
     manager.getUniformValuesForEffects(effects, values);
@@ -281,7 +298,7 @@ TEST_F(ShaderManagerTest, FisheyeEffectValue)
 
     // In range
     std::unordered_map<ShaderManager::Effect, double> effects = { { effect, 58.5 } };
-    QOpenGLShaderProgram *program = manager.getShaderProgram(effects);
+    QOpenGLShaderProgram *program = manager.getShaderProgram(&m_target, effects);
     program->bind();
     manager.setUniforms(program, 0, QSize(), effects);
     manager.getUniformValuesForEffects(effects, values);
@@ -329,7 +346,7 @@ TEST_F(ShaderManagerTest, WhirlEffectValue)
 
     // In range
     std::unordered_map<ShaderManager::Effect, double> effects = { { effect, 58.5 } };
-    QOpenGLShaderProgram *program = manager.getShaderProgram(effects);
+    QOpenGLShaderProgram *program = manager.getShaderProgram(&m_target, effects);
     program->bind();
     manager.setUniforms(program, 0, QSize(), effects);
     manager.getUniformValuesForEffects(effects, values);
@@ -366,7 +383,7 @@ TEST_F(ShaderManagerTest, PixelateEffectValue)
 
     // In range
     std::unordered_map<ShaderManager::Effect, double> effects = { { effect, 58.5 } };
-    QOpenGLShaderProgram *program = manager.getShaderProgram(effects);
+    QOpenGLShaderProgram *program = manager.getShaderProgram(&m_target, effects);
     program->bind();
     manager.setUniforms(program, 0, QSize(), effects);
     manager.getUniformValuesForEffects(effects, values);
@@ -403,7 +420,7 @@ TEST_F(ShaderManagerTest, MosaicEffectValue)
 
     // In range
     std::unordered_map<ShaderManager::Effect, double> effects = { { effect, 58.5 } };
-    QOpenGLShaderProgram *program = manager.getShaderProgram(effects);
+    QOpenGLShaderProgram *program = manager.getShaderProgram(&m_target, effects);
     program->bind();
     manager.setUniforms(program, 0, QSize(), effects);
     manager.getUniformValuesForEffects(effects, values);