summaryrefslogtreecommitdiffstats
path: root/Graphics/GraphicsEngineVulkan
diff options
context:
space:
mode:
authorEgor Yusov <egor.yusov@gmail.com>2019-11-09 03:00:58 +0000
committerEgor Yusov <egor.yusov@gmail.com>2019-11-09 03:00:58 +0000
commit37515eb550a73b935b96187362ca6bf1a7177e6c (patch)
treec407db30f746601e27028bdef41044a1715fbbb8 /Graphics/GraphicsEngineVulkan
parentUpdated comments in Direct3D12 backend implementation (diff)
downloadDiligentCore-37515eb550a73b935b96187362ca6bf1a7177e6c.tar.gz
DiligentCore-37515eb550a73b935b96187362ca6bf1a7177e6c.zip
Updated descriptions of backend-specific interfaces
Diffstat (limited to 'Graphics/GraphicsEngineVulkan')
-rw-r--r--Graphics/GraphicsEngineVulkan/interface/BufferViewVk.h2
-rw-r--r--Graphics/GraphicsEngineVulkan/interface/BufferVk.h3
-rw-r--r--Graphics/GraphicsEngineVulkan/interface/DeviceContextVk.h2
-rw-r--r--Graphics/GraphicsEngineVulkan/interface/FenceVk.h2
-rw-r--r--Graphics/GraphicsEngineVulkan/interface/PipelineStateVk.h2
-rw-r--r--Graphics/GraphicsEngineVulkan/interface/RenderDeviceVk.h2
-rw-r--r--Graphics/GraphicsEngineVulkan/interface/SamplerVk.h2
-rw-r--r--Graphics/GraphicsEngineVulkan/interface/ShaderResourceBindingVk.h2
-rw-r--r--Graphics/GraphicsEngineVulkan/interface/ShaderVk.h2
-rw-r--r--Graphics/GraphicsEngineVulkan/interface/SwapChainVk.h2
-rw-r--r--Graphics/GraphicsEngineVulkan/interface/TextureViewVk.h2
-rw-r--r--Graphics/GraphicsEngineVulkan/interface/TextureVk.h2
12 files changed, 12 insertions, 13 deletions
diff --git a/Graphics/GraphicsEngineVulkan/interface/BufferViewVk.h b/Graphics/GraphicsEngineVulkan/interface/BufferViewVk.h
index 3a9c6d6f..5a896321 100644
--- a/Graphics/GraphicsEngineVulkan/interface/BufferViewVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/BufferViewVk.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_BufferViewVk =
{ 0xcb67024a, 0x1e23, 0x4202,{ 0xa4, 0x9a, 0x7, 0xb6, 0xbc, 0xea, 0xbc, 0x6 } };
-/// Interface to the buffer view object implemented in Vulkan
+/// Exposes Vulkan-specific functionality of a buffer view object.
class IBufferViewVk : public IBufferView
{
public:
diff --git a/Graphics/GraphicsEngineVulkan/interface/BufferVk.h b/Graphics/GraphicsEngineVulkan/interface/BufferVk.h
index 0436962f..f17ced0f 100644
--- a/Graphics/GraphicsEngineVulkan/interface/BufferVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/BufferVk.h
@@ -35,8 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_BufferVk =
{ 0x12d8ec02, 0x96f4, 0x431e,{ 0x96, 0x95, 0xc5, 0xf5, 0x72, 0xcc, 0x75, 0x87 } };
-
-/// Interface to the buffer object implemented in Vulkan
+/// Exposes Vulkan-specific functionality of a buffer object.
class IBufferVk : public IBuffer
{
public:
diff --git a/Graphics/GraphicsEngineVulkan/interface/DeviceContextVk.h b/Graphics/GraphicsEngineVulkan/interface/DeviceContextVk.h
index a00e8372..0218c143 100644
--- a/Graphics/GraphicsEngineVulkan/interface/DeviceContextVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/DeviceContextVk.h
@@ -36,7 +36,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_DeviceContextVk =
{ 0x72aeb1ba, 0xc6ad, 0x42ec,{ 0x88, 0x11, 0x7e, 0xd9, 0xc7, 0x21, 0x76, 0xbb } };
-/// Interface to the device context object implemented in Vulkan
+/// Exposes Vulkan-specific functionality of a device context.
class IDeviceContextVk : public IDeviceContext
{
public:
diff --git a/Graphics/GraphicsEngineVulkan/interface/FenceVk.h b/Graphics/GraphicsEngineVulkan/interface/FenceVk.h
index 9e6c2374..3ee4b944 100644
--- a/Graphics/GraphicsEngineVulkan/interface/FenceVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/FenceVk.h
@@ -36,7 +36,7 @@ static constexpr INTERFACE_ID IID_FenceVk =
{ 0x7610b4cd, 0xedea, 0x4951, { 0x82, 0xcf, 0x52, 0xf9, 0x7f, 0xaf, 0xed, 0x2d } };
-/// Interface to the fence object implemented in GL
+/// Exposes Vulkan-specific functionality of a fence object.
class IFenceVk : public IFence
{
public:
diff --git a/Graphics/GraphicsEngineVulkan/interface/PipelineStateVk.h b/Graphics/GraphicsEngineVulkan/interface/PipelineStateVk.h
index 8fc006ba..492022c9 100644
--- a/Graphics/GraphicsEngineVulkan/interface/PipelineStateVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/PipelineStateVk.h
@@ -36,7 +36,7 @@ static constexpr INTERFACE_ID IID_PipelineStateVk =
{ 0x2fea0868, 0x932, 0x412a,{ 0x9f, 0xa, 0x7c, 0xea, 0x7e, 0x61, 0xb5, 0xe0 } };
-/// Interface to the blend state object implemented in Vulkan
+/// Exposes Vulkan-specific functionality of a pipeline state object.
class IPipelineStateVk : public IPipelineState
{
public:
diff --git a/Graphics/GraphicsEngineVulkan/interface/RenderDeviceVk.h b/Graphics/GraphicsEngineVulkan/interface/RenderDeviceVk.h
index 00562c79..4e24d246 100644
--- a/Graphics/GraphicsEngineVulkan/interface/RenderDeviceVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/RenderDeviceVk.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_RenderDeviceVk =
{ 0xab8cf3a6, 0xd959, 0x41c1,{ 0xae, 0x0, 0xa5, 0x8a, 0xe9, 0x82, 0xe, 0x6a } };
-/// Interface to the render device object implemented in Vulkan
+/// Exposes Vulkan-specific functionality of a render device.
class IRenderDeviceVk : public IRenderDevice
{
public:
diff --git a/Graphics/GraphicsEngineVulkan/interface/SamplerVk.h b/Graphics/GraphicsEngineVulkan/interface/SamplerVk.h
index fc1c8341..9ca14a5b 100644
--- a/Graphics/GraphicsEngineVulkan/interface/SamplerVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/SamplerVk.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_SamplerVk =
{ 0x87c21e88, 0x8a9f, 0x4ad2,{ 0x9a, 0x1e, 0xd5, 0xec, 0x14, 0x4, 0x15, 0xea } };
-/// Interface to the sampler object implemented in Vulkan
+/// Exposes Vulkan-specific functionality of a sampler object.
class ISamplerVk : public ISampler
{
public:
diff --git a/Graphics/GraphicsEngineVulkan/interface/ShaderResourceBindingVk.h b/Graphics/GraphicsEngineVulkan/interface/ShaderResourceBindingVk.h
index 910a1779..370869e1 100644
--- a/Graphics/GraphicsEngineVulkan/interface/ShaderResourceBindingVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/ShaderResourceBindingVk.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_ShaderResourceBindingVk =
{ 0x1e8c82dc, 0x5b3a, 0x47d5,{ 0x8a, 0xe9, 0x19, 0x7c, 0xae, 0x8d, 0xb7, 0x1f } };
-/// Shader resource binding interface
+/// Exposes Vulkan-specific functionality of a shader resource binding object.
class IShaderResourceBindingVk : public IShaderResourceBinding
{
public:
diff --git a/Graphics/GraphicsEngineVulkan/interface/ShaderVk.h b/Graphics/GraphicsEngineVulkan/interface/ShaderVk.h
index 11f2d5af..232e00b0 100644
--- a/Graphics/GraphicsEngineVulkan/interface/ShaderVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/ShaderVk.h
@@ -36,7 +36,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_ShaderVk =
{ 0x8b0c91b4, 0xb1d8, 0x4e03,{ 0x92, 0x50, 0xa7, 0xe, 0x13, 0x1a, 0x59, 0xfa } };
-/// Interface to the shader object implemented in Vulkan
+/// Exposes Vulkan-specific functionality of a shader object.
class IShaderVk : public IShader
{
public:
diff --git a/Graphics/GraphicsEngineVulkan/interface/SwapChainVk.h b/Graphics/GraphicsEngineVulkan/interface/SwapChainVk.h
index 6bb1c9c7..470c5144 100644
--- a/Graphics/GraphicsEngineVulkan/interface/SwapChainVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/SwapChainVk.h
@@ -38,7 +38,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_SwapChainVk =
{ 0x22a39881, 0x5ec5, 0x4a9c,{ 0x83, 0x95, 0x90, 0x21, 0x5f, 0x4, 0xa5, 0xcc } };
-/// Interface to the swap chain object implemented in Vulkan
+/// Exposes Vulkan-specific functionality of a swap chain.
class ISwapChainVk : public ISwapChain
{
public:
diff --git a/Graphics/GraphicsEngineVulkan/interface/TextureViewVk.h b/Graphics/GraphicsEngineVulkan/interface/TextureViewVk.h
index 4e2bdc26..0092b02d 100644
--- a/Graphics/GraphicsEngineVulkan/interface/TextureViewVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/TextureViewVk.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_TextureViewVk =
{ 0xb02aa468, 0x3328, 0x46f3,{ 0x97, 0x77, 0x55, 0xe9, 0x7b, 0xf6, 0xc8, 0x6e } };
-/// Interface to the texture view object implemented in Vulkan
+/// Exposes Vulkan-specific functionality of a texture view object.
class ITextureViewVk : public ITextureView
{
public:
diff --git a/Graphics/GraphicsEngineVulkan/interface/TextureVk.h b/Graphics/GraphicsEngineVulkan/interface/TextureVk.h
index 34dc0b47..3900032f 100644
--- a/Graphics/GraphicsEngineVulkan/interface/TextureVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/TextureVk.h
@@ -36,7 +36,7 @@ static constexpr INTERFACE_ID IID_TextureVk =
{ 0x3bb9155f, 0x22c5, 0x4365,{ 0x92, 0x7e, 0x8c, 0x40, 0x49, 0xf9, 0xb9, 0x49 } };
-/// Interface to the texture object implemented in Vulkan
+/// Exposes Vulkan-specific functionality of a texture object.
class ITextureVk : public ITexture
{
public: