Updated pipeline state cache and query documentation

Author: TheMostDiligent

Graphics/GraphicsEngine/include/QueryBase.hpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -74,32 +74,32 @@ class QueryBase : public DeviceObjectBase<typename EngineImplTraits::QueryInterf
               bool                  bIsDeviceInternal = false) :
         TDeviceObjectBase{pRefCounters, pDevice, Desc, bIsDeviceInternal}
     {
-        const auto& deviceFeatures = this->GetDevice()->GetFeatures();
+        const DeviceFeatures& Features = this->GetDevice()->GetFeatures();
         static_assert(QUERY_TYPE_NUM_TYPES == 6, "Not all QUERY_TYPE enum values are handled below");
         switch (Desc.Type)
         {
             case QUERY_TYPE_OCCLUSION:
-                if (!deviceFeatures.OcclusionQueries)
+                if (!Features.OcclusionQueries)
                     LOG_ERROR_AND_THROW("Occlusion queries are not supported by this device");
                 break;
 
             case QUERY_TYPE_BINARY_OCCLUSION:
-                if (!deviceFeatures.BinaryOcclusionQueries)
+                if (!Features.BinaryOcclusionQueries)
                     LOG_ERROR_AND_THROW("Binary occlusion queries are not supported by this device");
                 break;
 
             case QUERY_TYPE_TIMESTAMP:
-                if (!deviceFeatures.TimestampQueries)
+                if (!Features.TimestampQueries)
                     LOG_ERROR_AND_THROW("Timestamp queries are not supported by this device");
                 break;
 
             case QUERY_TYPE_PIPELINE_STATISTICS:
-                if (!deviceFeatures.PipelineStatisticsQueries)
+                if (!Features.PipelineStatisticsQueries)
                     LOG_ERROR_AND_THROW("Pipeline statistics queries are not supported by this device");
                 break;
 
             case QUERY_TYPE_DURATION:
-                if (!deviceFeatures.DurationQueries)
+                if (!Features.DurationQueries)
                     LOG_ERROR_AND_THROW("Duration queries are not supported by this device");
                 break;
 

Graphics/GraphicsEngine/interface/PipelineStateCache.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -68,10 +68,11 @@ struct PipelineStateCacheDesc DILIGENT_DERIVE(DeviceObjectAttribs)
 
     /// Cache mode, see Diligent::PSO_CACHE_MODE.
 
-    /// \note Metal backend allows generating the cache on one device
-    ///       and loading PSOs from it on another.
-    ///       Vulkan PSO cache depends on the GPU device, driver version and other parameters,
-    ///       so the cache must be generated and used on the same device.
+    /// Metal backend allows generating the cache on one device
+    /// and loading PSOs from it on another.
+    ///
+    /// Vulkan PSO cache depends on the GPU device, driver version and other parameters,
+    /// so the cache must be generated and used on the same device.
     PSO_CACHE_MODE Mode DEFAULT_INITIALIZER(PSO_CACHE_MODE_LOAD_STORE);
 
     /// PSO cache flags, see Diligent::PSO_CACHE_FLAGS.
@@ -84,6 +85,7 @@ typedef struct PipelineStateCacheDesc PipelineStateCacheDesc;
 /// Pipeline state pbject cache create info
 struct PipelineStateCacheCreateInfo
 {
+    /// Pipeline state cache description
     PipelineStateCacheDesc Desc;
 
     /// All fields can be null to create an empty cache

Graphics/GraphicsEngine/interface/Query.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -40,6 +40,7 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_Query =
     {0x70f2a88a, 0xf8be, 0x4901, {0x8f, 0x5, 0x2f, 0x72, 0xfa, 0x69, 0x5b, 0xa0}};
 
 /// Occlusion query data.
+
 /// This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_OCCLUSION query type.
 struct QueryDataOcclusion
 {
@@ -53,6 +54,7 @@ struct QueryDataOcclusion
 typedef struct QueryDataOcclusion QueryDataOcclusion;
 
 /// Binary occlusion query data.
+
 /// This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_BINARY_OCCLUSION query type.
 struct QueryDataBinaryOcclusion
 {
@@ -66,6 +68,7 @@ struct QueryDataBinaryOcclusion
 typedef struct QueryDataBinaryOcclusion QueryDataBinaryOcclusion;
 
 /// Timestamp query data.
+
 /// This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_TIMESTAMP query type.
 struct QueryDataTimestamp
 {
@@ -82,6 +85,7 @@ struct QueryDataTimestamp
 typedef struct QueryDataTimestamp QueryDataTimestamp;
 
 /// Pipeline statistics query data.
+
 /// This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_PIPELINE_STATISTICS query type.
 ///
 /// \warning  In OpenGL backend the only field that will be populated is ClippingInvocations.
@@ -128,6 +132,7 @@ struct QueryDataPipelineStatistics
 typedef struct QueryDataPipelineStatistics QueryDataPipelineStatistics;
 
 /// Duration query data.
+
 /// This structure is filled by IQuery::GetData() for Diligent::QUERY_TYPE_DURATION query type.
 struct QueryDataDuration
 {
@@ -192,15 +197,15 @@ DILIGENT_BEGIN_INTERFACE(IQuery, IDeviceObject)
     /// \param [in] AutoInvalidate - Whether to invalidate the query if the results are available and release associated resources.
     ///                              An application should typically always invalidate completed queries unless
     ///                              it needs to retrieve the same data through GetData() multiple times.
-    ///                              A query will not be invalidated if pData is nullptr.
+    ///                              A query will not be invalidated if `pData` is `nullptr`.
     ///
-    /// \return     true if the query data is available and false otherwise.
+    /// \return     `true` if the query data is available and `false` otherwise.
     ///
-    /// \note       In Direct3D11 backend timestamp queries will only be available after FinishFrame is called
-    ///             for the frame in which they were collected.
+    /// In Direct3D11 backend timestamp queries will only be available after FinishFrame is called
+    /// for the frame in which they were collected.
     ///
-    ///             If AutoInvalidate is set to true, and the data have been retrieved, an application
-    ///             must not call GetData() until it begins and ends the query again.
+    /// If `AutoInvalidate` is set to true, and the data have been retrieved, an application
+    /// must not call GetData() until it begins and ends the query again.
     VIRTUAL Bool METHOD(GetData)(THIS_
                                  void*   pData,
                                  Uint32  DataSize,