Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClément Foucault <foucault.clem@gmail.com>2020-08-21 15:14:56 +0300
committerClément Foucault <foucault.clem@gmail.com>2020-08-21 15:16:42 +0300
commit3a6e981bcd579b3fda039ff33f95d4baacc96465 (patch)
tree78350c493d69fb9aef14096e9bd960a66d730390 /source/blender/gpu/GPU_uniform_buffer.h
parent220fbdf59341f620c06959280e2145132003c5df (diff)
Cleanup: GPU: Update classes comments
This should avoid confusion about what is a class and what is an opaque pointer.
Diffstat (limited to 'source/blender/gpu/GPU_uniform_buffer.h')
-rw-r--r--source/blender/gpu/GPU_uniform_buffer.h9
1 files changed, 8 insertions, 1 deletions
diff --git a/source/blender/gpu/GPU_uniform_buffer.h b/source/blender/gpu/GPU_uniform_buffer.h
index 2026522f2d5..4a00dda634d 100644
--- a/source/blender/gpu/GPU_uniform_buffer.h
+++ b/source/blender/gpu/GPU_uniform_buffer.h
@@ -19,6 +19,13 @@
/** \file
* \ingroup gpu
+ *
+ * Uniform buffers API. Used to handle many uniforms update at once.
+ * Make sure that the data structure is compatible with what the implementation expect.
+ * (see "7.6.2.2 Standard Uniform Block Layout" from the OpenGL spec for more info about std140
+ * layout)
+ * Rule of thumb: Padding to 16bytes, don't use vec3, don't use arrays of anything that is not vec4
+ * aligned .
*/
#pragma once
@@ -29,7 +36,7 @@ extern "C" {
struct ListBase;
-/** Opaque pointer */
+/** Opaque pointer hiding blender::gpu::UniformBuf. */
typedef struct GPUUniformBuf {
void *dummy;
} GPUUniformBuf;