summaryrefslogtreecommitdiffstats
path: root/Graphics/GraphicsEngineOpenGL
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/GraphicsEngineOpenGL
parentUpdated comments in Direct3D12 backend implementation (diff)
downloadDiligentCore-37515eb550a73b935b96187362ca6bf1a7177e6c.tar.gz
DiligentCore-37515eb550a73b935b96187362ca6bf1a7177e6c.zip
Updated descriptions of backend-specific interfaces
Diffstat (limited to 'Graphics/GraphicsEngineOpenGL')
-rw-r--r--Graphics/GraphicsEngineOpenGL/interface/BufferGL.h2
-rw-r--r--Graphics/GraphicsEngineOpenGL/interface/BufferViewGL.h2
-rw-r--r--Graphics/GraphicsEngineOpenGL/interface/DeviceContextGL.h2
-rw-r--r--Graphics/GraphicsEngineOpenGL/interface/FenceGL.h2
-rw-r--r--Graphics/GraphicsEngineOpenGL/interface/PipelineStateGL.h2
-rw-r--r--Graphics/GraphicsEngineOpenGL/interface/RenderDeviceGL.h2
-rw-r--r--Graphics/GraphicsEngineOpenGL/interface/SamplerGL.h2
-rw-r--r--Graphics/GraphicsEngineOpenGL/interface/ShaderGL.h2
-rw-r--r--Graphics/GraphicsEngineOpenGL/interface/ShaderResourceBindingGL.h3
-rw-r--r--Graphics/GraphicsEngineOpenGL/interface/SwapChainGL.h2
-rw-r--r--Graphics/GraphicsEngineOpenGL/interface/TextureGL.h2
-rw-r--r--Graphics/GraphicsEngineOpenGL/interface/TextureViewGL.h2
12 files changed, 12 insertions, 13 deletions
diff --git a/Graphics/GraphicsEngineOpenGL/interface/BufferGL.h b/Graphics/GraphicsEngineOpenGL/interface/BufferGL.h
index 0acd392c..5cee7cfc 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/BufferGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/BufferGL.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_BufferGL =
{ 0x8df7319, 0xf425, 0x4ec7, { 0x8d, 0x2b, 0x1b, 0x3f, 0xc0, 0xbd, 0xdb, 0xb4 } };
-/// Interface to the buffer object implemented in OpenGL
+/// Exposes OpenGL-specific functionality of a buffer object.
class IBufferGL : public IBuffer
{
public:
diff --git a/Graphics/GraphicsEngineOpenGL/interface/BufferViewGL.h b/Graphics/GraphicsEngineOpenGL/interface/BufferViewGL.h
index 6edee058..f4a868ae 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/BufferViewGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/BufferViewGL.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_BufferViewGL =
{ 0x927a865b, 0x3ceb, 0x4743, { 0x9a, 0x22, 0x2a, 0x13, 0x97, 0xa7, 0x3e, 0x6d } };
-/// Interface to the buffer view object implemented in OpenGL
+/// Exposes OpenGL-specific functionality of a buffer view object.
class IBufferViewGL : public IBufferView
{
public:
diff --git a/Graphics/GraphicsEngineOpenGL/interface/DeviceContextGL.h b/Graphics/GraphicsEngineOpenGL/interface/DeviceContextGL.h
index eca66a14..7964d6c5 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/DeviceContextGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/DeviceContextGL.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_DeviceContextGL =
{ 0x3464fdf1, 0xc548, 0x4935, { 0x96, 0xc3, 0xb4, 0x54, 0xc9, 0xdf, 0x6f, 0x6a } };
-/// Interface to the device context object implemented in OpenGL
+/// Exposes OpenGL-specific functionality of a device context.
class IDeviceContextGL : public IDeviceContext
{
public:
diff --git a/Graphics/GraphicsEngineOpenGL/interface/FenceGL.h b/Graphics/GraphicsEngineOpenGL/interface/FenceGL.h
index bf073b43..75b7e417 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/FenceGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/FenceGL.h
@@ -36,7 +36,7 @@ static constexpr INTERFACE_ID IID_FenceGL =
{ 0x8feacbda, 0x89d6, 0x4509, { 0x88, 0xe6, 0xd5, 0x5d, 0xd0, 0x62, 0x20, 0xc5 } };
-/// Interface to the fence object implemented in GL
+/// Exposes OpenGL-specific functionality of a fence object.
class IFenceGL : public IFence
{
public:
diff --git a/Graphics/GraphicsEngineOpenGL/interface/PipelineStateGL.h b/Graphics/GraphicsEngineOpenGL/interface/PipelineStateGL.h
index cfa877bb..af71065f 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/PipelineStateGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/PipelineStateGL.h
@@ -36,7 +36,7 @@ static constexpr INTERFACE_ID IID_PipelineStateGL =
{ 0x80666be3, 0x318a, 0x4403, { 0xae, 0xe1, 0x6e, 0x61, 0xa5, 0xb7, 0xa0, 0xf9 } };
-/// Interface to the PipelineState object implemented in OpenGL
+/// Exposes OpenGL-specific functionality of a pipeline state object.
class IPipelineStateGL : public IPipelineState
{
diff --git a/Graphics/GraphicsEngineOpenGL/interface/RenderDeviceGL.h b/Graphics/GraphicsEngineOpenGL/interface/RenderDeviceGL.h
index 844b7f46..bb847d8b 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/RenderDeviceGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/RenderDeviceGL.h
@@ -36,7 +36,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_RenderDeviceGL =
{ 0xb4b395b9, 0xac99, 0x4e8a, { 0xb7, 0xe1, 0x9d, 0xca, 0xd, 0x48, 0x56, 0x18 } };
-/// Interface to the render device object implemented in OpenGL
+/// Exposes OpenGL-specific functionality of a render device.
class IRenderDeviceGL : public IRenderDevice
{
public:
diff --git a/Graphics/GraphicsEngineOpenGL/interface/SamplerGL.h b/Graphics/GraphicsEngineOpenGL/interface/SamplerGL.h
index acaf8843..f7f9a53a 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/SamplerGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/SamplerGL.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_SamplerGL =
{ 0x3e9eb89e, 0xe955, 0x447a, { 0x9d, 0x13, 0x92, 0xc1, 0x5, 0x41, 0xf7, 0x27 } };
-/// Interface to the sampler object object implemented in OpenGL
+/// Exposes OpenGL-specific functionality of a sampler object.
class ISamplerGL : public ISampler
{
public:
diff --git a/Graphics/GraphicsEngineOpenGL/interface/ShaderGL.h b/Graphics/GraphicsEngineOpenGL/interface/ShaderGL.h
index 11c5d6be..02dfd1e9 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/ShaderGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/ShaderGL.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_ShaderGL =
{ 0x2ff3c191, 0x285b, 0x4e6c, { 0xbd, 0xb, 0xd0, 0x84, 0xdd, 0xea, 0x6f, 0xcc } };
-/// Interface to the shader object implemented in OpenGL
+/// Exposes OpenGL-specific functionality of a shader object.
class IShaderGL : public IShader
{
public:
diff --git a/Graphics/GraphicsEngineOpenGL/interface/ShaderResourceBindingGL.h b/Graphics/GraphicsEngineOpenGL/interface/ShaderResourceBindingGL.h
index 7e94683e..a3ae21ba 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/ShaderResourceBindingGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/ShaderResourceBindingGL.h
@@ -35,8 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_ShaderResourceBindingGL =
{ 0x41db0329, 0xb6d2, 0x4470, { 0x9a, 0x58, 0xd4, 0x4c, 0xf4, 0x69, 0x5f, 0xc6 } };
-/// Shader resource binding interface
-
+/// Exposes OpenGL-specific functionality of a shader resource binding object.
class IShaderResourceBindingGL : public IShaderResourceBinding
{
public:
diff --git a/Graphics/GraphicsEngineOpenGL/interface/SwapChainGL.h b/Graphics/GraphicsEngineOpenGL/interface/SwapChainGL.h
index 340b42fb..7c1e466a 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/SwapChainGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/SwapChainGL.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_SwapChainGL =
{ 0xf457bd7c, 0xe725, 0x4d3e, { 0x86, 0x7, 0xa1, 0xf9, 0xba, 0xe3, 0x29, 0xeb } };
-/// Interface to the swap chain object implemented in OpenGL
+/// Exposes OpenGL-specific functionality of a swap chain.
class ISwapChainGL : public ISwapChain
{
public:
diff --git a/Graphics/GraphicsEngineOpenGL/interface/TextureGL.h b/Graphics/GraphicsEngineOpenGL/interface/TextureGL.h
index c629a5a3..fd09d80e 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/TextureGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/TextureGL.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_TextureGL =
{ 0xd7bc9ff0, 0x28f0, 0x4636, { 0x97, 0x32, 0x71, 0xc, 0x20, 0x4d, 0x1d, 0x63 } };
-/// Interface to the texture object implemented in OpenGL
+/// Exposes OpenGL-specific functionality of a texture object.
class ITextureGL : public ITexture
{
public:
diff --git a/Graphics/GraphicsEngineOpenGL/interface/TextureViewGL.h b/Graphics/GraphicsEngineOpenGL/interface/TextureViewGL.h
index f41b3ae1..1ad723c4 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/TextureViewGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/TextureViewGL.h
@@ -35,7 +35,7 @@ namespace Diligent
static constexpr INTERFACE_ID IID_TextureViewGL =
{ 0x15f93272, 0x6135, 0x414f, { 0xab, 0x10, 0x53, 0xff, 0x9a, 0x50, 0x4, 0xad } };
-/// Interface to the texture view object implemented in OpenGL
+/// Exposes OpenGL-specific functionality of a texture view object.
class ITextureViewGL : public ITextureView
{
public: