Skip to content

Commit 79b3aa2

Browse files
TheMostDiligentTheMostDiligent
committed
Updated documentation for Direct3D11 backend interfaces
1 parent b7503ea commit 79b3aa2

File tree

13 files changed

+81
-81
lines changed

13 files changed

+81
-81
lines changed

‎Graphics/GraphicsEngineD3D11/interface/BufferD3D11.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");
@@ -48,10 +48,10 @@ static DILIGENT_CONSTEXPR struct INTERFACE_ID IID_BufferD3D11 =
4848
/// Exposes Direct3D11-specific functionality of a buffer object.
4949
DILIGENT_BEGIN_INTERFACE(IBufferD3D11, IBuffer)
5050
{
51-
/// Returns a pointer to the ID3D11Buffer interface of the internal Direct3D11 object.
51+
/// Returns a pointer to the `ID3D11Buffer` interface of the internal Direct3D11 object.
5252

53-
/// The method does *NOT* increment the reference counter of the returned object,
54-
/// so Release() must not be called.
53+
/// The method does **NOT** increment the reference counter of the returned object,
54+
/// so Release() **must not** be called.
5555
VIRTUAL ID3D11Buffer* METHOD(GetD3D11Buffer)(THIS) CONST PURE;
5656
};
5757
DILIGENT_END_INTERFACE

‎Graphics/GraphicsEngineD3D11/interface/BufferViewD3D11.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");
@@ -48,10 +48,10 @@ static DILIGENT_CONSTEXPR struct INTERFACE_ID IID_BufferViewD3D11 =
4848
/// Exposes Direct3D11-specific functionality of a buffer view object.
4949
DILIGENT_BEGIN_INTERFACE(IBufferViewD3D11, IBufferView)
5050
{
51-
/// Returns a pointer to the ID3D11View interface of the internal Direct3D11 object.
51+
/// Returns a pointer to the `ID3D11View` interface of the internal Direct3D11 object.
5252

53-
/// The method does *NOT* increment the reference counter of the returned object,
54-
/// so Release() must not be called.
53+
/// The method does **NOT** increment the reference counter of the returned object,
54+
/// so Release() **must not** be called.
5555
VIRTUAL ID3D11View* METHOD(GetD3D11View)(THIS) PURE;
5656
};
5757
DILIGENT_END_INTERFACE

‎Graphics/GraphicsEngineD3D11/interface/DeviceContextD3D11.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");
@@ -48,10 +48,10 @@ static DILIGENT_CONSTEXPR struct INTERFACE_ID IID_DeviceContextD3D11 =
4848
/// Exposes Direct3D11-specific functionality of a device context.
4949
DILIGENT_BEGIN_INTERFACE(IDeviceContextD3D11, IDeviceContext)
5050
{
51-
/// Returns a pointer to the ID3D11DeviceContext interface of the internal Direct3D11 object.
51+
/// Returns a pointer to the `ID3D11DeviceContext` interface of the internal Direct3D11 object.
5252

53-
/// The method does *NOT* increment the reference counter of the returned object,
54-
/// so Release() must not be called.
53+
/// The method does **NOT** increment the reference counter of the returned object,
54+
/// so Release() **must not** be called.
5555
VIRTUAL ID3D11DeviceContext* METHOD(GetD3D11DeviceContext)(THIS) PURE;
5656
};
5757
DILIGENT_END_INTERFACE

‎Graphics/GraphicsEngineD3D11/interface/DeviceMemoryD3D11.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
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -47,10 +47,10 @@ static DILIGENT_CONSTEXPR INTERFACE_ID IID_DeviceMemoryD3D11 =
4747
/// Exposes Direct3D11-specific functionality of a device memory object.
4848
DILIGENT_BEGIN_INTERFACE(IDeviceMemoryD3D11, IDeviceMemory)
4949
{
50-
/// Returns a pointer to the ID3D11Buffer interface of the internal Direct3D11 object.
50+
/// Returns a pointer to the `ID3D11Buffer` interface of the internal Direct3D11 object.
5151

52-
/// The method does *NOT* increment the reference counter of the returned object,
53-
/// so Release() must not be called.
52+
/// The method does **NOT** increment the reference counter of the returned object,
53+
/// so Release() **must not** be called.
5454
VIRTUAL ID3D11Buffer* METHOD(GetD3D11TilePool)(THIS) CONST PURE;
5555
};
5656
DILIGENT_END_INTERFACE

‎Graphics/GraphicsEngineD3D11/interface/EngineFactoryD3D11.h‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryD3D11, IEngineFactory)
6464
/// the created device will be written.
6565
/// \param [out] ppContexts - Address of the memory location where pointers to
6666
/// the contexts will be written. Immediate context goes at
67-
/// position 0. If EngineCI.NumDeferredContexts > 0,
67+
/// position 0. If `EngineCI.NumDeferredContexts > 0`,
6868
/// pointers to deferred contexts are written afterwards.
6969
VIRTUAL void METHOD(CreateDeviceAndContextsD3D11)(THIS_
7070
const EngineD3D11CreateInfo REF EngineCI,
@@ -80,9 +80,9 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryD3D11, IEngineFactory)
8080
/// \param [in] FSDesc - Fullscreen mode description.
8181
/// \param [in] Window - Platform-specific native window description that
8282
/// the swap chain will be associated with:
83-
/// * On Win32 platform, this is the window handle (HWND)
83+
/// * On Win32 platform, this is the window handle (`HWND`)
8484
/// * On Universal Windows Platform, this is the reference
85-
/// to the core window (Windows::UI::Core::CoreWindow)
85+
/// to the core window (`Windows::UI::Core::CoreWindow`)
8686
///
8787
/// \param [out] ppSwapChain - Address of the memory location where pointer to the new
8888
/// swap chain will be written.
@@ -104,7 +104,7 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryD3D11, IEngineFactory)
104104
/// the created device will be written.
105105
/// \param [out] ppContexts - Address of the memory location where pointers to
106106
/// the contexts will be written. Immediate context goes at
107-
/// position 0. If EngineCI.NumDeferredContexts > 0,
107+
/// position 0. If `EngineCI.NumDeferredContexts > 0`,
108108
/// pointers to the deferred contexts are written afterwards.
109109
VIRTUAL void METHOD(AttachToD3D11Device)(THIS_
110110
void* pd3d11NativeDevice,
@@ -120,11 +120,11 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryD3D11, IEngineFactory)
120120
/// \param [in] AdapterId - Id of the adapter enumerated by EnumerateAdapters().
121121
/// \param [in] OutputId - Adapter output id.
122122
/// \param [in] Format - Display mode format.
123-
/// \param [in, out] NumDisplayModes - Number of display modes. If DisplayModes is null, this
123+
/// \param [in, out] NumDisplayModes - Number of display modes. If `DisplayModes` is null, this
124124
/// value is overwritten with the number of display modes
125-
/// available for this output. If DisplayModes is not null,
125+
/// available for this output. If `DisplayModes` is not null,
126126
/// this value should contain the maximum number of elements
127-
/// to be written to DisplayModes array. It is overwritten with
127+
/// to be written to `DisplayModes` array. It is overwritten with
128128
/// the actual number of display modes written.
129129
VIRTUAL void METHOD(EnumerateDisplayModes)(THIS_
130130
Version MinFeatureLevel,

‎Graphics/GraphicsEngineD3D11/interface/PipelineStateD3D11.h‎

Lines changed: 31 additions & 31 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");
@@ -48,67 +48,67 @@ static DILIGENT_CONSTEXPR struct INTERFACE_ID IID_PipelineStateD3D11 =
4848
/// Exposes Direct3D11-specific functionality of a pipeline state object.
4949
DILIGENT_BEGIN_INTERFACE(IPipelineStateD3D11, IPipelineState)
5050
{
51-
/// Returns a pointer to the ID3D11BlendState interface of the internal Direct3D11 object.
51+
/// Returns a pointer to the `ID3D11BlendState` interface of the internal Direct3D11 object.
5252

53-
/// The method does *NOT* increment the reference counter of the returned object,
54-
/// so Release() must not be called.
53+
/// The method does **NOT** increment the reference counter of the returned object,
54+
/// so Release() **must not** be called.
5555
VIRTUAL ID3D11BlendState* METHOD(GetD3D11BlendState)(THIS) PURE;
5656

5757

58-
/// Returns a pointer to the ID3D11RasterizerState interface of the internal Direct3D11 object.
58+
/// Returns a pointer to the `ID3D11RasterizerState` interface of the internal Direct3D11 object.
5959

60-
/// The method does *NOT* increment the reference counter of the returned object,
61-
/// so Release() must not be called.
60+
/// The method does **NOT** increment the reference counter of the returned object,
61+
/// so Release() **must not** be called.
6262
VIRTUAL ID3D11RasterizerState* METHOD(GetD3D11RasterizerState)(THIS) PURE;
6363

6464

65-
/// Returns a pointer to the ID3D11DepthStencilState interface of the internal Direct3D11 object.
65+
/// Returns a pointer to the `ID3D11DepthStencilState` interface of the internal Direct3D11 object.
6666

67-
/// The method does *NOT* increment the reference counter of the returned object,
68-
/// so Release() must not be called.
67+
/// The method does **NOT** increment the reference counter of the returned object,
68+
/// so Release() **must not** be called.
6969
VIRTUAL ID3D11DepthStencilState* METHOD(GetD3D11DepthStencilState)(THIS) PURE;
7070

71-
/// Returns a pointer to the ID3D11InputLayout interface of the internal Direct3D11 object.
71+
/// Returns a pointer to the `ID3D11InputLayout` interface of the internal Direct3D11 object.
7272

73-
/// The method does *NOT* increment the reference counter of the returned object,
74-
/// so Release() must not be called.
73+
/// The method does **NOT** increment the reference counter of the returned object,
74+
/// so Release() **must not** be called.
7575
VIRTUAL ID3D11InputLayout* METHOD(GetD3D11InputLayout)(THIS) PURE;
7676

77-
/// Returns a pointer to the ID3D11VertexShader interface of the internal vertex shader object.
77+
/// Returns a pointer to the `ID3D11VertexShader` interface of the internal vertex shader object.
7878

79-
/// The method does *NOT* increment the reference counter of the returned object,
80-
/// so Release() must not be called.
79+
/// The method does **NOT** increment the reference counter of the returned object,
80+
/// so Release() **must not** be called.
8181
VIRTUAL ID3D11VertexShader* METHOD(GetD3D11VertexShader)(THIS) PURE;
8282

83-
/// Returns a pointer to the ID3D11PixelShader interface of the internal pixel shader object.
83+
/// Returns a pointer to the `ID3D11PixelShader` interface of the internal pixel shader object.
8484

85-
/// The method does *NOT* increment the reference counter of the returned object,
86-
/// so Release() must not be called.
85+
/// The method does **NOT** increment the reference counter of the returned object,
86+
/// so Release() **must not** be called.
8787
VIRTUAL ID3D11PixelShader* METHOD(GetD3D11PixelShader)(THIS) PURE;
8888

8989

90-
/// Returns a pointer to the ID3D11GeometryShader interface of the internal geometry shader object.
90+
/// Returns a pointer to the `ID3D11GeometryShader` interface of the internal geometry shader object.
9191

92-
/// The method does *NOT* increment the reference counter of the returned object,
93-
/// so Release() must not be called.
92+
/// The method does **NOT** increment the reference counter of the returned object,
93+
/// so Release() **must not** be called.
9494
VIRTUAL ID3D11GeometryShader* METHOD(GetD3D11GeometryShader)(THIS) PURE;
9595

96-
/// Returns a pointer to the ID3D11DomainShader interface of the internal domain shader object.
96+
/// Returns a pointer to the `ID3D11DomainShader` interface of the internal domain shader object.
9797

98-
/// The method does *NOT* increment the reference counter of the returned object,
99-
/// so Release() must not be called.
98+
/// The method does **NOT** increment the reference counter of the returned object,
99+
/// so Release() **must not** be called.
100100
VIRTUAL ID3D11DomainShader* METHOD(GetD3D11DomainShader)(THIS) PURE;
101101

102-
/// Returns a pointer to the ID3D11HullShader interface of the internal hull shader object.
102+
/// Returns a pointer to the `ID3D11HullShader` interface of the internal hull shader object.
103103

104-
/// The method does *NOT* increment the reference counter of the returned object,
105-
/// so Release() must not be called.
104+
/// The method does **NOT** increment the reference counter of the returned object,
105+
/// so Release() **must not** be called.
106106
VIRTUAL ID3D11HullShader* METHOD(GetD3D11HullShader)(THIS) PURE;
107107

108-
/// Returns a pointer to the ID3D11ComputeShader interface of the internal compute shader object.
108+
/// Returns a pointer to the `ID3D11ComputeShader` interface of the internal compute shader object.
109109

110-
/// The method does *NOT* increment the reference counter of the returned object,
111-
/// so Release() must not be called.
110+
/// The method does **NOT** increment the reference counter of the returned object,
111+
/// so Release() **must not** be called.
112112
VIRTUAL ID3D11ComputeShader* METHOD(GetD3D11ComputeShader)(THIS) PURE;
113113
};
114114
DILIGENT_END_INTERFACE

‎Graphics/GraphicsEngineD3D11/interface/QueryD3D11.h‎

Lines changed: 3 additions & 3 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");
@@ -53,9 +53,9 @@ DILIGENT_BEGIN_INTERFACE(IQueryD3D11, IQuery)
5353
/// Returns a pointer to the internal ID3D11Query object.
5454

5555
/// \param [in] QueryId - Query Id. For most query types this must be 0. An exception is
56-
/// QUERY_TYPE_DURATION, in which case allowed values are 0 for the
56+
/// Diligent::QUERY_TYPE_DURATION, in which case allowed values are 0 for the
5757
/// beginning timestamp query, and 1 for the ending query.
58-
/// \return pointer to the ID3D11Query object.
58+
/// \return A pointer to the `ID3D11Query` object.
5959
VIRTUAL ID3D11Query* METHOD(GetD3D11Query)(THIS_
6060
Uint32 QueryId) PURE;
6161
};

‎Graphics/GraphicsEngineD3D11/interface/RenderDeviceD3D11.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 struct INTERFACE_ID IID_RenderDeviceD3D11 =
5050
/// Exposes Direct3D11-specific functionality of a render device.
5151
DILIGENT_BEGIN_INTERFACE(IRenderDeviceD3D11, IRenderDevice)
5252
{
53-
/// Returns a pointer to the ID3D11Device interface of the internal Direct3D11 object.
53+
/// Returns a pointer to the `ID3D11Device` interface of the internal Direct3D11 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 ID3D11Device* METHOD(GetD3D11Device)(THIS) PURE;
5858

5959
/// Creates a buffer object from native d3d11 buffer

‎Graphics/GraphicsEngineD3D11/interface/SamplerD3D11.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");
@@ -48,10 +48,10 @@ static DILIGENT_CONSTEXPR struct INTERFACE_ID IID_SamplerD3D11 =
4848
/// Exposes Direct3D11-specific functionality of a sampler object.
4949
DILIGENT_BEGIN_INTERFACE(ISamplerD3D11, ISampler)
5050
{
51-
/// Returns a pointer to the ID3D11SamplerState interface of the internal Direct3D11 object.
51+
/// Returns a pointer to the `ID3D11SamplerState` interface of the internal Direct3D11 object.
5252

53-
/// The method does *NOT* increment the reference counter of the returned object,
54-
/// so Release() must not be called.
53+
/// The method does **NOT** increment the reference counter of the returned object,
54+
/// so Release() **must not** be called.
5555
VIRTUAL ID3D11SamplerState* METHOD(GetD3D11SamplerState)(THIS) PURE;
5656
};
5757
DILIGENT_END_INTERFACE

‎Graphics/GraphicsEngineD3D11/interface/ShaderD3D11.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");
@@ -48,10 +48,10 @@ static DILIGENT_CONSTEXPR struct INTERFACE_ID IID_ShaderD3D11 =
4848
/// Exposes Direct3D11-specific functionality of a shader object.
4949
DILIGENT_BEGIN_INTERFACE(IShaderD3D11, IShaderD3D)
5050
{
51-
/// Returns a pointer to the ID3D11DeviceChild interface of the internal Direct3D11 object.
51+
/// Returns a pointer to the `ID3D11DeviceChild` interface of the internal Direct3D11 object.
5252

53-
/// The method does *NOT* increment the reference counter of the returned object,
54-
/// so Release() must not be called.
53+
/// The method does **NOT** increment the reference counter of the returned object,
54+
/// so Release() **must not** be called.
5555
VIRTUAL ID3D11DeviceChild* METHOD(GetD3D11Shader)(THIS) PURE;
5656
};
5757
DILIGENT_END_INTERFACE

0 commit comments

Comments
 (0)