From 828c66f393232f99272122623cacf2266cccbfa2 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Mon, 26 Jul 2021 12:32:42 +1000 Subject: Cleanup: spelling in comments --- source/blender/bmesh/tools/bmesh_bevel.c | 6 +++--- source/blender/draw/engines/eevee/eevee_engine.c | 8 ++++---- .../blender/draw/engines/gpencil/gpencil_cache_utils.c | 2 +- source/blender/draw/engines/overlay/overlay_outline.c | 2 +- source/blender/draw/intern/draw_cache_impl_volume.c | 2 +- source/blender/draw/intern/draw_cache_inline.h | 6 +++--- source/blender/draw/intern/draw_manager.h | 4 ++-- source/blender/editors/gpencil/annotate_draw.c | 2 +- source/blender/editors/include/BIF_glutil.h | 12 ++++++------ source/blender/editors/interface/interface_icons.c | 17 +++++++---------- .../editors/interface/interface_region_popover.c | 2 +- source/blender/editors/interface/resources.c | 2 +- source/blender/editors/render/render_opengl.c | 2 +- source/blender/editors/sculpt_paint/paint_image_proj.c | 4 ++-- source/blender/editors/space_node/node_draw.cc | 2 +- source/blender/editors/space_view3d/view3d_draw.c | 2 +- source/blender/functions/FN_cpp_type.hh | 2 +- source/blender/gpu/intern/gpu_batch.cc | 2 +- source/blender/gpu/intern/gpu_select_sample_query.cc | 2 +- source/blender/gpu/opengl/gl_context.cc | 2 +- source/blender/makesdna/DNA_view3d_enums.h | 2 +- source/blender/windowmanager/wm_surface.h | 2 +- source/blender/windowmanager/xr/intern/wm_xr_intern.h | 2 +- 23 files changed, 43 insertions(+), 46 deletions(-) (limited to 'source') diff --git a/source/blender/bmesh/tools/bmesh_bevel.c b/source/blender/bmesh/tools/bmesh_bevel.c index fd18153ec2c..0f99f04ad57 100644 --- a/source/blender/bmesh/tools/bmesh_bevel.c +++ b/source/blender/bmesh/tools/bmesh_bevel.c @@ -384,7 +384,7 @@ typedef struct BevelParams { // #pragma GCC diagnostic ignored "-Wpadded" -/* Only for debugging, this file shouldn't be in blender repo. */ +/* Only for debugging, this file shouldn't be in blender repository. */ // #include "bevdebug.c" /* Use the unused _BM_ELEM_TAG_ALT flag to flag the 'long' loops (parallel to beveled edge) @@ -1495,8 +1495,8 @@ static void offset_meet(BevelParams *bp, } } -/* This was changed from 0.25f to fix bug T86768. Original bug T44961 remainx fixed with this - * value. */ +/* This was changed from 0.25f to fix bug T86768. + * Original bug T44961 remains fixed with this value. */ #define BEVEL_GOOD_ANGLE 0.0001f /** diff --git a/source/blender/draw/engines/eevee/eevee_engine.c b/source/blender/draw/engines/eevee/eevee_engine.c index 9d4f7865c32..6a66e8b1a58 100644 --- a/source/blender/draw/engines/eevee/eevee_engine.c +++ b/source/blender/draw/engines/eevee/eevee_engine.c @@ -178,19 +178,19 @@ static void eevee_cache_finish(void *vedata) } EEVEE_renderpasses_output_init(sldata, vedata, tot_samples); - /* Restart taa if a shader has finish compiling. */ - /* HACK We should use notification of some sort from the compilation job instead. */ + /* Restart TAA if a shader has finish compiling. */ + /* HACK: We should use notification of some sort from the compilation job instead. */ if (g_data->queued_shaders_count != g_data->queued_shaders_count_prev) { g_data->queued_shaders_count_prev = g_data->queued_shaders_count; EEVEE_temporal_sampling_reset(vedata); } } -/* As renders in an HDR offscreen buffer, we need draw everything once +/* As renders in an HDR off-screen buffer, we need draw everything once * during the background pass. This way the other drawing callback between * the background and the scene pass are visible. * NOTE: we could break it up in two passes using some depth test - * to reduce the fillrate */ + * to reduce the fill-rate. */ static void eevee_draw_scene(void *vedata) { EEVEE_PassList *psl = ((EEVEE_Data *)vedata)->psl; diff --git a/source/blender/draw/engines/gpencil/gpencil_cache_utils.c b/source/blender/draw/engines/gpencil/gpencil_cache_utils.c index 8a2aebc95ab..fc6ad68d753 100644 --- a/source/blender/draw/engines/gpencil/gpencil_cache_utils.c +++ b/source/blender/draw/engines/gpencil/gpencil_cache_utils.c @@ -287,7 +287,7 @@ GPENCIL_tLayer *gpencil_layer_cache_add(GPENCIL_PrivateData *pd, pd->is_render ? gpl->vertex_paint_opacity : pd->vertex_paint_opacity; /* Negate thickness sign to tag that strokes are in screen space. - * Convert to world units (by default, 1 meter = 2000 px). */ + * Convert to world units (by default, 1 meter = 2000 pixels). */ float thickness_scale = (is_screenspace) ? -1.0f : (gpd->pixfactor / GPENCIL_PIXEL_FACTOR); float layer_opacity = gpencil_layer_final_opacity_get(pd, ob, gpl); float layer_tint[4]; diff --git a/source/blender/draw/engines/overlay/overlay_outline.c b/source/blender/draw/engines/overlay/overlay_outline.c index b50dc08bb97..03d70a37519 100644 --- a/source/blender/draw/engines/overlay/overlay_outline.c +++ b/source/blender/draw/engines/overlay/overlay_outline.c @@ -196,7 +196,7 @@ static void gpencil_layer_cache_populate(bGPDlayer *gpl, float object_scale = mat4_to_scale(iter->ob->obmat); /* Negate thickness sign to tag that strokes are in screen space. - * Convert to world units (by default, 1 meter = 2000 px). */ + * Convert to world units (by default, 1 meter = 2000 pixels). */ float thickness_scale = (is_screenspace) ? -1.0f : (gpd->pixfactor / 2000.0f); DRWShadingGroup *grp = iter->stroke_grp = DRW_shgroup_create_sub(iter->stroke_grp); diff --git a/source/blender/draw/intern/draw_cache_impl_volume.c b/source/blender/draw/intern/draw_cache_impl_volume.c index a91a1391c31..cba063ed5ef 100644 --- a/source/blender/draw/intern/draw_cache_impl_volume.c +++ b/source/blender/draw/intern/draw_cache_impl_volume.c @@ -304,7 +304,7 @@ static DRWVolumeGrid *volume_grid_cache_get(const Volume *volume, BLI_addtail(&cache->grids, cache_grid); /* TODO: can we load this earlier, avoid accessing the global and take - * advantage of dependency graph multithreading? */ + * advantage of dependency graph multi-threading? */ BKE_volume_load(volume, G.main); /* Test if we support textures with the number of channels. */ diff --git a/source/blender/draw/intern/draw_cache_inline.h b/source/blender/draw/intern/draw_cache_inline.h index b977d0cdda2..5e349d43538 100644 --- a/source/blender/draw/intern/draw_cache_inline.h +++ b/source/blender/draw/intern/draw_cache_inline.h @@ -74,8 +74,8 @@ BLI_INLINE void DRW_ibo_request(GPUBatch *batch, GPUIndexBuf **ibo) BLI_INLINE bool DRW_ibo_requested(GPUIndexBuf *ibo) { - /* TODO: do not rely on data uploaded. This prevents multithreading. - * (need access to a gl context) */ + /* TODO: do not rely on data uploaded. This prevents multi-threading. + * (need access to a OpenGL context). */ return (ibo != NULL && !GPU_indexbuf_is_init(ibo)); } @@ -85,7 +85,7 @@ BLI_INLINE void DRW_vbo_request(GPUBatch *batch, GPUVertBuf **vbo) *vbo = GPU_vertbuf_calloc(); } if (batch != NULL) { - /* HACK we set vbos that may not yet be valid. */ + /* HACK we set VBO's that may not yet be valid. */ GPU_batch_vertbuf_add(batch, *vbo); } } diff --git a/source/blender/draw/intern/draw_manager.h b/source/blender/draw/intern/draw_manager.h index c4e8d0a980d..512c2775850 100644 --- a/source/blender/draw/intern/draw_manager.h +++ b/source/blender/draw/intern/draw_manager.h @@ -110,8 +110,8 @@ typedef struct DRWCullingState { /* Minimum max UBO size is 64KiB. We take the largest * UBO struct and alloc the max number. - * ((1 << 16) / sizeof(DRWObjectMatrix)) = 512 - * Keep in sync with common_view_lib.glsl */ + * `((1 << 16) / sizeof(DRWObjectMatrix)) = 512` + * Keep in sync with `common_view_lib.glsl`. */ #define DRW_RESOURCE_CHUNK_LEN 512 /** diff --git a/source/blender/editors/gpencil/annotate_draw.c b/source/blender/editors/gpencil/annotate_draw.c index 196fb88ea55..7795eed7c21 100644 --- a/source/blender/editors/gpencil/annotate_draw.c +++ b/source/blender/editors/gpencil/annotate_draw.c @@ -918,7 +918,7 @@ void ED_annotation_draw_view3d( return; } - /* when rendering to the offscreen buffer we don't want to + /* When rendering to the off-screen buffer we don't want to * deal with the camera border, otherwise map the coords to the camera border. */ if ((rv3d->persp == RV3D_CAMOB) && !(G.f & G_FLAG_RENDER_VIEWPORT)) { rctf rectf; diff --git a/source/blender/editors/include/BIF_glutil.h b/source/blender/editors/include/BIF_glutil.h index 1d688b2ad68..0a1cf643f37 100644 --- a/source/blender/editors/include/BIF_glutil.h +++ b/source/blender/editors/include/BIF_glutil.h @@ -49,17 +49,17 @@ typedef struct IMMDrawPixelsTexState { IMMDrawPixelsTexState immDrawPixelsTexSetup(int builtin); /** - * immDrawPixelsTex - Functions like a limited glDrawPixels, but actually draws the + * #immDrawPixelsTex - Functions like a limited #glDrawPixels, but actually draws the * image using textures, which can be tremendously faster on low-end * cards, and also avoids problems with the raster position being - * clipped when offscreen. Pixel unpacking parameters and - * the glPixelZoom values are _not_ respected. + * clipped when off-screen. Pixel unpacking parameters and + * the #glPixelZoom values are _not_ respected. * - * \attention Use immDrawPixelsTexSetup before calling this function. + * \attention Use #immDrawPixelsTexSetup before calling this function. * - * \attention This routine makes many assumptions: the rect data + * \attention This routine makes many assumptions: the `rect` data * is expected to be in RGBA byte or float format, and the - * modelview and projection matrices are assumed to define a + * model-view and projection matrices are assumed to define a * 1-to-1 mapping to screen space. */ void immDrawPixelsTex(IMMDrawPixelsTexState *state, diff --git a/source/blender/editors/interface/interface_icons.c b/source/blender/editors/interface/interface_icons.c index 975c86f3e71..0ffc5659191 100644 --- a/source/blender/editors/interface/interface_icons.c +++ b/source/blender/editors/interface/interface_icons.c @@ -286,18 +286,15 @@ static void vicon_small_tri_right_draw(int x, int y, int w, int UNUSED(h), float static void vicon_keytype_draw_wrapper( int x, int y, int w, int h, float alpha, short key_type, short handle_type) { - /* init dummy theme state for Action Editor - where these colors are defined - * (since we're doing this offscreen, free from any particular space_id) - */ + /* Initialize dummy theme state for Action Editor - where these colors are defined + * (since we're doing this off-screen, free from any particular space_id). */ struct bThemeState theme_state; UI_Theme_Store(&theme_state); UI_SetTheme(SPACE_ACTION, RGN_TYPE_WINDOW); - /* the "x" and "y" given are the bottom-left coordinates of the icon, - * while the draw_keyframe_shape() function needs the midpoint for - * the keyframe - */ + /* The "x" and "y" given are the bottom-left coordinates of the icon, + * while the #draw_keyframe_shape() function needs the midpoint for the keyframe. */ const float xco = x + w / 2 + 0.5f; const float yco = y + h / 2 + 0.5f; @@ -1347,8 +1344,8 @@ void ui_icon_ensure_deferred(const bContext *C, const int icon_id, const bool bi case ICON_TYPE_PREVIEW: { ID *id = (icon->id_type != 0) ? icon->obj : NULL; PreviewImage *prv = id ? BKE_previewimg_id_ensure(id) : icon->obj; - /* Using jobs for screen previews crashes due to offscreen rendering. - * XXX would be nicer if PreviewImage could store if it supports jobs */ + /* Using jobs for screen previews crashes due to off-screen rendering. + * XXX: would be nicer if #PreviewImage could store if it supports jobs. */ const bool use_jobs = !id || (GS(id->name) != ID_SCR); if (prv) { @@ -2144,7 +2141,7 @@ static int ui_id_brush_get_icon(const bContext *C, ID *id) static int ui_id_screen_get_icon(const bContext *C, ID *id) { BKE_icon_id_ensure(id); - /* Don't use jobs here, offscreen rendering doesn't like this and crashes. */ + /* Don't use jobs here, off-screen rendering doesn't like this and crashes. */ ui_id_icon_render(C, id, false); return id->icon_id; diff --git a/source/blender/editors/interface/interface_region_popover.c b/source/blender/editors/interface/interface_region_popover.c index b8c4d8ddb09..f8f19c2e43d 100644 --- a/source/blender/editors/interface/interface_region_popover.c +++ b/source/blender/editors/interface/interface_region_popover.c @@ -188,7 +188,7 @@ static uiBlock *ui_block_func_POPOVER(bContext *C, uiPopupBlockHandle *handle, v } } - /* Estimated a maximum size so we don't go offscreen for low height + /* Estimated a maximum size so we don't go off-screen for low height * areas near the bottom of the window on refreshes. */ handle->max_size_y = UI_UNIT_Y * 16.0f; } diff --git a/source/blender/editors/interface/resources.c b/source/blender/editors/interface/resources.c index afac254f542..c9bfd883332 100644 --- a/source/blender/editors/interface/resources.c +++ b/source/blender/editors/interface/resources.c @@ -1089,7 +1089,7 @@ bTheme *UI_GetTheme(void) } /** - * for the rare case we need to temp swap in a different theme (offscreen render) + * For the rare case we need to temp swap in a different theme (off-screen render). */ void UI_Theme_Store(struct bThemeState *theme_state) { diff --git a/source/blender/editors/render/render_opengl.c b/source/blender/editors/render/render_opengl.c index 17aaa5aa79d..d3307ebf274 100644 --- a/source/blender/editors/render/render_opengl.c +++ b/source/blender/editors/render/render_opengl.c @@ -767,7 +767,7 @@ static bool screen_opengl_render_init(bContext *C, wmOperator *op) sizey = (scene->r.size * scene->r.ysch) / 100; /* corrects render size with actual size, not every card supports non-power-of-two dimensions */ - DRW_opengl_context_enable(); /* Offscreen creation needs to be done in DRW context. */ + DRW_opengl_context_enable(); /* Off-screen creation needs to be done in DRW context. */ ofs = GPU_offscreen_create(sizex, sizey, true, true, err_out); DRW_opengl_context_disable(); diff --git a/source/blender/editors/sculpt_paint/paint_image_proj.c b/source/blender/editors/sculpt_paint/paint_image_proj.c index 19f72a66b9b..a8ad6ab1b74 100644 --- a/source/blender/editors/sculpt_paint/paint_image_proj.c +++ b/source/blender/editors/sculpt_paint/paint_image_proj.c @@ -270,7 +270,7 @@ typedef struct ProjPaintState { float stencil_value; /* projection painting only */ - /** for multithreading, the first item is sometimes used for non threaded cases too. */ + /** For multi-threading, the first item is sometimes used for non threaded cases too. */ MemArena *arena_mt[BLENDER_MAX_THREADS]; /** screen sized 2D array, each pixel has a linked list of ProjPixel's */ LinkNode **bucketRect; @@ -4449,7 +4449,7 @@ static void project_paint_begin(const bContext *C, ProjPaintFaceLookup face_lookup; const MLoopUV *mloopuv_base = NULL; - /* at the moment this is just ps->arena_mt[0], but use this to show were not multithreading */ + /* At the moment this is just ps->arena_mt[0], but use this to show were not multi-threading. */ MemArena *arena; const int diameter = 2 * BKE_brush_size_get(ps->scene, ps->brush); diff --git a/source/blender/editors/space_node/node_draw.cc b/source/blender/editors/space_node/node_draw.cc index 7eca5c0c933..6ec6315a238 100644 --- a/source/blender/editors/space_node/node_draw.cc +++ b/source/blender/editors/space_node/node_draw.cc @@ -2125,7 +2125,7 @@ void node_draw_space(const bContext *C, ARegion *region) SpaceNode *snode = CTX_wm_space_node(C); View2D *v2d = ®ion->v2d; - /* Setup offscreen buffers. */ + /* Setup off-screen buffers. */ GPUViewport *viewport = WM_draw_region_get_viewport(region); GPUFrameBuffer *framebuffer_overlay = GPU_viewport_framebuffer_overlay_get(viewport); diff --git a/source/blender/editors/space_view3d/view3d_draw.c b/source/blender/editors/space_view3d/view3d_draw.c index c97ba7ba7e9..d87c14b9844 100644 --- a/source/blender/editors/space_view3d/view3d_draw.c +++ b/source/blender/editors/space_view3d/view3d_draw.c @@ -1602,7 +1602,7 @@ void view3d_main_region_draw(const bContext *C, ARegion *region) /** \} */ /* -------------------------------------------------------------------- */ -/** \name Offscreen Drawing +/** \name Off-screen Drawing * \{ */ static void view3d_stereo3d_setup_offscreen(Depsgraph *depsgraph, diff --git a/source/blender/functions/FN_cpp_type.hh b/source/blender/functions/FN_cpp_type.hh index 421e5f0018d..bc3f398c8e9 100644 --- a/source/blender/functions/FN_cpp_type.hh +++ b/source/blender/functions/FN_cpp_type.hh @@ -163,7 +163,7 @@ class CPPType : NonCopyable, NonMovable { * Required memory in bytes for an instance of this type. * * C++ equivalent: - * sizeof(T); + * `sizeof(T);` */ int64_t size() const { diff --git a/source/blender/gpu/intern/gpu_batch.cc b/source/blender/gpu/intern/gpu_batch.cc index 677777132e6..0e5c7900da9 100644 --- a/source/blender/gpu/intern/gpu_batch.cc +++ b/source/blender/gpu/intern/gpu_batch.cc @@ -268,7 +268,7 @@ void GPU_batch_draw_advanced( } if (i_count == 0) { i_count = (batch->inst[0]) ? batch->inst_(0)->vertex_len : 1; - /* Meh. This is to be able to use different numbers of verts in instance vbos. */ + /* Meh. This is to be able to use different numbers of verts in instance VBO's. */ if (batch->inst[1] != nullptr) { i_count = min_ii(i_count, batch->inst_(1)->vertex_len); } diff --git a/source/blender/gpu/intern/gpu_select_sample_query.cc b/source/blender/gpu/intern/gpu_select_sample_query.cc index fc755568687..7b9b3020639 100644 --- a/source/blender/gpu/intern/gpu_select_sample_query.cc +++ b/source/blender/gpu/intern/gpu_select_sample_query.cc @@ -56,7 +56,7 @@ struct GPUSelectQueryState { Vector *ids; /* Cache on initialization. */ uint (*buffer)[4]; - /* Buffer size (stores number of integers, for actual size multiply by sizeof integer). */ + /* Buffer size (stores number of integers, for actual size multiply by `sizeof(int)`). */ uint bufsize; /* Mode of operation. */ char mode; diff --git a/source/blender/gpu/opengl/gl_context.cc b/source/blender/gpu/opengl/gl_context.cc index 23654cb96f3..09bc0aa6e58 100644 --- a/source/blender/gpu/opengl/gl_context.cc +++ b/source/blender/gpu/opengl/gl_context.cc @@ -93,7 +93,7 @@ GLContext::GLContext(void *ghost_window, GLSharedOrphanLists &shared_orphan_list } } else { - /* For offscreen contexts. Default framebuffer is NULL. */ + /* For off-screen contexts. Default frame-buffer is NULL. */ back_left = new GLFrameBuffer("back_left", this, GL_NONE, 0, 0, 0); } diff --git a/source/blender/makesdna/DNA_view3d_enums.h b/source/blender/makesdna/DNA_view3d_enums.h index 3de430e1177..aec52da1bf9 100644 --- a/source/blender/makesdna/DNA_view3d_enums.h +++ b/source/blender/makesdna/DNA_view3d_enums.h @@ -24,7 +24,7 @@ extern "C" { #endif -/** Settings for offscreen rendering */ +/** Settings for off-screen rendering. */ typedef enum eV3DOffscreenDrawFlag { V3D_OFSDRAW_NONE = (0), V3D_OFSDRAW_SHOW_ANNOTATION = (1 << 0), diff --git a/source/blender/windowmanager/wm_surface.h b/source/blender/windowmanager/wm_surface.h index 36d74f612fc..a2483d38154 100644 --- a/source/blender/windowmanager/wm_surface.h +++ b/source/blender/windowmanager/wm_surface.h @@ -19,7 +19,7 @@ * * \name WM-Surface * - * Container to manage painting in an offscreen context. + * Container to manage painting in an off-screen context. */ #pragma once diff --git a/source/blender/windowmanager/xr/intern/wm_xr_intern.h b/source/blender/windowmanager/xr/intern/wm_xr_intern.h index 24582388228..6415f96e322 100644 --- a/source/blender/windowmanager/xr/intern/wm_xr_intern.h +++ b/source/blender/windowmanager/xr/intern/wm_xr_intern.h @@ -92,7 +92,7 @@ typedef struct wmXrViewportPair { } wmXrViewportPair; typedef struct { - /* Offscreen buffers/viewports for each view. */ + /** Off-screen buffers/viewports for each view. */ ListBase viewports; /* wmXrViewportPair */ } wmXrSurfaceData; -- cgit v1.2.3