Render state cache: added logging level control (API252009)

Author: TheMostDiligent

Graphics/GraphicsEngine/interface/APIInfo.h

@@ -30,7 +30,7 @@
 /// \file
 /// Diligent API information
 
-#define DILIGENT_API_VERSION 252008
+#define DILIGENT_API_VERSION 252009
 
 #include "../../../Primitives/interface/BasicTypes.h"
 

Graphics/GraphicsTools/interface/RenderStateCache.h

@@ -33,15 +33,31 @@
 
 DILIGENT_BEGIN_NAMESPACE(Diligent)
 
+// clang-format off
+
+/// Render state cache logging level.
+DILIGENT_TYPED_ENUM(RENDER_STATE_CACHE_LOG_LEVEL, Uint8)
+{
+    /// Logging is disabled.
+    RENDER_STATE_CACHE_LOG_LEVEL_DISABLED,
+
+    /// Normal logging level.
+    RENDER_STATE_CACHE_LOG_LEVEL_NORMAL,
+
+    /// Verbose logging level.
+    RENDER_STATE_CACHE_LOG_LEVEL_VERBOSE
+};
+
+// clang-format on
+
 /// Render state cache create information.
 struct RenderStateCacheCreateInfo
 {
     /// A pointer to the render device, must not be null.
     IRenderDevice* pDevice DEFAULT_INITIALIZER(nullptr);
 
-    /// Whether to log the cache usage events such as
-    /// if the object was found in the cache or not.
-    bool EnableLogging DEFAULT_INITIALIZER(false);
+    /// Logging level, see Diligent::RENDER_STATE_CACHE_LOG_LEVEL.
+    RENDER_STATE_CACHE_LOG_LEVEL LogLevel DEFAULT_INITIALIZER(RENDER_STATE_CACHE_LOG_LEVEL_NORMAL);
 
     /// Whether to enable hot shader and pipeline state reloading.
     ///
@@ -59,11 +75,11 @@ struct RenderStateCacheCreateInfo
 
     constexpr explicit RenderStateCacheCreateInfo(
         IRenderDevice*                   _pDevice,
-        bool                             _EnableLogging   = RenderStateCacheCreateInfo{}.EnableLogging,
+        RENDER_STATE_CACHE_LOG_LEVEL     _LogLevel        = RenderStateCacheCreateInfo{}.LogLevel,
         bool                             _EnableHotReload = RenderStateCacheCreateInfo{}.EnableHotReload,
         IShaderSourceInputStreamFactory* _pReloadSource   = RenderStateCacheCreateInfo{}.pReloadSource) noexcept :
         pDevice{_pDevice},
-        EnableLogging{_EnableLogging},
+        LogLevel{_LogLevel},
         EnableHotReload{_EnableHotReload},
         pReloadSource{_pReloadSource}
     {}

Graphics/GraphicsTools/src/RenderStateCache.cpp

@@ -508,10 +508,10 @@ RenderStateCacheImpl::RenderStateCacheImpl(IReferenceCounters*               pRe
         LOG_ERROR_AND_THROW("Failed to create dearchiver");
 }
 
-#define RENDER_STATE_CACHE_LOG(...)                                \
+#define RENDER_STATE_CACHE_LOG(Level, ...)                         \
     do                                                             \
     {                                                              \
-        if (m_CI.EnableLogging)                                    \
+        if (m_CI.LogLevel >= Level)                                \
         {                                                          \
             LOG_INFO_MESSAGE("Render state cache: ", __VA_ARGS__); \
         }                                                          \
@@ -594,7 +594,7 @@ bool RenderStateCacheImpl::CreateShaderInternal(const ShaderCreateInfo& ShaderCI
             if (auto pShader = it->second.Lock())
             {
                 *ppShader = pShader.Detach();
-                RENDER_STATE_CACHE_LOG("Reusing existing shader '", (ShaderCI.Desc.Name ? ShaderCI.Desc.Name : ""), "'.");
+                RENDER_STATE_CACHE_LOG(RENDER_STATE_CACHE_LOG_LEVEL_VERBOSE, "Reusing existing shader '", (ShaderCI.Desc.Name ? ShaderCI.Desc.Name : ""), "'.");
                 return true;
             }
             else
@@ -650,7 +650,7 @@ bool RenderStateCacheImpl::CreateShaderInternal(const ShaderCreateInfo& ShaderCI
         {
             if (pShader->GetDesc() == ShaderCI.Desc)
             {
-                RENDER_STATE_CACHE_LOG("Found shader '", HashStr, "'.");
+                RENDER_STATE_CACHE_LOG(RENDER_STATE_CACHE_LOG_LEVEL_VERBOSE, "Found shader '", HashStr, "' in the archive.");
                 *ppShader = pShader.Detach();
                 return true;
             }
@@ -676,7 +676,7 @@ bool RenderStateCacheImpl::CreateShaderInternal(const ShaderCreateInfo& ShaderCI
         if (pArchivedShader)
         {
             if (m_pArchiver->AddShader(pArchivedShader))
-                RENDER_STATE_CACHE_LOG("Added shader '", HashStr, "'.");
+                RENDER_STATE_CACHE_LOG(RENDER_STATE_CACHE_LOG_LEVEL_NORMAL, "Added shader '", HashStr, "'.");
             else
                 LOG_ERROR_MESSAGE("Failed to archive shader '", HashStr, "'.");
         }
@@ -1025,7 +1025,7 @@ bool RenderStateCacheImpl::CreatePipelineStateInternal(const CreateInfoType& PSO
             if (auto pPSO = it->second.Lock())
             {
                 *ppPipelineState = pPSO.Detach();
-                RENDER_STATE_CACHE_LOG("Reusing existing PSO '", (PSOCreateInfo.PSODesc.Name ? PSOCreateInfo.PSODesc.Name : ""), "'.");
+                RENDER_STATE_CACHE_LOG(RENDER_STATE_CACHE_LOG_LEVEL_VERBOSE, "Reusing existing pipeline '", (PSOCreateInfo.PSODesc.Name ? PSOCreateInfo.PSODesc.Name : ""), "'.");
                 return true;
             }
             else
@@ -1083,7 +1083,7 @@ bool RenderStateCacheImpl::CreatePipelineStateInternal(const CreateInfoType& PSO
 
     if (FoundInCache)
     {
-        RENDER_STATE_CACHE_LOG("Found PSO '", HashStr, "'.");
+        RENDER_STATE_CACHE_LOG(RENDER_STATE_CACHE_LOG_LEVEL_VERBOSE, "Found pipeline '", HashStr, "' in the archive.");
         return true;
     }
 
@@ -1104,7 +1104,7 @@ bool RenderStateCacheImpl::CreatePipelineStateInternal(const CreateInfoType& PSO
         if (pSerializedPSO)
         {
             if (m_pArchiver->AddPipelineState(pSerializedPSO))
-                RENDER_STATE_CACHE_LOG("Added PSO '", HashStr, "'.");
+                RENDER_STATE_CACHE_LOG(RENDER_STATE_CACHE_LOG_LEVEL_NORMAL, "Added pipeline '", HashStr, "'.");
             else
                 LOG_ERROR_MESSAGE("Failed to archive PSO '", HashStr, "'.");
         }

ReleaseHistory.md

@@ -1,5 +1,6 @@
 # Current progress
 
+* Added `RENDER_STATE_CACHE_LOG_LEVEL` enum, replaced `EnableLogging` member of `RenderStateCacheCreateInfo` struct with `LoggingLevel` (API252009)
 * Added `IPipelineResourceSignature::CopyStaticResources` and `IPipelineState::CopyStaticResources` methods (API252008)
 * Added render state cache (`IRenderStateCache` interface and related data types) (API252007)
 * Moved `UseCombinedTextureSamplers` and `CombinedSamplerSuffix` members from `ShaderCreateInfo` to `ShaderDesc` (API252006)

Tests/DiligentCoreAPITest/src/RenderStateCacheTest.cpp

@@ -188,7 +188,7 @@ RefCntAutoPtr<IRenderStateCache> CreateCache(IRenderDevice*                   pD
                                              IDataBlob*                       pCacheData           = nullptr,
                                              IShaderSourceInputStreamFactory* pShaderReloadFactory = nullptr)
 {
-    RenderStateCacheCreateInfo CacheCI{pDevice, true, HotReload, pShaderReloadFactory};
+    RenderStateCacheCreateInfo CacheCI{pDevice, RENDER_STATE_CACHE_LOG_LEVEL_VERBOSE, HotReload, pShaderReloadFactory};
 
     RefCntAutoPtr<IRenderStateCache> pCache;
     CreateRenderStateCache(CacheCI, &pCache);