From 37515eb550a73b935b96187362ca6bf1a7177e6c Mon Sep 17 00:00:00 2001
From: Egor Yusov <egor.yusov@gmail.com>
Date: Fri, 8 Nov 2019 19:00:58 -0800
Subject: Updated descriptions of backend-specific interfaces

---
 Graphics/GraphicsEngineD3D12/interface/BufferD3D12.h                | 2 +-
 Graphics/GraphicsEngineD3D12/interface/BufferViewD3D12.h            | 2 +-
 Graphics/GraphicsEngineD3D12/interface/DeviceContextD3D12.h         | 2 +-
 Graphics/GraphicsEngineD3D12/interface/FenceD3D12.h                 | 2 +-
 Graphics/GraphicsEngineD3D12/interface/PipelineStateD3D12.h         | 2 +-
 Graphics/GraphicsEngineD3D12/interface/RenderDeviceD3D12.h          | 2 +-
 Graphics/GraphicsEngineD3D12/interface/SamplerD3D12.h               | 2 +-
 Graphics/GraphicsEngineD3D12/interface/ShaderD3D12.h                | 2 +-
 Graphics/GraphicsEngineD3D12/interface/ShaderResourceBindingD3D12.h | 2 +-
 Graphics/GraphicsEngineD3D12/interface/SwapChainD3D12.h             | 2 +-
 Graphics/GraphicsEngineD3D12/interface/TextureD3D12.h               | 2 +-
 Graphics/GraphicsEngineD3D12/interface/TextureViewD3D12.h           | 2 +-
 12 files changed, 12 insertions(+), 12 deletions(-)

(limited to 'Graphics/GraphicsEngineD3D12')

diff --git a/Graphics/GraphicsEngineD3D12/interface/BufferD3D12.h b/Graphics/GraphicsEngineD3D12/interface/BufferD3D12.h
index 0d1c5e91..66a8fa82 100644
--- a/Graphics/GraphicsEngineD3D12/interface/BufferD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/BufferD3D12.h
@@ -37,7 +37,7 @@ class IDeviceContext;
 static constexpr INTERFACE_ID IID_BufferD3D12 =
 { 0x3e9b15ed, 0xa289, 0x48dc, { 0x82, 0x14, 0xc6, 0xe3, 0xe6, 0x17, 0x73, 0x78 } };
 
-/// Interface to the buffer object implemented in D3D12
+/// Exposes Direct3D12-specific functionality of a buffer object.
 class IBufferD3D12 : public IBuffer
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D12/interface/BufferViewD3D12.h b/Graphics/GraphicsEngineD3D12/interface/BufferViewD3D12.h
index 74aa9d64..c9a3b2ba 100644
--- a/Graphics/GraphicsEngineD3D12/interface/BufferViewD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/BufferViewD3D12.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_BufferViewD3D12 =
 { 0x9643f2f, 0x40d4, 0x4076, { 0xb0, 0x86, 0x9e, 0x5c, 0xdc, 0x2c, 0xc4, 0xfc } };
 
-/// Interface to the buffer view object implemented in D3D12
+/// Exposes Direct3D12-specific functionality of a buffer view object.
 class IBufferViewD3D12 : public IBufferView
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D12/interface/DeviceContextD3D12.h b/Graphics/GraphicsEngineD3D12/interface/DeviceContextD3D12.h
index 54d6abe2..616661b3 100644
--- a/Graphics/GraphicsEngineD3D12/interface/DeviceContextD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/DeviceContextD3D12.h
@@ -36,7 +36,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_DeviceContextD3D12 =
 { 0xdde9e3ab, 0x5109, 0x4026, { 0x92, 0xb7, 0xf5, 0xe7, 0xec, 0x83, 0xe2, 0x1e } };
 
-/// Interface to the device context object implemented in D3D12
+/// Exposes Direct3D12-specific functionality of a device context.
 class IDeviceContextD3D12 : public IDeviceContext
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D12/interface/FenceD3D12.h b/Graphics/GraphicsEngineD3D12/interface/FenceD3D12.h
index febdce4a..2481a58e 100644
--- a/Graphics/GraphicsEngineD3D12/interface/FenceD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/FenceD3D12.h
@@ -36,7 +36,7 @@ static constexpr INTERFACE_ID IID_FenceD3D12 =
 { 0x53c0d8c, 0x3757, 0x4220, { 0xa9, 0xcc, 0x47, 0x49, 0xec, 0x47, 0x94, 0xad } };
 
 
-/// Interface to the fence object implemented in D3D12
+/// Exposes Direct3D12-specific functionality of a fence object.
 class IFenceD3D12 : public IFence
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D12/interface/PipelineStateD3D12.h b/Graphics/GraphicsEngineD3D12/interface/PipelineStateD3D12.h
index 0f36dbaf..6cb3cf6c 100644
--- a/Graphics/GraphicsEngineD3D12/interface/PipelineStateD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/PipelineStateD3D12.h
@@ -36,7 +36,7 @@ static constexpr INTERFACE_ID IID_PipelineStateD3D12 =
 { 0x33c9be4b, 0x6f23, 0x4f83, { 0xa6, 0x65, 0x5a, 0xc1, 0x83, 0x6d, 0xf3, 0x5a } };
 
 
-/// Interface to the blend state object implemented in D3D12
+/// Exposes Direct3D12-specific functionality of a pipeline state object.
 class IPipelineStateD3D12 : public IPipelineState
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D12/interface/RenderDeviceD3D12.h b/Graphics/GraphicsEngineD3D12/interface/RenderDeviceD3D12.h
index 76d8e1b1..b9da0e34 100644
--- a/Graphics/GraphicsEngineD3D12/interface/RenderDeviceD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/RenderDeviceD3D12.h
@@ -34,7 +34,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_RenderDeviceD3D12 =
 { 0xc7987c98, 0x87fe, 0x4309, { 0xae, 0x88, 0xe9, 0x8f, 0x4, 0x4b, 0x0, 0xf6 } };
 
-/// Interface to the render device object implemented in D3D12
+/// Exposes Direct3D12-specific functionality of a render device.
 class IRenderDeviceD3D12 : public IRenderDevice
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D12/interface/SamplerD3D12.h b/Graphics/GraphicsEngineD3D12/interface/SamplerD3D12.h
index 72fe998e..ef25aa08 100644
--- a/Graphics/GraphicsEngineD3D12/interface/SamplerD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/SamplerD3D12.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_SamplerD3D12 =
 { 0x31a3bfaf, 0x738e, 0x4d8c, { 0xad, 0x18, 0xb0, 0x21, 0xc5, 0xd9, 0x48, 0xdd } };
 
-/// Interface to the sampler object implemented in D3D12
+/// Exposes Direct3D12-specific functionality of a sampler object.
 class ISamplerD3D12 : public ISampler
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D12/interface/ShaderD3D12.h b/Graphics/GraphicsEngineD3D12/interface/ShaderD3D12.h
index b80100b6..15d59b49 100644
--- a/Graphics/GraphicsEngineD3D12/interface/ShaderD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/ShaderD3D12.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_ShaderD3D12 =
 { 0xc059b160, 0x7f31, 0x4029, { 0x94, 0x3d, 0x9, 0x96, 0xb9, 0x8e, 0xe7, 0x9a } };
 
-/// Interface to the shader object implemented in D3D12
+/// Exposes Direct3D12-specific functionality of a shader object.
 class IShaderD3D12 : public IShaderD3D
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D12/interface/ShaderResourceBindingD3D12.h b/Graphics/GraphicsEngineD3D12/interface/ShaderResourceBindingD3D12.h
index 08588336..fbf3cfb4 100644
--- a/Graphics/GraphicsEngineD3D12/interface/ShaderResourceBindingD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/ShaderResourceBindingD3D12.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_ShaderResourceBindingD3D12 =
 { 0x70dd5c7c, 0x81fa, 0x4d9a, { 0x94, 0x2f, 0xd1, 0xb9, 0x14, 0x23, 0xfa, 0xac } };
 
-/// Shader resource binding interface
+/// Exposes Direct3D12-specific functionality of a shader resource binding.
 class IShaderResourceBindingD3D12 : public IShaderResourceBinding
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D12/interface/SwapChainD3D12.h b/Graphics/GraphicsEngineD3D12/interface/SwapChainD3D12.h
index 37d24aff..862d6b51 100644
--- a/Graphics/GraphicsEngineD3D12/interface/SwapChainD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/SwapChainD3D12.h
@@ -38,7 +38,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_SwapChainD3D12 =
 { 0xc9f8384d, 0xa45e, 0x4970, { 0x84, 0x47, 0x39, 0x41, 0x77, 0xe5, 0xb0, 0xee } };
 
-/// Interface to the swap chain object implemented in D3D12
+/// Exposes Direct3D12-specific functionality of a swap chain.
 class ISwapChainD3D12 : public ISwapChain
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D12/interface/TextureD3D12.h b/Graphics/GraphicsEngineD3D12/interface/TextureD3D12.h
index 6f7a9f16..d721add8 100644
--- a/Graphics/GraphicsEngineD3D12/interface/TextureD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/TextureD3D12.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_TextureD3D12 =
 { 0xcf5522ef, 0x8116, 0x4d76, { 0xad, 0xf1, 0x5c, 0xc8, 0xfb, 0x31, 0xff, 0x66 } };
 
-/// Interface to the texture object implemented in D3D12
+/// Exposes Direct3D12-specific functionality of a texture object.
 class ITextureD3D12 : public ITexture
 {
 public:
diff --git a/Graphics/GraphicsEngineD3D12/interface/TextureViewD3D12.h b/Graphics/GraphicsEngineD3D12/interface/TextureViewD3D12.h
index 0f65adf0..9e53f4ad 100644
--- a/Graphics/GraphicsEngineD3D12/interface/TextureViewD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/TextureViewD3D12.h
@@ -35,7 +35,7 @@ namespace Diligent
 static constexpr INTERFACE_ID IID_TextureViewD3D12 =
 { 0xbdfbd325, 0x699, 0x4720, { 0xbc, 0xe, 0xbf, 0x84, 0x8, 0x6e, 0xc0, 0x33 } };
 
-/// Interface to the texture view object implemented in D3D12
+/// Exposes Direct3D12-specific functionality of a texture view object.
 class ITextureViewD3D12 : public ITextureView
 {
 public:
-- 
cgit v1.2.3