Updated documentation for IDeviceMemory, IFence and InputLayout

Author: TheMostDiligent

Graphics/GraphicsEngine/include/FenceBase.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,7 +74,7 @@ class FenceBase : public DeviceObjectBase<typename EngineImplTraits::FenceInterf
     void DvpSignal(Uint64 NewValue)
     {
 #ifdef DILIGENT_DEVELOPMENT
-        auto EnqueuedValue = m_EnqueuedFenceValue.load();
+        Uint64 EnqueuedValue = m_EnqueuedFenceValue.load();
         DEV_CHECK_ERR(NewValue >= EnqueuedValue,
                       "Fence '", this->m_Desc.Name, "' is being signaled or enqueued for signal with value ", NewValue,
                       ", but the previous value (", EnqueuedValue,

Graphics/GraphicsEngine/interface/DeviceMemory.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.
@@ -44,6 +44,7 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_DeviceMemory =
 /// This enumeration is used by DeviceMemoryDesc structure.
 DILIGENT_TYPED_ENUM(DEVICE_MEMORY_TYPE, Uint8)
 {
+    /// Indicates that the memory type is not defined.
     DEVICE_MEMORY_TYPE_UNDEFINED = 0,
 
     /// Indicates that memory will be used for sparse resources.
@@ -56,7 +57,8 @@ struct DeviceMemoryDesc DILIGENT_DERIVE(DeviceObjectAttribs)
     /// Memory type, see Diligent::DEVICE_MEMORY_TYPE.
     DEVICE_MEMORY_TYPE  Type                  DEFAULT_INITIALIZER(DEVICE_MEMORY_TYPE_UNDEFINED);
 
-    /// Size of the memory page.
+    /// Size of the memory page, in bytes.
+
     /// Depending on the implementation, the memory may be allocated as a single chunk or as an array of pages.
     Uint64              PageSize              DEFAULT_INITIALIZER(0);
 
@@ -92,19 +94,21 @@ struct DeviceMemoryCreateInfo
     DeviceMemoryDesc  Desc;
 
     /// Initial size of the memory object.
-    ///
+
     /// Some implementations do not support IDeviceMemory::Resize() and memory can only be allocated during the initialization.
     Uint64            InitialSize           DEFAULT_INITIALIZER(0);
 
-    /// An array of NumResources resources that this memory must be compatible with.
-    /// For sparse memory, only USAGE_SPARSE buffer and texture resources are allowed.
+    /// An array of `NumResources` resources that this memory must be compatible with.
+
+    /// For sparse memory, only Diligent::USAGE_SPARSE buffer and texture resources are allowed.
     /// 
-    /// \note Vulkan backend requires at least one resource to be provided.
+    /// Vulkan backend requires at least one resource to be provided.
+    ///
+    /// In Direct3D12, the list of resources is optional on D3D12_RESOURCE_HEAP_TIER_2-hardware
+    /// and above, but is required on D3D12_RESOURCE_HEAP_TIER_1-hardware
+    /// (see SPARSE_RESOURCE_CAP_FLAG_MIXED_RESOURCE_TYPE_SUPPORT).
     ///
-    ///       In Direct3D12, the list of resources is optional on D3D12_RESOURCE_HEAP_TIER_2-hardware
-    ///       and above, but is required on D3D12_RESOURCE_HEAP_TIER_1-hardware
-    ///       (see SPARSE_RESOURCE_CAP_FLAG_MIXED_RESOURCE_TYPE_SUPPORT).
-    ///       It is recommended to always provide the list.
+    /// It is recommended to always provide the list.
     IDeviceObject**   ppCompatibleResources DEFAULT_INITIALIZER(nullptr);
 
     /// The number of elements in the ppCompatibleResources array.
@@ -137,8 +141,8 @@ DILIGENT_BEGIN_INTERFACE(IDeviceMemory, IDeviceObject)
 
     /// \param [in] NewSize - The new size of the memory object; must be a multiple of DeviceMemoryDesc::PageSize.
     ///
-    /// \remarks  Depending on the implementation, the function may resize the existing memory object or
-    ///           create/destroy pages with separate memory objects.
+    /// Depending on the implementation, the function may resize the existing memory object or
+    /// create/destroy pages with separate memory objects.
     ///
     /// \remarks  This method must be externally synchronized with IDeviceMemory::GetCapacity()
     ///           and IDeviceContext::BindSparseResourceMemory().

Graphics/GraphicsEngine/interface/Fence.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");
@@ -84,8 +84,8 @@ typedef struct FenceDesc FenceDesc;
 
 /// Defines the methods to manipulate a fence object
 ///
-/// \remarks When a fence that was previously signaled by IDeviceContext::EnqueueSignal() is destroyed,
-///          it may block the GPU until all prior commands have completed execution.
+/// When a fence that was previously signaled by IDeviceContext::EnqueueSignal() is destroyed,
+/// it may block the GPU until all prior commands have completed execution.
 ///
 /// \remarks In Direct3D12 and Vulkan backends, fence is thread-safe.
 DILIGENT_BEGIN_INTERFACE(IFence, IDeviceObject)
@@ -108,12 +108,12 @@ DILIGENT_BEGIN_INTERFACE(IFence, IDeviceObject)
     /// \param [in] Value - New value to set the fence to.
     ///                     The value must be greater than the current value of the fence.
     ///
-    /// \note  Fence value will be changed immediately on the CPU.
-    ///        Use IDeviceContext::EnqueueSignal to enqueue a signal command
-    ///        that will change the value on the GPU after all previously submitted commands
-    ///        are complete.
+    /// Fence value will be changed immediately on the CPU.
+    /// Use IDeviceContext::EnqueueSignal to enqueue a signal command
+    /// that will change the value on the GPU after all previously submitted commands
+    /// are complete.
     ///
-    /// \note  The fence must have been created with type FENCE_TYPE_GENERAL.
+    /// \note  The fence must have been created with type Diligent::FENCE_TYPE_GENERAL.
     VIRTUAL void METHOD(Signal)(THIS_
                                 Uint64 Value) PURE;
 
@@ -122,7 +122,7 @@ DILIGENT_BEGIN_INTERFACE(IFence, IDeviceObject)
 
     /// \param [in] Value - The value that the fence is waiting for to reach.
     ///
-    /// \note  The method blocks the execution of the calling thread until the wait is complete.
+    /// The method blocks the execution of the calling thread until the wait is complete.
     VIRTUAL void METHOD(Wait)(THIS_
                               Uint64 Value) PURE;
 };

Graphics/GraphicsEngine/interface/InputLayout.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");
@@ -68,13 +68,16 @@ DILIGENT_TYPED_ENUM(INPUT_ELEMENT_FREQUENCY, Uint8)
 /// Description of a single element of the input layout
 struct LayoutElement
 {
-    /// HLSL semantic. Default value ("ATTRIB") allows HLSL shaders to be converted
+    /// HLSL semantic.
+
+    /// Default value (`"ATTRIB"`) allows HLSL shaders to be converted
     /// to GLSL and used in OpenGL backend as well as compiled to SPIRV and used
     /// in Vulkan backend.
     /// Any value other than default will only work in Direct3D11 and Direct3D12 backends.
     const Char* HLSLSemantic DEFAULT_INITIALIZER("ATTRIB");
 
     /// Input index of the element that is specified in the vertex shader.
+
     /// In Direct3D11 and Direct3D12 backends this is the semantic index.
     Uint32 InputIndex        DEFAULT_INITIALIZER(0);
 
@@ -87,25 +90,31 @@ struct LayoutElement
     /// Type of the element components, see Diligent::VALUE_TYPE for details.
     VALUE_TYPE ValueType     DEFAULT_INITIALIZER(VT_FLOAT32);
 
+    /// Indicates if the value should be normalized.
+
     /// For signed and unsigned integer value types
-    /// (VT_INT8, VT_INT16, VT_INT32, VT_UINT8, VT_UINT16, VT_UINT32)
+    /// (`VT_INT8`, `VT_INT16`, `VT_INT32`, `VT_UINT8`, `VT_UINT16`, `VT_UINT32`)
     /// indicates if the value should be normalized to [-1,+1] or
-    /// [0, 1] range respectively. For floating point types
-    /// (VT_FLOAT16 and VT_FLOAT32), this member is ignored.
+    /// [0, 1] range respectively.
+    /// 
+    /// For floating point types (`VT_FLOAT16` and `VT_FLOAT32`), this member is ignored.
     Bool IsNormalized        DEFAULT_INITIALIZER(True);
 
     /// Relative offset, in bytes, to the element bits.
-    /// If this value is set to LAYOUT_ELEMENT_AUTO_OFFSET (default value), the offset will
+
+    /// If this value is set to `LAYOUT_ELEMENT_AUTO_OFFSET` (default value), the offset will
     /// be computed automatically by placing the element right after the previous one.
     Uint32 RelativeOffset    DEFAULT_INITIALIZER(LAYOUT_ELEMENT_AUTO_OFFSET);
 
     /// Stride, in bytes, between two elements, for this buffer slot.
-    /// If this value is set to LAYOUT_ELEMENT_AUTO_STRIDE, the stride will be
+
+    /// If this value is set to `LAYOUT_ELEMENT_AUTO_STRIDE`, the stride will be
     /// computed automatically assuming that all elements in the same buffer slot are
     /// packed one after another. If the buffer slot contains multiple layout elements,
     /// they all must specify the same stride or use LAYOUT_ELEMENT_AUTO_STRIDE value.
     Uint32 Stride            DEFAULT_INITIALIZER(LAYOUT_ELEMENT_AUTO_STRIDE);
 
+    /// Frequency of the input data, see Diligent::INPUT_ELEMENT_FREQUENCY for details.
     INPUT_ELEMENT_FREQUENCY Frequency DEFAULT_INITIALIZER(INPUT_ELEMENT_FREQUENCY_PER_VERTEX);
 
     /// The number of instances to draw using the same per-instance data before advancing
@@ -208,9 +217,10 @@ typedef struct LayoutElement LayoutElement;
 /// This structure is used by IRenderDevice::CreateGraphicsPipelineState().
 struct InputLayoutDesc
 {
-    /// Array of layout elements
+    /// Array of layout elements.
     const LayoutElement* LayoutElements  DEFAULT_INITIALIZER(nullptr);
-    /// Number of layout elements
+
+    /// The number of layout elements in `LayoutElements` array.
     Uint32               NumElements     DEFAULT_INITIALIZER(0);
 
 #if DILIGENT_CPP_INTERFACE