From add1b6ab3c91d408635b311127224dd4cc33f1ab Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Fri, 23 Sep 2022 14:33:43 +1000 Subject: Cleanup: spelling in comments --- source/blender/gpu/intern/gpu_codegen.cc | 8 +++---- source/blender/gpu/intern/gpu_material.c | 8 +++---- source/blender/gpu/metal/mtl_context.hh | 10 ++++----- source/blender/gpu/metal/mtl_context.mm | 30 +++++++++++++-------------- source/blender/gpu/metal/mtl_immediate.mm | 6 +++--- source/blender/gpu/metal/mtl_texture.mm | 6 +++--- source/blender/gpu/metal/mtl_vertex_buffer.hh | 2 +- source/blender/gpu/metal/mtl_vertex_buffer.mm | 4 ++-- 8 files changed, 37 insertions(+), 37 deletions(-) (limited to 'source/blender/gpu') diff --git a/source/blender/gpu/intern/gpu_codegen.cc b/source/blender/gpu/intern/gpu_codegen.cc index 85cfa9749fa..fdd0fe97a02 100644 --- a/source/blender/gpu/intern/gpu_codegen.cc +++ b/source/blender/gpu/intern/gpu_codegen.cc @@ -245,7 +245,7 @@ class GPUCodegen { ListBase ubo_inputs_ = {nullptr, nullptr}; GPUInput *cryptomatte_input_ = nullptr; - /** Cache paramters for complexity heuristic. */ + /** Cache parameters for complexity heuristic. */ uint nodes_total_ = 0; uint textures_total_ = 0; uint uniforms_total_ = 0; @@ -459,7 +459,7 @@ void GPUCodegen::generate_library() GPUCodegenCreateInfo &info = *create_info; void *value; - /* Iterate over libraries. We need to keep this struct intact incase + /* Iterate over libraries. We need to keep this struct intact in case * it is required for the optimization an pass. */ GHashIterator *ihash = BLI_ghashIterator_new((GHash *)graph.used_libraries); while (!BLI_ghashIterator_done(ihash)) { @@ -694,7 +694,7 @@ GPUPass *GPU_generate_pass(GPUMaterial *material, /** Cache lookup: Reuse shaders already compiled. * NOTE: We only perform cache look-up for non-optimized shader - * graphs, as baked constant data amongst other optimizations will generate too many + * graphs, as baked constant data among other optimizations will generate too many * shader source permutations, with minimal re-usability. */ pass_hash = gpu_pass_cache_lookup(codegen.hash_get()); @@ -750,7 +750,7 @@ GPUPass *GPU_generate_pass(GPUMaterial *material, pass->compiled = false; /* Only flag pass optimization hint if this is the first generated pass for a material. * Optimized passes cannot be optimized further, even if the heuristic is still not - * favourable. */ + * favorable. */ pass->should_optimize = (!optimize_graph) && codegen.should_optimize_heuristic(); codegen.create_info = nullptr; diff --git a/source/blender/gpu/intern/gpu_material.c b/source/blender/gpu/intern/gpu_material.c index 991cb229eda..6d0779797b0 100644 --- a/source/blender/gpu/intern/gpu_material.c +++ b/source/blender/gpu/intern/gpu_material.c @@ -45,13 +45,13 @@ #define MAX_COLOR_BAND 128 #define MAX_GPU_SKIES 8 -/** Whether the optimized variant of the GPUPass should be created asynchronously. +/** Whether the optimized variant of the #GPUPass should be created asynchronously. * Usage of this depends on whether there are possible threading challenges of doing so. * Currently, the overhead of GPU_generate_pass is relatively small in comparison to shader * compilation, though this option exists in case any potential scenarios for material graph * optimization cause a slow down on the main thread. * - * NOTE: The actual shader program for the optimized pass will alwaysbe compiled asynchronously, + * NOTE: The actual shader program for the optimized pass will always be compiled asynchronously, * this flag controls whether shader node graph source serialization happens on the compilation * worker thread. */ #define ASYNC_OPTIMIZED_PASS_CREATION 0 @@ -67,8 +67,8 @@ typedef struct GPUSkyBuilder { } GPUSkyBuilder; struct GPUMaterial { - /* Contains GPUShader and source code for deferred compilation. - * Can be shared between similar material (i.e: sharing same nodetree topology). */ + /* Contains #GPUShader and source code for deferred compilation. + * Can be shared between similar material (i.e: sharing same node-tree topology). */ GPUPass *pass; /* Optimized GPUPass, situationally compiled after initial pass for optimal realtime performance. * This shader variant bakes dynamic uniform data as constant. This variant will not use diff --git a/source/blender/gpu/metal/mtl_context.hh b/source/blender/gpu/metal/mtl_context.hh index 5991fe2bc3e..3ba33ebfa46 100644 --- a/source/blender/gpu/metal/mtl_context.hh +++ b/source/blender/gpu/metal/mtl_context.hh @@ -577,7 +577,7 @@ class MTLContext : public Context { friend class MTLRenderPassState; public: - /* Swapchain and latency management. */ + /* Swap-chain and latency management. */ static std::atomic max_drawables_in_flight; static std::atomic avg_drawable_latency_us; static int64_t frame_latency[MTL_FRAME_AVERAGE_COUNT]; @@ -591,7 +591,7 @@ class MTLContext : public Context { id device = nil; #ifndef NDEBUG - /* Label for Context debug name assignemnt. */ + /* Label for Context debug name assignment. */ NSString *label = nil; #endif @@ -606,7 +606,7 @@ class MTLContext : public Context { /* Parent Context. */ GHOST_ContextCGL *ghost_context_; - /* Render Passes and Framebuffers. */ + /* Render Passes and Frame-buffers. */ id default_fbo_mtltexture_ = nil; gpu::MTLTexture *default_fbo_gputexture_ = nullptr; @@ -637,7 +637,7 @@ class MTLContext : public Context { gpu::MTLBuffer *visibility_buffer_ = nullptr; bool visibility_is_dirty_ = false; - /* Null buffers for empty/unintialized bindings. + /* Null buffers for empty/uninitialized bindings. * Null attribute buffer follows default attribute format of OpenGL Backend. */ id null_buffer_; /* All zero's. */ id null_attribute_buffer_; /* Value float4(0.0,0.0,0.0,1.0). */ @@ -783,7 +783,7 @@ class MTLContext : public Context { return MTLContext::global_memory_manager; } - /* Swapchain and latency management. */ + /* Swap-chain and latency management. */ static void latency_resolve_average(int64_t frame_latency_us) { int64_t avg = 0; diff --git a/source/blender/gpu/metal/mtl_context.mm b/source/blender/gpu/metal/mtl_context.mm index a89339d0d14..ef66a1f2111 100644 --- a/source/blender/gpu/metal/mtl_context.mm +++ b/source/blender/gpu/metal/mtl_context.mm @@ -37,7 +37,7 @@ namespace blender::gpu { /* Global memory manager. */ MTLBufferPool MTLContext::global_memory_manager; -/* Swapchain and latency management. */ +/* Swap-chain and latency management. */ std::atomic MTLContext::max_drawables_in_flight = 0; std::atomic MTLContext::avg_drawable_latency_us = 0; int64_t MTLContext::frame_latency[MTL_FRAME_AVERAGE_COUNT] = {0}; @@ -92,7 +92,7 @@ void MTLContext::set_ghost_context(GHOST_ContextHandle ghostCtxHandle) default_fbo_gputexture_ = new gpu::MTLTexture( "MTL_BACKBUFFER", GPU_RGBA16F, GPU_TEXTURE_2D, default_fbo_mtltexture_); - /* Update framebuffers with new texture attachments */ + /* Update frame-buffers with new texture attachments. */ mtl_front_left->add_color_attachment(default_fbo_gputexture_, 0, 0, 0); mtl_back_left->add_color_attachment(default_fbo_gputexture_, 0, 0, 0); #ifndef NDEBUG @@ -147,7 +147,7 @@ MTLContext::MTLContext(void *ghost_window, void *ghost_context) /* Init debug. */ debug::mtl_debug_init(); - /* Initialise Renderpass and Framebuffer State */ + /* Initialize Render-pass and Frame-buffer State. */ this->back_left = nullptr; /* Initialize command buffer state. */ @@ -164,7 +164,7 @@ MTLContext::MTLContext(void *ghost_window, void *ghost_context) null_buffer_ = nil; null_attribute_buffer_ = nil; - /* Zero-initialise MTL Textures. */ + /* Zero-initialize MTL textures. */ default_fbo_mtltexture_ = nil; default_fbo_gputexture_ = nullptr; @@ -821,7 +821,7 @@ bool MTLContext::ensure_render_pipeline_state(MTLPrimitiveType mtl_prim_type) /* Matrix Bindings. */ /* This is now called upon shader bind. We may need to re-evaluate this though, - * as was done here to ensure uniform changes beween draws were tracked. + * as was done here to ensure uniform changes between draws were tracked. * NOTE(Metal): We may be able to remove this. */ GPU_matrix_bind(reinterpret_cast( static_cast(this->pipeline_state.active_shader))); @@ -869,7 +869,7 @@ bool MTLContext::ensure_render_pipeline_state(MTLPrimitiveType mtl_prim_type) scissor.width = this->pipeline_state.scissor_width; scissor.height = this->pipeline_state.scissor_height; - /* Some scissor assignments exceed the bounds of the viewport due to implictly added + /* Some scissor assignments exceed the bounds of the viewport due to implicitly added * padding to the width/height - Clamp width/height. */ BLI_assert(scissor.x >= 0 && scissor.x < render_fb->get_width()); BLI_assert(scissor.y >= 0 && scissor.y < render_fb->get_height()); @@ -899,7 +899,7 @@ bool MTLContext::ensure_render_pipeline_state(MTLPrimitiveType mtl_prim_type) /* State: Face winding. */ if (this->pipeline_state.dirty_flags & MTL_PIPELINE_STATE_FRONT_FACING_FLAG) { - /* We nede to invert the face winding in Metal, to account for the inverted-Y coordinate + /* We need to invert the face winding in Metal, to account for the inverted-Y coordinate * system. */ MTLWinding winding = (this->pipeline_state.front_face == GPU_CLOCKWISE) ? MTLWindingClockwise : @@ -909,7 +909,7 @@ bool MTLContext::ensure_render_pipeline_state(MTLPrimitiveType mtl_prim_type) ~MTL_PIPELINE_STATE_FRONT_FACING_FLAG); } - /* State: cullmode. */ + /* State: cull-mode. */ if (this->pipeline_state.dirty_flags & MTL_PIPELINE_STATE_CULLMODE_FLAG) { MTLCullMode mode = MTLCullModeNone; @@ -960,7 +960,7 @@ bool MTLContext::ensure_uniform_buffer_bindings( const MTLShaderUniformBlock &push_constant_block = shader_interface->get_push_constant_block(); if (push_constant_block.size > 0) { - /* Fetch uniform buffer base binding index from pipeline_state_instance - Terhe buffer index + /* Fetch uniform buffer base binding index from pipeline_state_instance - There buffer index * will be offset by the number of bound VBOs. */ uint32_t block_size = push_constant_block.size; uint32_t buffer_index = pipeline_state_instance->base_uniform_buffer_index + @@ -1267,10 +1267,10 @@ void MTLContext::ensure_texture_bindings( /* Generate or Fetch argument buffer sampler configuration. * NOTE(Metal): we need to base sampler counts off of the maximal texture - * index. This is not the most optimal, but in practise, not a use-case + * index. This is not the most optimal, but in practice, not a use-case * when argument buffers are required. * This is because with explicit texture indices, the binding indices - * should match across draws, to allow the high-level to optimise bindpoints. */ + * should match across draws, to allow the high-level to optimize bind-points. */ gpu::MTLBuffer *encoder_buffer = nullptr; this->samplers_.num_samplers = shader_interface->get_max_texture_index() + 1; @@ -1624,7 +1624,7 @@ id MTLContext::get_default_sampler_state() /** \} */ /* -------------------------------------------------------------------- */ -/** \name Swapchain management and Metal presentation. +/** \name Swap-chain management and Metal presentation. * \{ */ void present(MTLRenderPassDescriptor *blit_descriptor, @@ -1636,7 +1636,7 @@ void present(MTLRenderPassDescriptor *blit_descriptor, MTLContext *ctx = static_cast(unwrap(GPU_context_active_get())); BLI_assert(ctx); - /* Flush any oustanding work. */ + /* Flush any outstanding work. */ ctx->flush(); /* Always pace CPU to maximum of 3 drawables in flight. @@ -1660,8 +1660,8 @@ void present(MTLRenderPassDescriptor *blit_descriptor, PIL_sleep_ms(2); } - /* Present is submitted in its own CMD Buffer to enusure drawable reference released as early as - * possible. This command buffer is separate as it does not utilise the global state + /* Present is submitted in its own CMD Buffer to ensure drawable reference released as early as + * possible. This command buffer is separate as it does not utilize the global state * for rendering as the main context does. */ id cmdbuf = [ctx->queue commandBuffer]; MTLCommandBufferManager::num_active_cmd_bufs++; diff --git a/source/blender/gpu/metal/mtl_immediate.mm b/source/blender/gpu/metal/mtl_immediate.mm index 4820c9db9df..aaebe7e20f8 100644 --- a/source/blender/gpu/metal/mtl_immediate.mm +++ b/source/blender/gpu/metal/mtl_immediate.mm @@ -49,7 +49,7 @@ uchar *MTLImmediate::begin() void MTLImmediate::end() { - /* Ensure we're between a imm::begin/imm:end pair. */ + /* Ensure we're between a `imm::begin` / `imm:end` pair. */ BLI_assert(has_begun_); BLI_assert(prim_type != GPU_PRIM_NONE); @@ -187,7 +187,7 @@ void MTLImmediate::end() /* Some conversions are NOT valid, e.g. Int4 to Float4 * - In this case, we need to implement a conversion routine inside the shader. * - This is handled using the format_conversion_mode flag - * - This flag is passed into the PSO as a function specialisation, + * - This flag is passed into the PSO as a function specialization, * and will generate an appropriate conversion function when reading the vertex attribute * value into local shader storage. * (If no explicit conversion is needed, the function specialize to a pass-through). */ @@ -359,7 +359,7 @@ void MTLImmediate::end() } /* Submit draw call with modified vertex count, which reflects vertices per primitive - * defined in the USE_SSBO_VERTEX_FETCH pragma. */ + * defined in the USE_SSBO_VERTEX_FETCH `pragma`. */ int num_input_primitives = gpu_get_prim_count_from_type(vertex_count, this->prim_type); int output_num_verts = num_input_primitives * active_mtl_shader->get_ssbo_vertex_fetch_output_num_verts(); diff --git a/source/blender/gpu/metal/mtl_texture.mm b/source/blender/gpu/metal/mtl_texture.mm index b4e913e5be6..32029db6fd9 100644 --- a/source/blender/gpu/metal/mtl_texture.mm +++ b/source/blender/gpu/metal/mtl_texture.mm @@ -174,7 +174,7 @@ id gpu::MTLTexture::get_metal_handle() if (resource_mode_ == MTL_TEXTURE_MODE_VBO) { id buf = vert_buffer_->get_metal_buffer(); - /* Source vertex buffer has been re-generated, require re-initialisation. */ + /* Source vertex buffer has been re-generated, require re-initialization. */ if (buf != vert_buffer_mtl_) { MTL_LOG_INFO( "MTLTexture '%p' using MTL_TEXTURE_MODE_VBO requires re-generation due to updated " @@ -183,7 +183,7 @@ id gpu::MTLTexture::get_metal_handle() /* Clear state. */ this->reset(); - /* Re-initialise. */ + /* Re-initialize. */ this->init_internal(wrap(vert_buffer_)); /* Update for assertion check below. */ @@ -191,7 +191,7 @@ id gpu::MTLTexture::get_metal_handle() } /* Ensure buffer is valid. - * Fetchvert buffer handle directly in-case it changed above. */ + * Fetch-vert buffer handle directly in-case it changed above. */ BLI_assert(vert_buffer_mtl_ != nil); BLI_assert(vert_buffer_->get_metal_buffer() == vert_buffer_mtl_); } diff --git a/source/blender/gpu/metal/mtl_vertex_buffer.hh b/source/blender/gpu/metal/mtl_vertex_buffer.hh index 6918298d643..2cc8b0a9636 100644 --- a/source/blender/gpu/metal/mtl_vertex_buffer.hh +++ b/source/blender/gpu/metal/mtl_vertex_buffer.hh @@ -38,7 +38,7 @@ class MTLVertBuf : public VertBuf { /** Whether existing allocation has been submitted for use by the GPU. */ bool contents_in_flight_ = false; - /* Fetch Metal buffer and offset into allocation if ncessary. + /* Fetch Metal buffer and offset into allocation if necessary. * Access limited to friend classes. */ id get_metal_buffer() { diff --git a/source/blender/gpu/metal/mtl_vertex_buffer.mm b/source/blender/gpu/metal/mtl_vertex_buffer.mm index 05f9c500832..1c7201ce5f9 100644 --- a/source/blender/gpu/metal/mtl_vertex_buffer.mm +++ b/source/blender/gpu/metal/mtl_vertex_buffer.mm @@ -58,7 +58,7 @@ void MTLVertBuf::duplicate_data(VertBuf *dst_) MTLVertBuf *src = this; MTLVertBuf *dst = static_cast(dst_); - /* Ensure buffer has been initialised. */ + /* Ensure buffer has been initialized. */ src->bind(); if (src->vbo_) { @@ -206,7 +206,7 @@ void MTLVertBuf::bind() if (prev_flag & GPU_VERTBUF_DATA_UPLOADED) { - /* Fetch active econtext. */ + /* Fetch active context. */ MTLContext *ctx = MTLContext::get(); BLI_assert(ctx); -- cgit v1.2.3