11/*
2- * Copyright 2019-2024 Diligent Graphics LLC
2+ * Copyright 2019-2025 Diligent Graphics LLC
33 * Copyright 2015-2019 Egor Yusov
44 *
55 * Licensed under the Apache License, Version 2.0 (the "License");
@@ -50,17 +50,16 @@ struct DynamicBufferCreateInfo
5050
5151 // / The size of the memory page for the sparse buffer.
5252
53- // / \remarks
54- // / This value is only relevant when Desc.Usage == USAGE_SPARSE and
55- // / defines the memory page size of the device memory object that is
56- // / backing the buffer.
53+ // / This value is only relevant when `Desc.Usage == USAGE_SPARSE` and
54+ // / defines the memory page size of the device memory object that is
55+ // / backing the buffer.
5756 // /
58- // / Memory page size should be a multiple of SparseResources.StandardBlockSize.
59- // / If it is not, the engine automatically aligns the value up to the closest
60- // / multiple of the block size.
57+ // / Memory page size should be a multiple of SparseResources.StandardBlockSize.
58+ // / If it is not, the engine automatically aligns the value up to the closest
59+ // / multiple of the block size.
6160 Uint32 MemoryPageSize = 64 << 10 ;
6261
63- // / When Desc.Usage == USAGE_SPARSE, the virtual size of the sparse buffer;
62+ // / When ` Desc.Usage == USAGE_SPARSE` , the virtual size of the sparse buffer;
6463 // / ignored otherwise.
6564 Uint64 VirtualSize = Uint64{1 } << Uint64{30 };
6665};
@@ -76,8 +75,8 @@ class DynamicBuffer
7675 // / This parameter may be null (see remarks).
7776 // / \param[in] CreateInfo - Create information, see Diligent::DynamicBufferCreateInfo.
7877 // /
79- // / \remarks If pDevice is null, internal buffer creation will be postponed
80- // / until Update() or Resize() is called.
78+ // / If ` pDevice` is null, internal buffer creation will be postponed
79+ // / until Update() or Resize() is called.
8180 DynamicBuffer (IRenderDevice* pDevice, const DynamicBufferCreateInfo& CreateInfo);
8281
8382 // clang-format off
@@ -100,22 +99,22 @@ class DynamicBuffer
10099 // /
101100 // / \return Pointer to the new buffer.
102101 // /
103- // / \remarks The method operation depends on which of pDevice and pContext parameters
104- // / are not null:
105- // / - Both pDevice and pContext are not null: the new internal buffer is created
106- // / and existing contents is copied (for non-sparse buffer), or memory pages
107- // / are committed (for sparse buffer). Update() may be called with
108- // / both pDevice and pContext being null.
109- // / - pDevice is not null, pContext is null: internal buffer is created,
110- // / but existing contents is not copied or memory is not committed. An
111- // / application must provide non-null device context when calling Update().
112- // / - Both pDevice and pContext are null: internal buffer is not created.
113- // / An application must provide non-null device and device context when calling
114- // / Update().
102+ // / The method operation depends on which of ` pDevice` and ` pContext` parameters
103+ // / are not null:
104+ // / - Both ` pDevice` and ` pContext` are not null: the new internal buffer is created
105+ // / and existing contents is copied (for non-sparse buffer), or memory pages
106+ // / are committed (for sparse buffer). Update() may be called with
107+ // / both ` pDevice` and ` pContext` being null.
108+ // / - ` pDevice` is not null, ` pContext` is null: internal buffer is created,
109+ // / but existing contents is not copied or memory is not committed. An
110+ // / application must provide non-null device context when calling Update().
111+ // / - Both ` pDevice` and ` pContext` are null: internal buffer is not created.
112+ // / An application must provide non-null device and device context when calling
113+ // / Update().
115114 // /
116- // / Typically pDevice and pContext should be null when the method is called from a worker thread.
115+ // / Typically pDevice and pContext should be null when the method is called from a worker thread.
117116 // /
118- // / If NewSize is zero, internal buffer will be released.
117+ // / If ` NewSize` is zero, internal buffer will be released.
119118 IBuffer* Resize (IRenderDevice* pDevice,
120119 IDeviceContext* pContext,
121120 Uint64 NewSize,
@@ -131,20 +130,20 @@ class DynamicBuffer
131130 // / (see remarks).
132131 // / \return A pointer to the buffer object.
133132 // /
134- // / \remarks If the buffer has been resized, but internal buffer object has not been
135- // / initialized, pDevice and pContext must not be null.
133+ // / If the buffer has been resized, but internal buffer object has not been
134+ // / initialized, ` pDevice` and ` pContext` must not be null.
136135 // /
137- // / If buffer does not need to be updated (PendingUpdate() returns false),
138- // / both pDevice and pContext may be null.
136+ // / If buffer does not need to be updated (PendingUpdate() returns false),
137+ // / both ` pDevice` and ` pContext` may be null.
139138 IBuffer* Update (IRenderDevice* pDevice,
140139 IDeviceContext* pContext);
141140
142141
143142 // / Returns a pointer to the buffer object.
144- // /
145- // / \remarks If the buffer has not been initialized, the method returns null.
146- // / If the buffer may need to be updated (resized or initialized), use the Update()
147- // / method.
143+
144+ // / If the buffer has not been initialized, the method returns null.
145+ // / If the buffer may need to be updated (resized or initialized), use the Update()
146+ // / method.
148147 IBuffer* GetBuffer () const
149148 {
150149 return m_pBuffer;
@@ -167,6 +166,7 @@ class DynamicBuffer
167166
168167
169168 // / Returns the dynamic buffer version.
169+
170170 // / The version is incremented every time a new internal buffer is created.
171171 Uint32 GetVersion () const
172172 {
@@ -175,10 +175,10 @@ class DynamicBuffer
175175
176176
177177 // / Returns the logical virtual size of the sparse buffer.
178- // /
179- // / \note The actual size of the sparse buffer may be larger
180- // / than the logical size due to alignment requirements.
181- // / Use GetBuffer()->GetDesc().Size to get the actual size.
178+
179+ // / The actual size of the sparse buffer may be larger
180+ // / than the logical size due to alignment requirements.
181+ // / Use GetBuffer()->GetDesc().Size to get the actual size.
182182 Uint64 GetVirtualSize () const
183183 {
184184 return m_VirtualSize;
0 commit comments