From 9b89de2571b0c3fa2276b5c2ae589e0ec831d1f5 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sat, 3 Jul 2021 23:08:40 +1000 Subject: Cleanup: consistent use of tags: NOTE/TODO/FIXME/XXX Also use doxy style function reference `#` prefix chars when referencing identifiers. --- source/blender/gpu/GPU_primitive.h | 2 +- source/blender/gpu/intern/gpu_buffers.c | 4 ++-- source/blender/gpu/intern/gpu_codegen.c | 2 +- source/blender/gpu/intern/gpu_context.cc | 6 +++--- source/blender/gpu/intern/gpu_node_graph.c | 2 +- source/blender/gpu/intern/gpu_state.cc | 2 +- source/blender/gpu/intern/gpu_state_private.hh | 2 +- source/blender/gpu/intern/gpu_texture.cc | 2 +- source/blender/gpu/intern/gpu_texture_private.hh | 4 ++-- source/blender/gpu/intern/gpu_vertex_buffer.cc | 8 ++++---- source/blender/gpu/opengl/gl_context.cc | 2 +- source/blender/gpu/opengl/gl_query.cc | 8 ++++---- source/blender/gpu/opengl/gl_state.cc | 8 ++++---- source/blender/gpu/opengl/gl_texture.cc | 4 ++-- .../gpu/shaders/material/gpu_shader_material_world_normals.glsl | 2 +- 15 files changed, 29 insertions(+), 29 deletions(-) (limited to 'source/blender/gpu') diff --git a/source/blender/gpu/GPU_primitive.h b/source/blender/gpu/GPU_primitive.h index b1d70326b45..f64a673d461 100644 --- a/source/blender/gpu/GPU_primitive.h +++ b/source/blender/gpu/GPU_primitive.h @@ -57,7 +57,7 @@ typedef enum { } GPUPrimClass; /** - * TODO Improve error checking by validating that the shader is suited for this primitive type. + * 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); */ diff --git a/source/blender/gpu/intern/gpu_buffers.c b/source/blender/gpu/intern/gpu_buffers.c index 13d0139e406..43483916236 100644 --- a/source/blender/gpu/intern/gpu_buffers.c +++ b/source/blender/gpu/intern/gpu_buffers.c @@ -707,7 +707,7 @@ void GPU_pbvh_grid_buffers_update(GPU_PBVH_Buffers *buffers, float fno[3]; short no_short[3]; - /* Note: Clockwise indices ordering, that's why we invert order here. */ + /* NOTE: Clockwise indices ordering, that's why we invert order here. */ normal_quad_v3(fno, co[3], co[2], co[1], co[0]); normal_float_to_short_v3(no_short, fno); @@ -916,7 +916,7 @@ void GPU_pbvh_bmesh_buffers_update(GPU_PBVH_Buffers *buffers, return; } - /* TODO, make mask layer optional for bmesh buffer */ + /* TODO: make mask layer optional for bmesh buffer. */ const int cd_vert_mask_offset = CustomData_get_offset(&bm->vdata, CD_PAINT_MASK); /* Fill vertex buffer */ diff --git a/source/blender/gpu/intern/gpu_codegen.c b/source/blender/gpu/intern/gpu_codegen.c index a2072e504fd..b1fcfc1e202 100644 --- a/source/blender/gpu/intern/gpu_codegen.c +++ b/source/blender/gpu/intern/gpu_codegen.c @@ -810,7 +810,7 @@ static char *code_generate_geometry(GPUNodeGraph *graph, } LISTBASE_FOREACH (GPUMaterialAttribute *, attr, &graph->attributes) { - /* TODO let shader choose what to do depending on what the attribute is. */ + /* TODO: let shader choose what to do depending on what the attribute is. */ BLI_dynstr_appendf(ds, "dataAttrOut.var%d = dataAttrIn[vert].var%d;\\\n", attr->id, attr->id); } BLI_dynstr_append(ds, "}\n\n"); diff --git a/source/blender/gpu/intern/gpu_context.cc b/source/blender/gpu/intern/gpu_context.cc index b5a437b46f7..943a6151ced 100644 --- a/source/blender/gpu/intern/gpu_context.cc +++ b/source/blender/gpu/intern/gpu_context.cc @@ -28,7 +28,7 @@ * - free can be called from any thread */ -/* TODO Create cmake option. */ +/* TODO: Create cmake option. */ #define WITH_OPENGL_BACKEND 1 #include "BLI_assert.h" @@ -99,7 +99,7 @@ Context *Context::get() GPUContext *GPU_context_create(void *ghost_window) { if (GPUBackend::get() == nullptr) { - /* TODO move where it make sense. */ + /* TODO: move where it make sense. */ GPU_backend_init(GPU_BACKEND_OPENGL); } @@ -182,7 +182,7 @@ void GPU_backend_init(eGPUBackendType backend_type) void GPU_backend_exit(void) { - /* TODO assert no resource left. Currently UI textures are still not freed in their context + /* TODO: assert no resource left. Currently UI textures are still not freed in their context * correctly. */ delete g_backend; g_backend = nullptr; diff --git a/source/blender/gpu/intern/gpu_node_graph.c b/source/blender/gpu/intern/gpu_node_graph.c index b220c60e979..dad03ab22e5 100644 --- a/source/blender/gpu/intern/gpu_node_graph.c +++ b/source/blender/gpu/intern/gpu_node_graph.c @@ -259,7 +259,7 @@ static void gpu_node_output(GPUNode *node, const eGPUType type, GPUNodeLink **li output->link->link_type = GPU_NODE_LINK_OUTPUT; output->link->output = output; - /* note: the caller owns the reference to the link, GPUOutput + /* NOTE: the caller owns the reference to the link, GPUOutput * merely points to it, and if the node is destroyed it will * set that pointer to NULL */ } diff --git a/source/blender/gpu/intern/gpu_state.cc b/source/blender/gpu/intern/gpu_state.cc index 5c33066c720..9ee8a8b8d32 100644 --- a/source/blender/gpu/intern/gpu_state.cc +++ b/source/blender/gpu/intern/gpu_state.cc @@ -187,7 +187,7 @@ void GPU_point_size(float size) /* Programmable point size * - shaders set their own point size when enabled * - use GPU_point_size when disabled */ -/* TODO remove and use program point size everywhere */ +/* TODO: remove and use program point size everywhere. */ void GPU_program_point_size(bool enable) { StateManager *stack = Context::get()->state_manager; diff --git a/source/blender/gpu/intern/gpu_state_private.hh b/source/blender/gpu/intern/gpu_state_private.hh index b79350a6506..b96b71a7ac4 100644 --- a/source/blender/gpu/intern/gpu_state_private.hh +++ b/source/blender/gpu/intern/gpu_state_private.hh @@ -96,7 +96,7 @@ inline GPUState operator~(const GPUState &a) union GPUStateMutable { struct { /* Viewport State */ - /** TODO remove */ + /** TODO: remove. */ float depth_range[2]; /** Positive if using program point size. */ /* TODO(fclem): should be passed as uniform to all shaders. */ diff --git a/source/blender/gpu/intern/gpu_texture.cc b/source/blender/gpu/intern/gpu_texture.cc index de5a9f95b65..f7a4d672b02 100644 --- a/source/blender/gpu/intern/gpu_texture.cc +++ b/source/blender/gpu/intern/gpu_texture.cc @@ -600,7 +600,7 @@ void GPU_texture_py_reference_set(GPUTexture *tex, void **py_ref) } #endif -/* TODO remove */ +/* TODO: remove. */ int GPU_texture_opengl_bindcode(const GPUTexture *tex) { return reinterpret_cast(tex)->gl_bindcode_get(); diff --git a/source/blender/gpu/intern/gpu_texture_private.hh b/source/blender/gpu/intern/gpu_texture_private.hh index a8f2e482bdd..2b8a5a5cc12 100644 --- a/source/blender/gpu/intern/gpu_texture_private.hh +++ b/source/blender/gpu/intern/gpu_texture_private.hh @@ -155,7 +155,7 @@ class Texture { void mip_size_get(int mip, int r_size[3]) const { - /* TODO assert if lvl is below the limit of 1px in each dimension. */ + /* TODO: assert if lvl is below the limit of 1px in each dimension. */ int div = 1 << mip; r_size[0] = max_ii(1, w_ / div); @@ -559,7 +559,7 @@ static inline eGPUTextureFormat to_texture_format(const GPUVertFormat *format) case GPU_COMP_I16: return GPU_RGBA16I; case GPU_COMP_U16: - /* Note: Checking the fetch mode to select the right GPU texture format. This can be + /* NOTE: Checking the fetch mode to select the right GPU texture format. This can be * added to other formats as well. */ switch (format->attrs[0].fetch_mode) { case GPU_FETCH_INT: diff --git a/source/blender/gpu/intern/gpu_vertex_buffer.cc b/source/blender/gpu/intern/gpu_vertex_buffer.cc index 2c21d2bf9af..7ff68242c17 100644 --- a/source/blender/gpu/intern/gpu_vertex_buffer.cc +++ b/source/blender/gpu/intern/gpu_vertex_buffer.cc @@ -28,8 +28,8 @@ #include "gpu_backend.hh" #include "gpu_vertex_format_private.h" -#include "gl_vertex_buffer.hh" /* TODO remove */ -#include "gpu_context_private.hh" /* TODO remove */ +#include "gl_vertex_buffer.hh" /* TODO: remove. */ +#include "gpu_context_private.hh" /* TODO: remove. */ #include "gpu_vertex_buffer_private.hh" @@ -287,7 +287,7 @@ void GPU_vertbuf_attr_get_raw_data(GPUVertBuf *verts_, uint a_idx, GPUVertBufRaw /* NOTE: Be careful when using this. The data needs to match the expected format. */ void *GPU_vertbuf_get_data(const GPUVertBuf *verts) { - /* TODO Assert that the format has no padding. */ + /* TODO: Assert that the format has no padding. */ return unwrap(verts)->data; } @@ -296,7 +296,7 @@ void *GPU_vertbuf_get_data(const GPUVertBuf *verts) void *GPU_vertbuf_steal_data(GPUVertBuf *verts_) { VertBuf *verts = unwrap(verts_); - /* TODO Assert that the format has no padding. */ + /* TODO: Assert that the format has no padding. */ BLI_assert(verts->data); void *data = verts->data; verts->data = nullptr; diff --git a/source/blender/gpu/opengl/gl_context.cc b/source/blender/gpu/opengl/gl_context.cc index 6c9c6e10774..23654cb96f3 100644 --- a/source/blender/gpu/opengl/gl_context.cc +++ b/source/blender/gpu/opengl/gl_context.cc @@ -39,7 +39,7 @@ #include "gl_state.hh" #include "gl_uniform_buffer.hh" -#include "gl_backend.hh" /* TODO remove */ +#include "gl_backend.hh" /* TODO: remove. */ #include "gl_context.hh" using namespace blender; diff --git a/source/blender/gpu/opengl/gl_query.cc b/source/blender/gpu/opengl/gl_query.cc index 8a42719c665..da9770b4cc1 100644 --- a/source/blender/gpu/opengl/gl_query.cc +++ b/source/blender/gpu/opengl/gl_query.cc @@ -41,7 +41,7 @@ void GLQueryPool::init(GPUQueryType type) query_issued_ = 0; } -#if 0 /* TODO to avoid realloc of permanent query pool. */ +#if 0 /* TODO: to avoid realloc of permanent query pool. */ void GLQueryPool::reset(GPUQueryType type) { initialized_ = false; @@ -50,7 +50,7 @@ void GLQueryPool::reset(GPUQueryType type) void GLQueryPool::begin_query() { - /* TODO add assert about expected usage. */ + /* TODO: add assert about expected usage. */ while (query_issued_ >= query_ids_.size()) { int64_t prev_size = query_ids_.size(); query_ids_.resize(prev_size + QUERY_CHUNCK_LEN); @@ -61,7 +61,7 @@ void GLQueryPool::begin_query() void GLQueryPool::end_query() { - /* TODO add assert about expected usage. */ + /* TODO: add assert about expected usage. */ glEndQuery(gl_type_); } @@ -70,7 +70,7 @@ void GLQueryPool::get_occlusion_result(MutableSpan r_values) BLI_assert(r_values.size() == query_issued_); for (int i = 0; i < query_issued_; i++) { - /* Note: This is a sync point. */ + /* NOTE: This is a sync point. */ glGetQueryObjectuiv(query_ids_[i], GL_QUERY_RESULT, &r_values[i]); } } diff --git a/source/blender/gpu/opengl/gl_state.cc b/source/blender/gpu/opengl/gl_state.cc index b837eae4871..1106e3dab50 100644 --- a/source/blender/gpu/opengl/gl_state.cc +++ b/source/blender/gpu/opengl/gl_state.cc @@ -131,7 +131,7 @@ void GLStateManager::set_state(const GPUState &state) set_shadow_bias(state.shadow_bias); } - /* TODO remove */ + /* TODO: remove. */ if (changed.polygon_smooth) { if (state.polygon_smooth) { glEnable(GL_POLYGON_SMOOTH); @@ -156,7 +156,7 @@ void GLStateManager::set_mutable_state(const GPUStateMutable &state) { GPUStateMutable changed = state ^ current_mutable_; - /* TODO remove, should be uniform. */ + /* TODO: remove, should be uniform. */ if (float_as_uint(changed.point_size) != 0) { if (state.point_size > 0.0f) { glEnable(GL_PROGRAM_POINT_SIZE); @@ -168,12 +168,12 @@ void GLStateManager::set_mutable_state(const GPUStateMutable &state) } if (changed.line_width != 0) { - /* TODO remove, should use wide line shader. */ + /* TODO: remove, should use wide line shader. */ glLineWidth(clamp_f(state.line_width, line_width_range_[0], line_width_range_[1])); } if (changed.depth_range[0] != 0 || changed.depth_range[1] != 0) { - /* TODO remove, should modify the projection matrix instead. */ + /* TODO: remove, should modify the projection matrix instead. */ glDepthRange(UNPACK2(state.depth_range)); } diff --git a/source/blender/gpu/opengl/gl_texture.cc b/source/blender/gpu/opengl/gl_texture.cc index ddc45a6a904..db1fda63c28 100644 --- a/source/blender/gpu/opengl/gl_texture.cc +++ b/source/blender/gpu/opengl/gl_texture.cc @@ -32,7 +32,7 @@ #include "gl_backend.hh" #include "gl_debug.hh" #include "gl_state.hh" -#include "gpu_vertex_buffer_private.hh" /* TODO should be `gl_vertex_buffer.hh` */ +#include "gpu_vertex_buffer_private.hh" /* TODO: should be `gl_vertex_buffer.hh`. */ #include "gl_texture.hh" @@ -347,7 +347,7 @@ void GLTexture::copy_to(Texture *dst_) BLI_assert((dst->w_ == src->w_) && (dst->h_ == src->h_) && (dst->d_ == src->d_)); BLI_assert(dst->format_ == src->format_); BLI_assert(dst->type_ == src->type_); - /* TODO support array / 3D textures. */ + /* TODO: support array / 3D textures. */ BLI_assert(dst->d_ == 0); if (GLContext::copy_image_support) { diff --git a/source/blender/gpu/shaders/material/gpu_shader_material_world_normals.glsl b/source/blender/gpu/shaders/material/gpu_shader_material_world_normals.glsl index d33465fa846..40e46bc250c 100644 --- a/source/blender/gpu/shaders/material/gpu_shader_material_world_normals.glsl +++ b/source/blender/gpu/shaders/material/gpu_shader_material_world_normals.glsl @@ -1,4 +1,4 @@ -/* TODO : clean this ifdef mess */ +/* TODO: clean this `ifdef` mess. */ void world_normals_get(out vec3 N) { #ifndef VOLUMETRICS -- cgit v1.2.3