summaryrefslogtreecommitdiffstats
path: root/Graphics/GraphicsEngine
diff options
context:
space:
mode:
authorassiduous <assiduous@diligentgraphics.com>2020-08-23 04:22:57 +0000
committerassiduous <assiduous@diligentgraphics.com>2020-08-23 04:22:57 +0000
commit8fb7fe089599b48706ff82b32aeb79434c6d6be0 (patch)
tree90d14c6756369a7e80742629cabf10d5b17e96e9 /Graphics/GraphicsEngine
parentImplemented mapping of unified buffers in Vulkan backend (diff)
downloadDiligentCore-8fb7fe089599b48706ff82b32aeb79434c6d6be0.tar.gz
DiligentCore-8fb7fe089599b48706ff82b32aeb79434c6d6be0.zip
Updated description of USAGE_UNIFIED enum value
Diffstat (limited to 'Graphics/GraphicsEngine')
-rw-r--r--Graphics/GraphicsEngine/interface/GraphicsTypes.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/Graphics/GraphicsEngine/interface/GraphicsTypes.h b/Graphics/GraphicsEngine/interface/GraphicsTypes.h
index b80a6712..1d16ac82 100644
--- a/Graphics/GraphicsEngine/interface/GraphicsTypes.h
+++ b/Graphics/GraphicsEngine/interface/GraphicsTypes.h
@@ -124,13 +124,17 @@ DILIGENT_TYPED_ENUM(USAGE, Uint8)
/// A resource residing in a unified memory (e.g. memory shared between CPU and GPU),
/// that can be read and written by GPU and can also be directly accessed by CPU.
- /// \remarks Unified buffers must use at least one of CPU_ACCESS_WRITE or CPU_ACCESS_READ flags.\n
+ ///
+ /// \remarks Unified resources must use at least one of CPU_ACCESS_WRITE or CPU_ACCESS_READ flags.\n
/// If it is not possible to create a unified resource, the engine will attempt to create a non-unified
- /// resource as below:
+ /// resource as follows:
/// - If CPU_ACCESS_WRITE flag is specified, default-usage resource will be created.
/// - If CPU_ACCESS_READ flag is specified, staging resource will be created.
/// - If both CPU_ACCESS_WRITE and CPU_ACCESS_READ flags are used, an error will be generated.
/// An application must check the actual usage after the resource has been created.
+ ///
+ /// Unified buffers are natively supported in Vulkan backend only. In other backends
+ /// they decay into default or staging buffers as described above.
USAGE_UNIFIED,
/// Helper value indicating the total number of elements in the enum