Browse Source

Updating documentation added in previous commit

Marko Pintera 11 years ago
parent
commit
35243f5eba
2 changed files with 15 additions and 0 deletions
  1. 10 0
      CamelotCore/Include/CmGpuBuffer.h
  2. 5 0
      CamelotCore/Include/CmGpuBufferView.h

+ 10 - 0
CamelotCore/Include/CmGpuBuffer.h

@@ -12,6 +12,16 @@ namespace BansheeEngine
 	 *			to the GPU. These buffers may be bounds to GPU program binding slots and accessed from a GPU program,
 	 *			or may be used by fixed pipeline in some way.
 	 *
+	 *			Buffer types:
+	 *			  - Raw buffers containing a block of bytes that are up to the GPU program to interpret.
+	 *			  - Structured buffer containing an array of structures compliant to a certain layout. Similar to raw
+	 *				buffer but easier to interpret the data.
+	 *			  - Random read/write buffers that allow you to write to random parts of the buffer from within
+	 *				the GPU program, and then read it later. These can only be bound to pixel and compute stages.
+	 *			  - Append/Consume buffers also allow you to write to them, but in a stack-like fashion, usually where one set
+	 *				of programs produces data while other set consumes it from the same buffer. Append/Consume buffers are structured
+	 *				by default.
+	 *
 	 * @note	Core thread only.
 	 */
 	class CM_EXPORT GpuBuffer : public CoreObject

+ 5 - 0
CamelotCore/Include/CmGpuBufferView.h

@@ -23,6 +23,11 @@ namespace BansheeEngine
 	/**
 	 * @brief	Holds information about a GPU buffer view. Views allow you to specify
 	 *			how is data in a buffer organized to make it easier for the pipeline to interpret.
+	 *			
+	 * @note	Buffers don't get bound to the pipeline directly, views do.
+	 *			Core thread only.
+	 *
+	 * @see		GpuBuffer
 	 */
 	class CM_EXPORT GpuBufferView
 	{