Fix renderer test case batching (#2291)

* Ensure sprites using the same custom shader are batched

* Fix for incorrect ProgramId check

* Enhance check for valid batch ID

* Use method name that indicates purpose

Author: rh101

core/renderer/TrianglesCommand.cpp

@@ -68,7 +68,7 @@ void TrianglesCommand::init(float globalOrder,
         blendDescriptor.sourceRGBBlendFactor = blendDescriptor.sourceAlphaBlendFactor = blendType.src;
         blendDescriptor.destinationRGBBlendFactor = blendDescriptor.destinationAlphaBlendFactor = blendType.dst;
 
-        if (_batchId == -1)
+        if (!_pipelineDescriptor.programState->isBatchable())
             setSkipBatching(true);
 
         if (!isSkipBatching())

core/renderer/backend/Program.h

@@ -152,7 +152,7 @@ class AX_DLL Program : public Object
      * Get program id.
      * @return The program id.
      */
-    int64_t getProgramId() const { return _programId; }
+    uint64_t getProgramId() const { return _programId; }
 
     /**
      * Get uniform buffer size in bytes that can hold all the uniforms.

core/renderer/backend/ProgramManager.h

@@ -157,9 +157,9 @@ class AX_DLL ProgramManager
     };
 
     BuiltinRegInfo _builtinRegistry[(int)backend::ProgramType::BUILTIN_COUNT];
-    std::unordered_map<int64_t, BuiltinRegInfo> _customRegistry;
+    std::unordered_map<uint64_t, BuiltinRegInfo> _customRegistry;
 
-    std::unordered_map<int64_t, Program*> _cachedPrograms;  ///< The cached program object.
+    std::unordered_map<uint64_t, Program*> _cachedPrograms;  ///< The cached program object.
 
     XXH64_state_s* _programIdGen;
 

core/renderer/backend/ProgramState.cpp

@@ -175,14 +175,18 @@ bool ProgramState::init(Program* program)
 
     const auto programId = program->getProgramId();
     if (programId < ProgramType::BUILTIN_COUNT)
+    {
         this->_batchId = programId;
+        this->_isBatchable = true;
+    }
 
     return true;
 }
 
 void ProgramState::updateBatchId()
 {
     _batchId = XXH64(_uniformBuffers.data(), _uniformBuffers.size(), _program->getProgramId());
+    _isBatchable = true;
 }
 
 void ProgramState::resetUniforms()
@@ -229,6 +233,7 @@ ProgramState* ProgramState::clone() const
     cp->_vertexLayout    = !_ownVertexLayout ? _vertexLayout : new VertexLayout(*_vertexLayout);
 
     cp->_batchId = this->_batchId;
+    cp->_isBatchable = this->_isBatchable;
     return cp;
 }
 

core/renderer/backend/ProgramState.h

@@ -301,6 +301,11 @@ class AX_DLL ProgramState : public Object
     */
     uint64_t getBatchId() const { return _batchId; };
 
+    /*
+     * Gets the state of the batch ID. If true, then batch ID is valid
+     */
+    bool isBatchable() const { return _isBatchable; };
+
     /*
     * Update batchID of current program state, by default, custom program was traits with mutable uniforms
     * so batch ID was set to -1 indicate batch was disabled
@@ -399,7 +404,8 @@ class AX_DLL ProgramState : public Object
     VertexLayout* _vertexLayout = nullptr;
     bool _ownVertexLayout       = false;
 
-    uint64_t _batchId = -1;
+    uint64_t _batchId    = -1;
+    bool _isBatchable = false;
 
 #if AX_ENABLE_CACHE_TEXTURE_DATA
     EventListenerCustom* _backToForegroundListener = nullptr;

tests/cpp-tests/Source/NewRendererTest/NewRendererTest.cpp

@@ -824,7 +824,9 @@ RendererUniformBatch::RendererUniformBatch()
     Size s = Director::getInstance()->getWinSize();
 
     auto blurState  = createBlurProgramState();
+    blurState->updateBatchId();
     auto sepiaState = createSepiaProgramState();
+    sepiaState->updateBatchId();
 
     auto x_inc = s.width / 20;
     auto y_inc = s.height / 6;
@@ -896,8 +898,10 @@ RendererUniformBatch2::RendererUniformBatch2()
 {
     Size s = Director::getInstance()->getWinSize();
 
-    auto blurState  = createBlurProgramState();
+    auto blurState = createBlurProgramState();
+    blurState->updateBatchId();
     auto sepiaState = createSepiaProgramState();
+    sepiaState->updateBatchId();
 
     auto x_inc = s.width / 20;
     auto y_inc = s.height / 6;