Skip to content

Commit d639edb

Browse files
TheMostDiligentTheMostDiligent
committed
Updated documentation for Direct3D12 backend interfaces
1 parent 79b3aa2 commit d639edb

21 files changed

Lines changed: 106 additions & 91 deletions

‎Graphics/Archiver/interface/Archiver.h‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ DILIGENT_BEGIN_INTERFACE(IArchiver, IObject)
169169
/// \param [in] ShaderName - Name of the shader object to retrieve.
170170
/// \return A pointer to the shader object, or null if the object with that name was not added.
171171
///
172-
/// \note The method does *not* increment the reference counter of the returned object,
172+
/// \note The method does **NOT** increment the reference counter of the returned object,
173173
/// so the application **must not** call Release() unless it also explicitly calls AddRef().
174174
VIRTUAL IShader* METHOD(GetShader)(THIS_
175175
const char* ShaderName) PURE;
@@ -180,7 +180,7 @@ DILIGENT_BEGIN_INTERFACE(IArchiver, IObject)
180180
/// \param [in] PSOName - Name of the pipeline state to retrieve.
181181
/// \return A pointer to the pipeline state object, or null if the object with that name was not added.
182182
///
183-
/// \note The method does *not* increment the reference counter of the returned object,
183+
/// \note The method does **NOT** increment the reference counter of the returned object,
184184
/// so the application **must not** call Release() unless it also explicitly calls AddRef().
185185
VIRTUAL IPipelineState* METHOD(GetPipelineState)(THIS_
186186
PIPELINE_TYPE PSOType,
@@ -191,7 +191,7 @@ DILIGENT_BEGIN_INTERFACE(IArchiver, IObject)
191191
/// \param [in] PRSName - Name of the pipeline resource signature to retrieve.
192192
/// \return A pointer to the the pipeline resource signature object, or null if the object with that name was not added.
193193
///
194-
/// \note The method does *not* increment the reference counter of the returned object,
194+
/// \note The method does **NOT** increment the reference counter of the returned object,
195195
/// so the application **must not** call Release() unless it also explicitly calls AddRef().
196196
VIRTUAL IPipelineResourceSignature* METHOD(GetPipelineResourceSignature)(THIS_
197197
const char* PRSName) PURE;

‎Graphics/GraphicsEngine/interface/BufferView.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ DILIGENT_BEGIN_INTERFACE(IBufferView, IDeviceObject)
164164

165165
/// Returns pointer to the referenced buffer object.
166166

167-
/// The method does *NOT* increment the reference counter of the returned object,
167+
/// The method does **NOT** increment the reference counter of the returned object,
168168
/// so Release() **must not** be called.
169169
VIRTUAL struct IBuffer* METHOD(GetBuffer)(THIS) CONST PURE;
170170
};

‎Graphics/GraphicsEngine/interface/ShaderResourceBinding.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ DILIGENT_BEGIN_INTERFACE(IShaderResourceBinding, IObject)
6060
/// Returns a pointer to the pipeline resource signature object that
6161
/// defines the layout of this shader resource binding object.
6262

63-
/// The method does *NOT* increment the reference counter of the returned object,
64-
/// so Release() must not be called.
63+
/// The method does **NOT** increment the reference counter of the returned object,
64+
/// so Release() **must not** be called.
6565
VIRTUAL struct IPipelineResourceSignature* METHOD(GetPipelineResourceSignature)(THIS) CONST PURE;
6666

6767

‎Graphics/GraphicsEngineD3D12/interface/BottomLevelASD3D12.h‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2019-2023 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");
@@ -51,10 +51,10 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_BottomLevelASD3D12 =
5151
/// Exposes Direct3D12-specific functionality of a bottom-level acceleration structure object.
5252
DILIGENT_BEGIN_INTERFACE(IBottomLevelASD3D12, IBottomLevelAS)
5353
{
54-
/// Returns ID3D12Resource interface of the internal D3D12 acceleration structure object.
54+
/// Returns `ID3D12Resource` interface of the internal D3D12 acceleration structure object.
5555

56-
/// The method does *NOT* increment the reference counter of the returned object,
57-
/// so Release() must not be called.
56+
/// The method does **NOT** increment the reference counter of the returned object,
57+
/// so Release() **must not** be called.
5858
VIRTUAL ID3D12Resource* METHOD(GetD3D12BLAS)(THIS) PURE;
5959
};
6060
DILIGENT_END_INTERFACE

‎Graphics/GraphicsEngineD3D12/interface/BufferD3D12.h‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2019-2023 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");
@@ -51,15 +51,16 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_BufferD3D12 =
5151
/// Exposes Direct3D12-specific functionality of a buffer object.
5252
DILIGENT_BEGIN_INTERFACE(IBufferD3D12, IBuffer)
5353
{
54-
/// Returns a pointer to the ID3D12Resource interface of the internal Direct3D12 object.
54+
/// Returns a pointer to the `ID3D12Resource` interface of the internal Direct3D12 object.
5555

56-
/// The method does *NOT* increment the reference counter of the returned object,
57-
/// so Release() must not be called.
5856
/// \param [in] DataStartByteOffset - Offset from the beginning of the buffer
5957
/// to the start of the data. This parameter
6058
/// is required for dynamic buffers, which are
6159
/// suballocated in a dynamic upload heap
6260
/// \param [in] pContext - Device context within which address of the buffer is requested.
61+
///
62+
/// The method does **NOT** increment the reference counter of the returned object,
63+
/// so Release() **must not** be called.
6364
VIRTUAL ID3D12Resource* METHOD(GetD3D12Buffer)(THIS_
6465
Uint64 REF DataStartByteOffset,
6566
IDeviceContext* pContext) PURE;
@@ -71,8 +72,9 @@ DILIGENT_BEGIN_INTERFACE(IBufferD3D12, IBuffer)
7172
D3D12_RESOURCE_STATES state) PURE;
7273

7374
/// Returns current D3D12 buffer state.
75+
7476
/// If the state is unknown to the engine (Diligent::RESOURCE_STATE_UNKNOWN),
75-
/// returns D3D12_RESOURCE_STATE_COMMON (0).
77+
/// returns `D3D12_RESOURCE_STATE_COMMON` (0).
7678
VIRTUAL D3D12_RESOURCE_STATES METHOD(GetD3D12ResourceState)(THIS) CONST PURE;
7779
};
7880
DILIGENT_END_INTERFACE

‎Graphics/GraphicsEngineD3D12/interface/CommandQueueD3D12.h‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2019-2023 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");
@@ -57,11 +57,13 @@ struct ResourceTileMappingsD3D12
5757
UINT NumResourceRegions DEFAULT_INITIALIZER(0);
5858

5959
/// An array of structures that describe the starting coordinates of the reserved resource regions.
60-
/// The NumResourceRegions parameter specifies the number of elements in the array.
60+
61+
/// The `NumResourceRegions` parameter specifies the number of elements in the array.
6162
const D3D12_TILED_RESOURCE_COORDINATE* pResourceRegionStartCoordinates DEFAULT_INITIALIZER(nullptr);
6263

6364
/// An array of structures that describe the sizes of the reserved resource regions.
64-
/// The NumResourceRegions parameter specifies the number of elements in the array.
65+
66+
/// The `NumResourceRegions` parameter specifies the number of elements in the array.
6567
const D3D12_TILE_REGION_SIZE* pResourceRegionSizes DEFAULT_INITIALIZER(nullptr);
6668

6769
/// A pointer to the resource heap.
@@ -70,7 +72,8 @@ struct ResourceTileMappingsD3D12
7072
/// The number of tile ranges.
7173
UINT NumRanges DEFAULT_INITIALIZER(0);
7274

73-
/// A pointer to an array of D3D12_TILE_RANGE_FLAGS values that describes each tile range.
75+
/// A pointer to an array of `D3D12_TILE_RANGE_FLAGS` values that describes each tile range.
76+
7477
/// The NumRanges parameter specifies the number of values in the array.
7578
const D3D12_TILE_RANGE_FLAGS* pRangeFlags DEFAULT_INITIALIZER(nullptr);
7679

‎Graphics/GraphicsEngineD3D12/interface/DeviceContextD3D12.h‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2019-2023 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");
@@ -71,19 +71,19 @@ DILIGENT_BEGIN_INTERFACE(IDeviceContextD3D12, IDeviceContext)
7171

7272
/// \return - a pointer to the current command list
7373
///
74-
/// \remarks Any command on the device context may potentially submit the command list for
75-
/// execution into the command queue and make it invalid. An application should
76-
/// never cache the pointer and should instead request the command list every time it
77-
/// needs it.
74+
/// Any command on the device context may potentially submit the command list for
75+
/// execution into the command queue and make it invalid. An application should
76+
/// never cache the pointer and should instead request the command list every time it
77+
/// needs it.
7878
///
79-
/// The engine manages the lifetimes of all command buffers, so an application must
80-
/// not call AddRef/Release methods on the returned interface.
79+
/// The engine manages the lifetimes of all command buffers, so an application must
80+
/// not call AddRef/Release methods on the returned interface.
8181
///
82-
/// Diligent Engine internally keeps track of all resource state changes (vertex and index
83-
/// buffers, pipeline states, render targets, etc.). If an application changes any of these
84-
/// states in the command list, it must invalidate the engine's internal state tracking by
85-
/// calling IDeviceContext::InvalidateState() and then manually restore all required states via
86-
/// appropriate Diligent API calls.
82+
/// Diligent Engine internally keeps track of all resource state changes (vertex and index
83+
/// buffers, pipeline states, render targets, etc.). If an application changes any of these
84+
/// states in the command list, it must invalidate the engine's internal state tracking by
85+
/// calling IDeviceContext::InvalidateState() and then manually restore all required states via
86+
/// appropriate Diligent API calls.
8787
VIRTUAL ID3D12GraphicsCommandList* METHOD(GetD3D12CommandList)(THIS) PURE;
8888
};
8989
DILIGENT_END_INTERFACE

‎Graphics/GraphicsEngineD3D12/interface/DeviceMemoryD3D12.h‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2019-2023 Diligent Graphics LLC
2+
* Copyright 2019-2025 Diligent Graphics LLC
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -49,13 +49,14 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_DeviceMemoryD3D12 =
4949
/// This structure is returned by IDeviceMemoryD3D12::GetRange()
5050
struct DeviceMemoryRangeD3D12
5151
{
52-
/// Pointer to the ID3D12Heap interface.
52+
/// Pointer to the `ID3D12Heap` interface.
5353
ID3D12Heap* pHandle DEFAULT_INITIALIZER(nullptr);
5454

5555
/// Offset from the beginning of the heap to the start of the range, in bytes.
5656
Uint64 Offset DEFAULT_INITIALIZER(0);
5757

5858
/// Memory range size in bytes.
59+
5960
/// When IDeviceMemoryD3D12::GetRange() succeeds, the size is equal to the Size argument
6061
/// that was given to the function, and zero otherwise.
6162
Uint64 Size DEFAULT_INITIALIZER(0);

‎Graphics/GraphicsEngineD3D12/interface/EngineFactoryD3D12.h‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2019-2023 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");
@@ -64,11 +64,11 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryD3D12, IEngineFactory)
6464
/// \param [in] DllName - D3D12 dll name.
6565
/// \return true if the library and entry points are loaded successfully and false otherwise.
6666
///
67-
/// \remarks IEngineFactoryD3D12::CreateDeviceAndContextsD3D12() and
68-
/// IEngineFactoryD3D12::AttachToD3D12Device() functions will automatically
69-
/// load the DLL if it has not be loaded already.
67+
/// IEngineFactoryD3D12::CreateDeviceAndContextsD3D12() and
68+
/// IEngineFactoryD3D12::AttachToD3D12Device() functions will automatically
69+
/// load the DLL if it has not be loaded already.
7070
///
71-
/// This method has no effect on UWP.
71+
/// This method has no effect on UWP.
7272
VIRTUAL Bool METHOD(LoadD3D12)(THIS_
7373
const char* DllName DEFAULT_VALUE("d3d12.dll")) PURE;
7474

@@ -79,7 +79,7 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryD3D12, IEngineFactory)
7979
/// the created device will be written.
8080
/// \param [out] ppContexts - Address of the memory location where pointers to
8181
/// the contexts will be written. Immediate context goes at
82-
/// position 0. If EngineCI.NumDeferredContexts > 0,
82+
/// position 0. If `EngineCI.NumDeferredContexts > 0`,
8383
/// pointers to the deferred contexts are written afterwards.
8484
VIRTUAL void METHOD(CreateDeviceAndContextsD3D12)(THIS_
8585
const EngineD3D12CreateInfo REF EngineCI,
@@ -110,7 +110,7 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryD3D12, IEngineFactory)
110110
/// the created device will be written
111111
/// \param [out] ppContexts - Address of the memory location where pointers to
112112
/// the contexts will be written. Immediate context goes at
113-
/// position 0. If EngineCI.NumDeferredContexts > 0,
113+
/// position 0. If `EngineCI.NumDeferredContexts > 0`,
114114
/// pointers to the deferred contexts are written afterwards.
115115
VIRTUAL void METHOD(AttachToD3D12Device)(THIS_
116116
void* pd3d12NativeDevice,
@@ -130,9 +130,9 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryD3D12, IEngineFactory)
130130
/// \param [in] FSDesc - Fullscreen mode description.
131131
/// \param [in] Window - Platform-specific native window description that
132132
/// the swap chain will be associated with:
133-
/// * On Win32 platform, this is the window handle (HWND)
133+
/// * On Win32 platform, this is the window handle (`HWND`)
134134
/// * On Universal Windows Platform, this is the reference
135-
/// to the core window (Windows::UI::Core::CoreWindow)
135+
/// to the core window (`Windows::UI::Core::CoreWindow`)
136136
///
137137
/// \param [out] ppSwapChain - Address of the memory location where pointer to the new
138138
/// swap chain will be written

‎Graphics/GraphicsEngineD3D12/interface/FenceD3D12.h‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2019-2023 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,10 +50,10 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_FenceD3D12 =
5050
/// Exposes Direct3D12-specific functionality of a fence object.
5151
DILIGENT_BEGIN_INTERFACE(IFenceD3D12, IFence)
5252
{
53-
/// Returns a pointer to the ID3D12Fence interface of the internal Direct3D12 object.
53+
/// Returns a pointer to the `ID3D12Fence` interface of the internal Direct3D12 object.
5454

55-
/// The method does *NOT* increment the reference counter of the returned object,
56-
/// so Release() must not be called.
55+
/// The method does **NOT** increment the reference counter of the returned object,
56+
/// so Release() **must not** be called.
5757
VIRTUAL ID3D12Fence* METHOD(GetD3D12Fence)(THIS) PURE;
5858
};
5959
DILIGENT_END_INTERFACE

0 commit comments

Comments
 (0)