diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-01-04 04:00:18 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-01-04 09:38:11 +0300 |
commit | 54f89e870425b20af14e2be03b777836b88a29af (patch) | |
tree | da5eb59c6b15979c4e62dfdafbcb38b27463d2a7 /source/blender/gpu | |
parent | 9b10b3930bd7784794e87255de390ad6e6876a4b (diff) |
Cleanup: docy comments beginning with '/**' don't end with '**/'
Diffstat (limited to 'source/blender/gpu')
21 files changed, 27 insertions, 26 deletions
diff --git a/source/blender/gpu/GPU_batch.h b/source/blender/gpu/GPU_batch.h index 6f183cd344c..85981ac8043 100644 --- a/source/blender/gpu/GPU_batch.h +++ b/source/blender/gpu/GPU_batch.h @@ -76,7 +76,7 @@ extern "C" { * IMPORTANT: Do not allocate manually as the real struct is bigger (i.e: GLBatch). This is only * the common and "public" part of the struct. Use the provided allocator. * TODO(fclem): Make the content of this struct hidden and expose getters/setters. - **/ + */ typedef struct GPUBatch { /** verts[0] is required, others can be NULL */ GPUVertBuf *verts[GPU_BATCH_VBO_MAX_LEN]; diff --git a/source/blender/gpu/GPU_primitive.h b/source/blender/gpu/GPU_primitive.h index 781a10f3636..b1d70326b45 100644 --- a/source/blender/gpu/GPU_primitive.h +++ b/source/blender/gpu/GPU_primitive.h @@ -60,7 +60,7 @@ typedef enum { * TODO Improve error checking by validating that the shader is suited for this primitive type. * GPUPrimClass GPU_primtype_class(GPUPrimType); * bool GPU_primtype_belongs_to_class(GPUPrimType, GPUPrimClass); - **/ + */ #ifdef __cplusplus } diff --git a/source/blender/gpu/intern/gpu_batch_private.hh b/source/blender/gpu/intern/gpu_batch_private.hh index c71670d4f1f..d0fbd1432b3 100644 --- a/source/blender/gpu/intern/gpu_batch_private.hh +++ b/source/blender/gpu/intern/gpu_batch_private.hh @@ -37,8 +37,9 @@ namespace gpu { /** * Base class which is then specialized for each implementation (GL, VK, ...). - * NOTE: Extends GPUBatch as we still needs to expose some of the internals to the outside C code. - **/ + * + * \note Extends #GPUBatch as we still needs to expose some of the internals to the outside C code. + */ class Batch : public GPUBatch { public: Batch(){}; diff --git a/source/blender/gpu/intern/gpu_capabilities_private.hh b/source/blender/gpu/intern/gpu_capabilities_private.hh index abe5b706a7d..3c758c4ac4a 100644 --- a/source/blender/gpu/intern/gpu_capabilities_private.hh +++ b/source/blender/gpu/intern/gpu_capabilities_private.hh @@ -33,7 +33,7 @@ namespace blender::gpu { * Only add workarounds here if they are common to all implementation or * if you need access to it outside of the GPU module. * Same goes for capabilities (i.e.: texture size) - **/ + */ struct GPUCapabilities { int max_texture_size = 0; int max_texture_layers = 0; diff --git a/source/blender/gpu/intern/gpu_drawlist_private.hh b/source/blender/gpu/intern/gpu_drawlist_private.hh index fd223c3f255..98603299d62 100644 --- a/source/blender/gpu/intern/gpu_drawlist_private.hh +++ b/source/blender/gpu/intern/gpu_drawlist_private.hh @@ -33,7 +33,7 @@ namespace gpu { /** * Implementation of Multi Draw Indirect. * Base class which is then specialized for each implementation (GL, VK, ...). - **/ + */ class DrawList { public: virtual ~DrawList(){}; diff --git a/source/blender/gpu/intern/gpu_index_buffer_private.hh b/source/blender/gpu/intern/gpu_index_buffer_private.hh index 9f1334aa4bc..7054360d07f 100644 --- a/source/blender/gpu/intern/gpu_index_buffer_private.hh +++ b/source/blender/gpu/intern/gpu_index_buffer_private.hh @@ -44,9 +44,9 @@ static inline size_t to_bytesize(GPUIndexBufType type) /** * Base class which is then specialized for each implementation (GL, VK, ...). * - * NOTE: IndexBuf does not hold any GPUPrimType. This is because it can be interpreted - * differently by multiple batches. - **/ + * \note #IndexBuf does not hold any #GPUPrimType. + * This is because it can be interpreted differently by multiple batches. + */ class IndexBuf { protected: /** Type of indices used inside this buffer. */ diff --git a/source/blender/gpu/intern/gpu_shader_interface.hh b/source/blender/gpu/intern/gpu_shader_interface.hh index 622f1ebb782..62513ffb8a7 100644 --- a/source/blender/gpu/intern/gpu_shader_interface.hh +++ b/source/blender/gpu/intern/gpu_shader_interface.hh @@ -48,7 +48,7 @@ typedef struct ShaderInput { /** * Implementation of Shader interface. * Base class which is then specialized for each implementation (GL, VK, ...). - **/ + */ class ShaderInterface { /* TODO(fclem): should be protected. */ public: diff --git a/source/blender/gpu/intern/gpu_shader_private.hh b/source/blender/gpu/intern/gpu_shader_private.hh index 3c29fdec36c..85427372559 100644 --- a/source/blender/gpu/intern/gpu_shader_private.hh +++ b/source/blender/gpu/intern/gpu_shader_private.hh @@ -32,7 +32,7 @@ namespace gpu { /** * Implementation of shader compilation and uniforms handling. * Base class which is then specialized for each implementation (GL, VK, ...). - **/ + */ class Shader { public: /** Uniform & attribute locations for shader. */ diff --git a/source/blender/gpu/intern/gpu_state_private.hh b/source/blender/gpu/intern/gpu_state_private.hh index db1747127d4..cda1b591bb1 100644 --- a/source/blender/gpu/intern/gpu_state_private.hh +++ b/source/blender/gpu/intern/gpu_state_private.hh @@ -148,7 +148,7 @@ inline GPUStateMutable operator~(const GPUStateMutable &a) /** * State manager keeping track of the draw state and applying it before drawing. * Base class which is then specialized for each implementation (GL, VK, ...). - **/ + */ class StateManager { public: GPUState state; diff --git a/source/blender/gpu/intern/gpu_texture_private.hh b/source/blender/gpu/intern/gpu_texture_private.hh index 250dee62f96..efa8be2a547 100644 --- a/source/blender/gpu/intern/gpu_texture_private.hh +++ b/source/blender/gpu/intern/gpu_texture_private.hh @@ -71,7 +71,7 @@ ENUM_OPERATORS(eGPUTextureType, GPU_TEXTURE_CUBE_ARRAY) /** * Implementation of Textures. * Base class which is then specialized for each implementation (GL, VK, ...). - **/ + */ class Texture { public: /** Internal Sampler state. */ diff --git a/source/blender/gpu/intern/gpu_uniform_buffer_private.hh b/source/blender/gpu/intern/gpu_uniform_buffer_private.hh index 18ea6d18caf..826bdd9f8d5 100644 --- a/source/blender/gpu/intern/gpu_uniform_buffer_private.hh +++ b/source/blender/gpu/intern/gpu_uniform_buffer_private.hh @@ -38,7 +38,7 @@ namespace gpu { /** * Implementation of Uniform Buffers. * Base class which is then specialized for each implementation (GL, VK, ...). - **/ + */ class UniformBuf { protected: /** Data size in bytes. */ diff --git a/source/blender/gpu/intern/gpu_vertex_buffer_private.hh b/source/blender/gpu/intern/gpu_vertex_buffer_private.hh index f3450d8e0f7..da8b02c5c66 100644 --- a/source/blender/gpu/intern/gpu_vertex_buffer_private.hh +++ b/source/blender/gpu/intern/gpu_vertex_buffer_private.hh @@ -32,7 +32,7 @@ namespace blender::gpu { /** * Implementation of Vertex Buffers. * Base class which is then specialized for each implementation (GL, VK, ...). - **/ + */ class VertBuf { public: static size_t memory_usage; diff --git a/source/blender/gpu/opengl/gl_batch.cc b/source/blender/gpu/opengl/gl_batch.cc index 89486b73b05..321d9552828 100644 --- a/source/blender/gpu/opengl/gl_batch.cc +++ b/source/blender/gpu/opengl/gl_batch.cc @@ -238,7 +238,7 @@ GLuint GLVaoCache::base_instance_vao_get(GPUBatch *batch, int i_first) /** * There seems to be a nasty bug when drawing using the same VAO reconfiguring (T71147). * We just use a throwaway VAO for that. Note that this is likely to degrade performance. - **/ + */ #ifdef __APPLE__ glDeleteVertexArrays(1, &vao_base_instance_); vao_base_instance_ = 0; diff --git a/source/blender/gpu/opengl/gl_drawlist.hh b/source/blender/gpu/opengl/gl_drawlist.hh index 5c1e698c0a1..db4b9c03c3c 100644 --- a/source/blender/gpu/opengl/gl_drawlist.hh +++ b/source/blender/gpu/opengl/gl_drawlist.hh @@ -41,7 +41,7 @@ namespace gpu { /** * Implementation of Multi Draw Indirect using OpenGL. - **/ + */ class GLDrawList : public DrawList { public: GLDrawList(int length); diff --git a/source/blender/gpu/opengl/gl_framebuffer.hh b/source/blender/gpu/opengl/gl_framebuffer.hh index 1de366fc844..95e67f5973c 100644 --- a/source/blender/gpu/opengl/gl_framebuffer.hh +++ b/source/blender/gpu/opengl/gl_framebuffer.hh @@ -37,7 +37,7 @@ class GLStateManager; /** * Implementation of FrameBuffer object using OpenGL. - **/ + */ class GLFrameBuffer : public FrameBuffer { /* For debugging purpose. */ friend class GLTexture; @@ -61,7 +61,7 @@ class GLFrameBuffer : public FrameBuffer { public: /** * Create a conventional framebuffer to attach texture to. - **/ + */ GLFrameBuffer(const char *name); /** @@ -72,7 +72,7 @@ class GLFrameBuffer : public FrameBuffer { * \param fbo: The (optional) already created object for some implementation. Default is 0. * \param w: Buffer width. * \param h: Buffer height. - **/ + */ GLFrameBuffer(const char *name, GLContext *ctx, GLenum target, GLuint fbo, int w, int h); ~GLFrameBuffer(); diff --git a/source/blender/gpu/opengl/gl_shader.hh b/source/blender/gpu/opengl/gl_shader.hh index befb2bce8b0..152eb2f068a 100644 --- a/source/blender/gpu/opengl/gl_shader.hh +++ b/source/blender/gpu/opengl/gl_shader.hh @@ -34,7 +34,7 @@ namespace gpu { /** * Implementation of shader compilation and uniforms handling using OpenGL. - **/ + */ class GLShader : public Shader { private: /** Handle for full program (links shader stages below). */ diff --git a/source/blender/gpu/opengl/gl_shader_interface.hh b/source/blender/gpu/opengl/gl_shader_interface.hh index 8cac84a5990..89a5b631047 100644 --- a/source/blender/gpu/opengl/gl_shader_interface.hh +++ b/source/blender/gpu/opengl/gl_shader_interface.hh @@ -42,7 +42,7 @@ class GLVaoCache; /** * Implementation of Shader interface using OpenGL. - **/ + */ class GLShaderInterface : public ShaderInterface { private: /** Reference to VaoCaches using this interface */ diff --git a/source/blender/gpu/opengl/gl_state.cc b/source/blender/gpu/opengl/gl_state.cc index c5b5dd3efd2..b837eae4871 100644 --- a/source/blender/gpu/opengl/gl_state.cc +++ b/source/blender/gpu/opengl/gl_state.cc @@ -358,7 +358,7 @@ void GLStateManager::set_blend(const eGPUBlend value) * DST is frame-buffer color. * final.rgb = SRC.rgb * src_rgb + DST.rgb * dst_rgb; * final.a = SRC.a * src_alpha + DST.a * dst_alpha; - **/ + */ GLenum src_rgb, src_alpha, dst_rgb, dst_alpha; switch (value) { default: diff --git a/source/blender/gpu/opengl/gl_state.hh b/source/blender/gpu/opengl/gl_state.hh index cab654006c6..643e46acc2d 100644 --- a/source/blender/gpu/opengl/gl_state.hh +++ b/source/blender/gpu/opengl/gl_state.hh @@ -39,7 +39,7 @@ class GLTexture; /** * State manager keeping track of the draw state and applying it before drawing. * Opengl Implementation. - **/ + */ class GLStateManager : public StateManager { public: /** Anothter reference to the active framebuffer. */ diff --git a/source/blender/gpu/opengl/gl_texture.cc b/source/blender/gpu/opengl/gl_texture.cc index 4f990b77bd0..2e8d9dd6e1c 100644 --- a/source/blender/gpu/opengl/gl_texture.cc +++ b/source/blender/gpu/opengl/gl_texture.cc @@ -489,7 +489,7 @@ void GLTexture::samplers_init() * - GL_TEXTURE_MIN_LOD is -1000. * - GL_TEXTURE_MAX_LOD is 1000. * - GL_TEXTURE_LOD_BIAS is 0.0f. - **/ + */ char sampler_name[128] = "\0\0"; SNPRINTF(sampler_name, diff --git a/source/blender/gpu/opengl/gl_uniform_buffer.hh b/source/blender/gpu/opengl/gl_uniform_buffer.hh index 8cd2ab91be9..6cc525a2b7a 100644 --- a/source/blender/gpu/opengl/gl_uniform_buffer.hh +++ b/source/blender/gpu/opengl/gl_uniform_buffer.hh @@ -34,7 +34,7 @@ namespace gpu { /** * Implementation of Uniform Buffers using OpenGL. - **/ + */ class GLUniformBuf : public UniformBuf { private: /** Slot to which this UBO is currently bound. -1 if not bound. */ |