Cleanup: spelling in comments

This commit is contained in:
Campbell Barton 2023-08-05 13:46:22 +10:00
parent 07019e7ef5
commit 7f34ad736a
42 changed files with 104 additions and 97 deletions

@ -19,9 +19,9 @@ CCL_NAMESPACE_BEGIN
# define GPU_PARALLEL_ACTIVE_INDEX_DEFAULT_BLOCK_SIZE 512
#endif
/* TODO: abstract more device differences, define ccl_gpu_local_syncthreads,
* ccl_gpu_thread_warp, ccl_gpu_warp_index, ccl_gpu_num_warps for all devices
* and keep device specific code in compat.h */
/* TODO: abstract more device differences, define `ccl_gpu_local_syncthreads`,
* `ccl_gpu_thread_warp`, `ccl_gpu_warp_index`, `ccl_gpu_num_warps` for all devices
* and keep device specific code in `compat.h`. */
#ifdef __KERNEL_ONEAPI__

@ -247,8 +247,8 @@ class GHOST_DeviceVK {
generic_queue_family = 0;
for (const auto &queue_family : queue_families) {
/* Every vulkan implementation by spec must have one queue family that support both graphics
* and compute pipelines. We select this one; compute only queue family hints at async
/* Every VULKAN implementation by spec must have one queue family that support both graphics
* and compute pipelines. We select this one; compute only queue family hints at asynchronous
* compute implementations. */
if ((queue_family.queueFlags & VK_QUEUE_GRAPHICS_BIT) &&
(queue_family.queueFlags & VK_QUEUE_COMPUTE_BIT))

@ -149,8 +149,9 @@ class GHOST_Wintab {
* \param wtY: Wintab cursor y position.
* \return True if Win32 and Wintab cursor positions match within tolerance.
*
* NOTE: Only test coordinates on button press, not release. This prevents issues when async
* mismatch causes mouse movement to replay and snap back, which is only an issue while drawing.
* NOTE: Only test coordinates on button press, not release.
* This prevents issues when asynchronous mismatch causes mouse movement to replay
* and snap back, which is only an issue while drawing.
*/
bool testCoordinates(int sysX, int sysY, int wtX, int wtY);

@ -3139,7 +3139,8 @@ SoftBody *sbNew(void)
sb->inspring = 0.5f;
sb->infrict = 0.5f;
/* TODO: backward file compat should copy `inspring` to `inpush` while reading old files. */
/* TODO: backward file compatibility should copy `inspring` to `inpush` while reading old files.
*/
sb->inpush = 0.5f;
sb->colball = 0.49f;
@ -3152,7 +3153,8 @@ SoftBody *sbNew(void)
sb->choke = 3;
sb_new_scratch(sb);
/* TODO: backward file compat should set `sb->shearstiff = 1.0f` while reading old files. */
/* TODO: backward file compatibility should set `sb->shearstiff = 1.0f` while reading old files.
*/
sb->shearstiff = 1.0f;
sb->solverflags |= SBSO_OLDERR;

@ -2750,7 +2750,7 @@ void do_versions_after_linking_280(FileData *fd, Main *bmain)
}
if (!MAIN_VERSION_FILE_ATLEAST(bmain, 280, 66)) {
/* Shader node tree changes. After lib linking so we have all the typeinfo
/* Shader node tree changes. After lib linking so we have all the type-info
* pointers and updated sockets and we can use the high level node API to
* manipulate nodes. */
FOREACH_NODETREE_BEGIN (bmain, ntree, id) {

@ -140,7 +140,7 @@
#define RBUFS_CRYPTOMATTE_SLOT 2
#define GBUF_CLOSURE_SLOT 3
#define GBUF_COLOR_SLOT 4
/* Volume properties pass do not write to rbufs. Reuse the same bind points. */
/* Volume properties pass do not write to `rbufs`. Reuse the same bind points. */
#define VOLUME_PROP_SCATTERING_IMG_SLOT 0
#define VOLUME_PROP_EXTINCTION_IMG_SLOT 1
#define VOLUME_PROP_EMISSION_IMG_SLOT 2

@ -27,7 +27,7 @@ struct EEVEE_NEXT_LightBake;
/**
* Create the job description.
* This is called for async (modal) bake operator.
* This is called for asynchronous (modal) bake operator.
* The actual work will be done by `EEVEE_NEXT_lightbake_job()`.
* IMPORTANT: Must run on the main thread because of potential GPUContext creation.
*/

@ -5,7 +5,7 @@
/** \file
* \ingroup eevee
*
* The raytracing module class handles ray generation, scheduling, tracing and denoising.
* The ray-tracing module class handles ray generation, scheduling, tracing and denoising.
*/
#include <fstream>
@ -312,9 +312,9 @@ RayTraceResult RayTraceModule::trace(RayTraceBuffer &rt_buffer,
TextureFromPool::swap(tile_mask_tx_, denoise_buf->tilemask_history_tx);
/* Save view-projection matrix for next reprojection. */
denoise_buf->history_persmat = main_view.persmat();
/* Radiance will be swapped with history in RayTraceResult::release().
/* Radiance will be swapped with history in #RayTraceResult::release().
* Variance is swapped with history after bilateral denoise.
* It keeps dataflow easier to follow. */
* It keeps data-flow easier to follow. */
result = {denoise_buf->denoised_temporal_tx, denoise_buf->radiance_history_tx};
/* Not referenced by result anymore. */
denoise_buf->denoised_spatial_tx.release();

@ -21,7 +21,7 @@ namespace blender::eevee {
class Instance;
/* -------------------------------------------------------------------- */
/** \name Raytracing Buffers
/** \name Ray-tracing Buffers
*
* Contain persistent data used for temporal denoising. Similar to \class GBuffer but only contains
* persistent data.
@ -66,7 +66,7 @@ class RayTraceResult {
private:
/** Result is in a temporary texture that needs to be released. */
TextureFromPool *result_ = nullptr;
/** History buffer to swap the tmp texture that does not need to be released. */
/** History buffer to swap the temporary texture that does not need to be released. */
Texture *history_ = nullptr;
public:
@ -94,7 +94,7 @@ class RayTraceResult {
/** \} */
/* -------------------------------------------------------------------- */
/** \name Raytracing
/** \name Ray-tracing
* \{ */
class RayTraceModule {
@ -119,14 +119,15 @@ class RayTraceModule {
int3 tile_compact_dispatch_size_ = int3(1);
/** 2D tile mask to check which unused adjacent tile we need to clear. */
TextureFromPool tile_mask_tx_ = {"tile_mask_tx"};
/** Indirect dispatch rays. Avoid dispatching workgroups that ultimately won't do any tracing. */
/** Indirect dispatch rays. Avoid dispatching work-groups that ultimately won't do any tracing.
*/
DispatchIndirectBuf ray_dispatch_buf_ = {"ray_dispatch_buf_"};
/** Indirect dispatch denoise full-resolution tiles. */
DispatchIndirectBuf denoise_dispatch_buf_ = {"denoise_dispatch_buf_"};
/** Tile buffer that contains tile coordinates. */
RayTraceTileBuf ray_tiles_buf_ = {"ray_tiles_buf_"};
RayTraceTileBuf denoise_tiles_buf_ = {"denoise_tiles_buf_"};
/** Texture containing the ray direction and pdf. */
/** Texture containing the ray direction and PDF. */
TextureFromPool ray_data_tx_ = {"ray_data_tx"};
/** Texture containing the ray hit time. */
TextureFromPool ray_time_tx_ = {"ray_data_tx"};
@ -149,9 +150,9 @@ class RayTraceModule {
/** Dummy texture when the tracing is disabled. */
TextureFromPool dummy_result_tx_ = {"dummy_result_tx"};
/** Pointer to inst_.render_buffers.depth_tx.stencil_view() updated before submission. */
/** Pointer to `inst_.render_buffers.depth_tx.stencil_view()` updated before submission. */
GPUTexture *renderbuf_stencil_view_ = nullptr;
/** Pointer to inst_.render_buffers.depth_tx updated before submission. */
/** Pointer to `inst_.render_buffers.depth_tx` updated before submission. */
GPUTexture *renderbuf_depth_view_ = nullptr;
/** Copy of the scene options to avoid changing parameters during motion blur. */

@ -1082,7 +1082,7 @@ struct RayTraceData {
int2 full_resolution;
/** Inverse of input resolution to get screen UVs. */
float2 full_resolution_inv;
/** Scale and bias to go from raytrace resolution to input resolution. */
/** Scale and bias to go from ray-trace resolution to input resolution. */
int2 resolution_bias;
int resolution_scale;
/** View space thickness the objects. */

@ -196,8 +196,8 @@ bool SyncModule::sync_sculpt(Object *ob,
return false;
}
/* Use a valid bounding box. The PBVH module already does its own culling,
* but a valid bounding box is still needed for directional shadow tilemap bounds computation. */
/* Use a valid bounding box. The PBVH module already does its own culling, but a valid */
/* bounding box is still needed for directional shadow tile-map bounds computation. */
float3 min, max;
BKE_pbvh_bounding_box(ob_ref.object->sculpt->pbvh, min, max);
float3 center = (min + max) * 0.5;

@ -4,7 +4,7 @@
#pragma once
/* Used for shaders that need the final accumulated volume transmittance and scaterring. */
/* Used for shaders that need the final accumulated volume transmittance and scattering. */
GPU_SHADER_CREATE_INFO(eevee_volume_lib)
.additional_info("eevee_shared")
.additional_info("draw_view")

@ -339,7 +339,7 @@ PassType *volume_object_grids_init(PassType &ps,
const GPUTexture *grid_tex = (drw_grid) ? drw_grid->texture :
(volume_grid) ? g_data.dummy_zero :
grid_default_texture(attr->default_value);
/* TODO (Miguel Pozo): bind_texture const support ? */
/* TODO(@pragma37): bind_texture const support ? */
sub->bind_texture(attr->input_name, (GPUTexture *)grid_tex);
volume_infos.grids_xform[grid_id++] = float4x4(drw_grid ? drw_grid->object_to_texture :

@ -382,7 +382,7 @@ void ED_asset_shelf_region_layout(const bContext *C, ARegion *region)
RegionAssetShelf *shelf_regiondata = RegionAssetShelf::get_from_asset_shelf_region(*region);
if (!shelf_regiondata) {
/* Regiondata should've been created by a previously called ED_asset_shelf_region_init(). */
/* Region-data should've been created by a previously called #ED_asset_shelf_region_init(). */
BLI_assert_unreachable();
return;
}

@ -252,7 +252,7 @@ void ED_armature_edit_free(bArmature *arm);
void ED_armature_ebone_listbase_temp_clear(ListBase *lb);
/**
* Free's bones and their properties.
* Free list of bones and their properties.
*/
void ED_armature_ebone_listbase_free(ListBase *lb, bool do_id_user);
void ED_armature_ebone_listbase_copy(ListBase *lb_dst, ListBase *lb_src, bool do_id_user);

@ -199,7 +199,7 @@ int delete_keyframe(Main *bmain,
/** \name Keying Sets
* \{ */
/* forward decl. for this struct which is declared a bit later... */
/* Forward declaration. For this struct which is declared a bit later. */
struct ExtensionRNA;
struct KeyingSetInfo;
@ -218,7 +218,7 @@ struct KeyingSetInfo {
KeyingSetInfo *next, *prev;
/* info */
/* identifier used for class name, which KeyingSet instances reference as "Typeinfo Name" */
/* identifier used for class name, which KeyingSet instances reference as "Type-info Name" */
char idname[64];
/* identifier so that user can hook this up to a KeyingSet (used as label). */
char name[64];
@ -259,9 +259,9 @@ typedef enum eModifyKey_Modes {
/* return codes for errors (with Relative KeyingSets) */
typedef enum eModifyKey_Returns {
/* context info was invalid for using the Keying Set */
/** Context info was invalid for using the Keying Set. */
MODIFYKEY_INVALID_CONTEXT = -1,
/* there isn't any typeinfo for generating paths from context */
/** There isn't any type-info for generating paths from context. */
MODIFYKEY_MISSING_TYPEINFO = -2,
} eModifyKey_Returns;
@ -389,7 +389,7 @@ bool ANIM_keyingset_context_ok_poll(bContext *C, KeyingSet *ks);
enum eCreateDriverFlags {
/** create drivers with a default variable for nicer UI */
CREATEDRIVER_WITH_DEFAULT_DVAR = (1 << 0),
/** create drivers with Generator FModifier (for backwards compat) */
/** Create drivers with Generator FModifier (for backwards compatibility). */
CREATEDRIVER_WITH_FMODIFIER = (1 << 1),
};

@ -156,7 +156,7 @@ int *BM_uv_element_map_ensure_unique_index(UvElementMap *element_map);
*/
bool EDBM_uv_check(BMEditMesh *em);
/**
* last_sel, use em->act_face otherwise get the last selected face in the editselections
* last_sel, use em->act_face otherwise get the last selected face in the edit-selections
* at the moment, last_sel is mainly useful for making sure the space image doesn't flicker.
*/
BMFace *EDBM_uv_active_face_get(BMEditMesh *em, bool sloppy, bool selected);
@ -376,7 +376,7 @@ void ED_operatormacros_mesh();
*/
void ED_keymap_mesh(wmKeyConfig *keyconf);
/* editface.cc */
/* `editface.cc` */
/**
* Copy the face flags, most importantly selection from the mesh to the final derived mesh,

@ -38,11 +38,11 @@ ENUM_OPERATORS(NodeBorder, NODE_RIGHT)
#define NODE_EDGE_PAN_DELAY 0.5f
#define NODE_EDGE_PAN_ZOOM_INFLUENCE 0.5f
/* clipboard.cc */
/* `clipboard.cc` */
void ED_node_clipboard_free();
/* space_node.cc */
/* `space_node.cc` */
void ED_node_cursor_location_get(const SpaceNode *snode, float value[2]);
void ED_node_cursor_location_set(SpaceNode *snode, const float value[2]);
@ -61,7 +61,7 @@ bNodeTree *ED_node_tree_get(SpaceNode *snode, int level);
void ED_node_set_active_viewer_key(SpaceNode *snode);
/* drawnode.cc */
/* `drawnode.cc` */
void ED_node_init_butfuncs();
void ED_init_custom_node_type(bNodeType *ntype);
@ -73,14 +73,14 @@ void ED_node_draw_snap(
View2D *v2d, const float cent[2], float size, NodeBorder border, unsigned int pos);
void ED_node_type_draw_color(const char *idname, float *r_color);
/* node_draw.cc */
/* `node_draw.cc` */
void ED_node_tree_update(const bContext *C);
void ED_node_tag_update_id(ID *id);
float ED_node_grid_size();
/* node_edit.cc */
/* `node_edit.cc` */
void ED_node_set_tree_type(SpaceNode *snode, bNodeTreeType *typeinfo);
bool ED_node_is_compositor(SpaceNode *snode);
@ -135,11 +135,11 @@ void ED_node_tree_propagate_change(const bContext *C, Main *bmain, bNodeTree *nt
*/
void ED_node_composite_job(const bContext *C, bNodeTree *nodetree, Scene *scene_owner);
/* node_ops.cc */
/* `node_ops.cc` */
void ED_operatormacros_node();
/* node_view.cc */
/* `node_view.cc` */
/**
* Returns mouse position in image space.

@ -2025,7 +2025,7 @@ enum eUI_Item_Flag {
/**
* Don't attempt to use an icon when the icon is set to #ICON_NONE.
*
* Use for boolean's, causes the buttons to always show as a checkbox
* Use for booleans, causes the buttons to always show as a checkbox
* even when there is an icon (which would normally show the button as a toggle).
*/
UI_ITEM_R_ICON_NEVER = 1 << 4,

@ -2362,7 +2362,7 @@ static int file_smoothscroll_invoke(bContext *C, wmOperator * /*op*/, const wmEv
const int numfiles = filelist_files_ensure(sfile->files);
/* Due to async nature of file listing, we may execute this code before `file_refresh()`
/* Due to asynchronous nature of file listing, we may execute this code before `file_refresh()`
* editing entry is available in our listing,
* so we also have to handle switching to rename mode here. */
FileSelectParams *params = ED_fileselect_get_active_params(sfile);

@ -1410,7 +1410,7 @@ void file_params_renamefile_activate(SpaceFile *sfile, FileSelectParams *params)
params->rename_flag = FILE_PARAMS_RENAME_POSTSCROLL_ACTIVE;
}
}
/* File listing is now async, only reset renaming if matching entry is not found
/* File listing is now asynchronous, only reset renaming if matching entry is not found
* when file listing is not done. */
else if (filelist_is_ready(sfile->files)) {
file_params_renamefile_clear(params);

@ -594,9 +594,10 @@ int fsmenu_get_active_indices(FSMenu *fsmenu, enum FSMenuCategory category, cons
return -1;
}
/* Thanks to some bookmarks sometimes being network drives that can have tens of seconds of delay
* before being defined as unreachable by the OS, we need to validate the bookmarks in an async
* job...
/**
* Thanks to some bookmarks sometimes being network drives that can have tens of seconds of delay
* before being defined as unreachable by the OS, we need to validate the bookmarks in an
* asynchronous job.
*/
static void fsmenu_bookmark_validate_job_startjob(
void *fsmenuv,

@ -54,7 +54,7 @@ void fsmenu_read_bookmarks(struct FSMenu *fsmenu, const char *filepath);
/** adds system specific directories */
void fsmenu_read_system(struct FSMenu *fsmenu, int read_bookmarks);
/** Free's all the memory associated with the fsmenu */
/** Frees all the memory associated with the `fsmenu`. */
void fsmenu_free(void);
/** Refresh system directory menu */

@ -450,7 +450,7 @@ void fsmenu_read_system(FSMenu *fsmenu, int read_bookmarks)
}
/* Exclude "all my files" as it makes no sense in blender file-selector. */
/* Exclude "airdrop" if wlan not active as it would show "" ) */
/* Exclude "airdrop" if WLAN not active as it would show "". */
if (!strstr(line, "myDocuments.cannedSearch") && (*line != '\0')) {
fsmenu_insert_entry(fsmenu,
FS_CATEGORY_SYSTEM_BOOKMARKS,

@ -1028,7 +1028,7 @@ static void add_extrapolation_point_right(FCurve *fcu,
static blender::float2 calculate_resolution_scale(View2D *v2d)
{
/* The resolution for bezier forward diff in frame/value space. This ensures a constant
* resolution in screenspace. */
* resolution in screen-space. */
const int window_width = BLI_rcti_size_x(&v2d->mask);
const int window_height = BLI_rcti_size_y(&v2d->mask);
const float points_per_pixel = 0.25f;

@ -141,7 +141,7 @@ ENUM_OPERATORS(NodeResizeDirection, NODE_RESIZE_LEFT);
#define NODE_RESIZE_MARGIN (0.20f * U.widget_unit)
#define NODE_LINK_RESOL 12
/* space_node.cc */
/* `space_node.cc` */
/**
* Transform between View2Ds in the tree path.
@ -159,7 +159,7 @@ void node_socket_color_get(const bContext &C,
const bNodeSocket &sock,
float r_color[4]);
/* node_draw.cc */
/* `node_draw.cc` */
void node_draw_space(const bContext &C, ARegion &region);
@ -177,12 +177,12 @@ float2 node_to_view(const bNode &node, const float2 &co);
void node_to_updated_rect(const bNode &node, rctf &r_rect);
float2 node_from_view(const bNode &node, const float2 &co);
/* node_ops.cc */
/* `node_ops.cc` */
void node_operatortypes();
void node_keymap(wmKeyConfig *keyconf);
/* node_select.cc */
/* `node_select.cc` */
rctf node_frame_rect_inside(const SpaceNode &snode, const bNode &node);
bool node_or_socket_isect_event(const bContext &C, const wmEvent &event);
@ -209,7 +209,7 @@ void NODE_OT_select_grouped(wmOperatorType *ot);
void NODE_OT_select_same_type_step(wmOperatorType *ot);
void NODE_OT_find_node(wmOperatorType *ot);
/* node_view.cc */
/* `node_view.cc` */
bool space_node_view_flag(
bContext &C, SpaceNode &snode, ARegion &region, int node_flag, int smooth_viewtx);
@ -222,7 +222,7 @@ void NODE_OT_backimage_zoom(wmOperatorType *ot);
void NODE_OT_backimage_fit(wmOperatorType *ot);
void NODE_OT_backimage_sample(wmOperatorType *ot);
/* drawnode.cc */
/* `drawnode.cc` */
NodeResizeDirection node_get_resize_direction(const SpaceNode &snode,
const bNode *node,
@ -268,7 +268,7 @@ void draw_nodespace_back_pix(const bContext &C,
SpaceNode &snode,
bNodeInstanceKey parent_key);
/* node_add.cc */
/* `node_add.cc` */
bNode *add_node(const bContext &C, StringRef idname, const float2 &location);
bNode *add_static_node(const bContext &C, int type, const float2 &location);
@ -283,7 +283,7 @@ void NODE_OT_add_file(wmOperatorType *ot);
void NODE_OT_add_mask(wmOperatorType *ot);
void NODE_OT_new_node_tree(wmOperatorType *ot);
/* node_group.cc */
/* `node_group.cc` */
const char *node_group_idname(bContext *C);
void NODE_OT_group_make(wmOperatorType *ot);
@ -292,7 +292,7 @@ void NODE_OT_group_ungroup(wmOperatorType *ot);
void NODE_OT_group_separate(wmOperatorType *ot);
void NODE_OT_group_edit(wmOperatorType *ot);
/* node_relationships.cc */
/* `node_relationships.cc` */
void update_multi_input_indices_for_removed_links(bNode &node);
bool all_links_muted(const bNodeSocket &socket);
@ -314,7 +314,7 @@ void NODE_OT_insert_offset(wmOperatorType *ot);
wmKeyMap *node_link_modal_keymap(wmKeyConfig *keyconf);
/* node_edit.cc */
/* `node_edit.cc` */
float2 node_link_calculate_multi_input_position(const float2 &socket_position,
int index,
@ -381,14 +381,14 @@ void NODE_OT_clear_viewer_border(wmOperatorType *ot);
void NODE_OT_cryptomatte_layer_add(wmOperatorType *ot);
void NODE_OT_cryptomatte_layer_remove(wmOperatorType *ot);
/* node_gizmo.cc */
/* `node_gizmo.cc` */
void NODE_GGT_backdrop_transform(wmGizmoGroupType *gzgt);
void NODE_GGT_backdrop_crop(wmGizmoGroupType *gzgt);
void NODE_GGT_backdrop_sun_beams(wmGizmoGroupType *gzgt);
void NODE_GGT_backdrop_corner_pin(wmGizmoGroupType *gzgt);
/* node_geometry_attribute_search.cc */
/* `node_geometry_attribute_search.cc` */
void node_geometry_add_attribute_search_button(const bContext &C,
const bNode &node,
@ -399,18 +399,18 @@ void node_geometry_add_attribute_search_button(const bContext &C,
Vector<ui::ContextPathItem> context_path_for_space_node(const bContext &C);
/* link_drag_search.cc */
/* `link_drag_search.cc` */
void invoke_node_link_drag_add_menu(bContext &C,
bNode &node,
bNodeSocket &socket,
const float2 &cursor);
/* add_node_search.cc */
/* `add_node_search.cc` */
void invoke_add_node_search_menu(bContext &C, const float2 &cursor, bool use_transform);
/* add_menu_assets.cc */
/* `add_menu_assets.cc` */
MenuType add_catalog_assets_menu_type();
MenuType add_root_catalogs_menu_type();

@ -285,18 +285,18 @@ eGPUMaterialStatus GPU_material_status(GPUMaterial *mat);
void GPU_material_status_set(GPUMaterial *mat, eGPUMaterialStatus status);
/**
* Return status for async optimization jobs.
* Return status for asynchronous optimization jobs.
*/
eGPUMaterialOptimizationStatus GPU_material_optimization_status(GPUMaterial *mat);
void GPU_material_optimization_status_set(GPUMaterial *mat, eGPUMaterialOptimizationStatus status);
bool GPU_material_optimization_ready(GPUMaterial *mat);
/**
* Store reference to a similar default material for async PSO cache warming.
* Store reference to a similar default material for asynchronous PSO cache warming.
*
* This function expects `material` to have not yet been compiled and for `default_material` to be
* ready. When compiling `material` as part of an async shader compilation job, use existing PSO
* descriptors from `default_material`'s shader to also compile PSOs for this new material
* ready. When compiling `material` as part of an asynchronous shader compilation job, use existing
* PSO descriptors from `default_material`'s shader to also compile PSOs for this new material
* asynchronously, rather than at runtime.
*
* The default_material `options` should match this new materials options in order

@ -948,9 +948,9 @@ void GPU_material_compile(GPUMaterial *mat)
GPUShader *sh = GPU_pass_shader_get(mat->pass);
if (sh != nullptr) {
/** Perform async Render Pipeline State Object (PSO) compilation.
/** Perform asynchronous Render Pipeline State Object (PSO) compilation.
*
* Warm PSO cache within async compilation thread using default material as source.
* Warm PSO cache within asynchronous compilation thread using default material as source.
* GPU_shader_warm_cache(..) performs the API-specific PSO compilation using the assigned
* parent shader's cached PSO descriptors as an input.
*
@ -1040,9 +1040,9 @@ void GPU_material_optimize(GPUMaterial *mat)
if (success) {
GPUShader *sh = GPU_pass_shader_get(mat->optimized_pass);
if (sh != nullptr) {
/** Perform async Render Pipeline State Object (PSO) compilation.
/** Perform asynchronous Render Pipeline State Object (PSO) compilation.
*
* Warm PSO cache within async compilation thread for optimized materials.
* Warm PSO cache within asynchronous compilation thread for optimized materials.
* This setup assigns the original unoptimized shader as a "parent" shader
* for the optimized version. This then allows the associated GPU backend to
* compile PSOs within this asynchronous pass, using the identical PSO descriptors of the

@ -865,10 +865,10 @@ static char *glsl_patch_default_get()
STR_CONCAT(patch, slen, "uniform int gpu_BaseInstance;\n");
}
/* Vulkan GLSL compat. */
/* Vulkan GLSL compatibility. */
STR_CONCAT(patch, slen, "#define gpu_InstanceIndex (gl_InstanceID + gpu_BaseInstance)\n");
/* Array compat. */
/* Array compatibility. */
STR_CONCAT(patch, slen, "#define gpu_Array(_type) _type[]\n");
/* Derivative sign can change depending on implementation. */
@ -900,7 +900,7 @@ static char *glsl_patch_compute_get()
STR_CONCAT(patch, slen, "#define GPU_ARB_texture_cube_map_array\n");
}
/* Array compat. */
/* Array compatibility. */
STR_CONCAT(patch, slen, "#define gpu_Array(_type) _type[]\n");
STR_CONCAT(patch, slen, datatoc_glsl_shader_defines_glsl);

@ -261,7 +261,7 @@ pxr::GfCamera CameraData::gf_camera(pxr::GfVec4f tile)
case CAM_ORTHO: {
gf_camera.SetProjection(pxr::GfCamera::Projection::Orthographic);
/* Use tenths of a world unit accorging to USD docs
/* Use tenths of a world unit according to USD docs
* https://graphics.pixar.com/usd/docs/api/class_gf_camera.html */
float o_size[2] = {ortho_size_[0] * t_size[0] * 10, ortho_size_[1] * t_size[1] * 10};

@ -134,7 +134,7 @@ void CurvesData::write_materials()
{
const Object *object = (const Object *)id;
const Material *mat = nullptr;
/* TODO: Using only first material. Add support for multimaterial. */
/* TODO: Using only first material. Add support for multi-material. */
if (BKE_object_material_count_eval(object) > 0) {
mat = BKE_object_material_get_eval(const_cast<Object *>(object), 0);
}

@ -161,7 +161,7 @@ void InstancerData::update_instance(DupliObject *dupli)
void InstancerData::post_update()
{
/* Remove mesh intances without indices */
/* Remove mesh instances without indices. */
mesh_instances_.remove_if([&](auto item) {
bool res = item.value.indices.empty();
if (res) {
@ -170,13 +170,13 @@ void InstancerData::post_update()
return res;
});
/* Update light intances and remove instances without transforms */
/* Update light instances and remove instances without transforms. */
for (auto &l_inst : nonmesh_instances_.values()) {
update_nonmesh_instance(l_inst);
}
nonmesh_instances_.remove_if([&](auto item) { return item.value.transforms.empty(); });
/* Insert/remove/update instancer in RenderIndex */
/* Insert/remove/update instancer in RenderIndex. */
pxr::HdRenderIndex &index = scene_delegate_->GetRenderIndex();
if (mesh_instances_.is_empty()) {
/* Important: removing instancer when nonmesh_instances_ are empty too */

@ -65,7 +65,7 @@ void USDSceneDelegate::populate(Depsgraph *depsgraph)
delegate_.reset();
stage_.Reset();
/* Convert depsgraph to stage + aditional file in temp directory. */
/* Convert depsgraph to stage + additional file in temp directory. */
stage_ = io::usd::export_to_stage(params, depsgraph, temp_file_.c_str());
delegate_ = std::make_unique<pxr::UsdImagingDelegate>(render_index_, delegate_id_);
delegate_->Populate(stage_->GetPseudoRoot());

@ -152,7 +152,7 @@ void VolumeData::write_materials()
{
const Object *object = (Object *)id;
const Material *mat = nullptr;
/* TODO: Using only first material. Add support for multimaterial. */
/* TODO: Using only first material. Add support for multi-material. */
if (BKE_object_material_count_eval(object) > 0) {
mat = BKE_object_material_get_eval(const_cast<Object *>(object), 0);
}

@ -26,7 +26,7 @@
#include "hydra_scene_delegate.h"
#include "image.h"
/* TODO : add custom tftoken "transparency"? */
/* TODO: add custom `tftoken` "transparency"? */
/* NOTE: opacity and blur aren't supported by USD */

@ -1810,7 +1810,7 @@ typedef struct SceneDisplay {
} SceneDisplay;
/**
* Raytracing parameters.
* Ray-tracing parameters.
*/
typedef struct RaytraceEEVEE {
/** Higher values will take lower strides and have less blurry intersections. */
@ -2847,7 +2847,7 @@ typedef enum RaytraceEEVEE_DenoiseStages {
typedef enum RaytraceEEVEE_Method {
RAYTRACE_EEVEE_METHOD_NONE = 0,
RAYTRACE_EEVEE_METHOD_SCREEN = 1,
/* TODO(fclem): Hardware raytracing. */
/* TODO(fclem): Hardware ray-tracing. */
// RAYTRACE_EEVEE_METHOD_HARDWARE = 2,
} RaytraceEEVEE_Method;

@ -361,7 +361,7 @@ static void rna_Object_internal_update_draw(Main * /*bmain*/, Scene * /*scene*/,
static void rna_Object_matrix_world_update(Main *bmain, Scene *scene, PointerRNA *ptr)
{
/* don't use compat so we get predictable rotation */
/* Don't use compatibility so we get predictable rotation. */
Object *ob = reinterpret_cast<Object *>(ptr->owner_id);
BKE_object_apply_mat4(ob, ob->object_to_world, false, true);
rna_Object_internal_update(bmain, scene, ptr);

@ -818,7 +818,8 @@ static void rna_PoseChannel_matrix_basis_get(PointerRNA *ptr, float *values)
static void rna_PoseChannel_matrix_basis_set(PointerRNA *ptr, const float *values)
{
bPoseChannel *pchan = (bPoseChannel *)ptr->data;
BKE_pchan_apply_mat4(pchan, (float(*)[4])values, false); /* no compat for predictable result */
/* No compatibility for predictable result. */
BKE_pchan_apply_mat4(pchan, (const float(*)[4])values, false);
}
static void rna_PoseChannel_matrix_set(PointerRNA *ptr, const float *values)
@ -827,9 +828,10 @@ static void rna_PoseChannel_matrix_set(PointerRNA *ptr, const float *values)
Object *ob = (Object *)ptr->owner_id;
float tmat[4][4];
BKE_armature_mat_pose_to_bone_ex(nullptr, ob, pchan, (float(*)[4])values, tmat);
BKE_armature_mat_pose_to_bone_ex(nullptr, ob, pchan, (const float(*)[4])values, tmat);
BKE_pchan_apply_mat4(pchan, tmat, false); /* no compat for predictable result */
/* No compatibility for predictable result. */
BKE_pchan_apply_mat4(pchan, tmat, false);
}
static bPoseChannel *rna_PoseChannel_ensure_own_pchan(Object *ob,

@ -9,7 +9,7 @@ void PreviewEngine::notify_status(float /* progress */,
const std::string & /* title */,
const std::string & /* info */)
{
/* Empty fucntion */
/* Empty function. */
}
} // namespace blender::render::hydra

@ -10,7 +10,7 @@
#include "DNA_camera_types.h"
#include "DNA_scene_types.h"
#include "DNA_screen_types.h"
#include "DNA_vec_types.h" /* this include must be before BKE_camera.h due to "rctf" type */
#include "DNA_vec_types.h" /* This include must be before `BKE_camera.h` due to `rctf` type. */
#include "DNA_view3d_types.h"
#include "BLI_math_matrix.h"

@ -10,7 +10,7 @@
* needed to hook up the gizmo system with Blender's window manager. It's
* mostly the event system that needs to communicate with gizmo code.
*
* Only included in wm.hh and lower level files.
* Only included in `wm.hh` and lower level files.
*/
#pragma once

@ -339,8 +339,8 @@ enum {
/* Timer max (287). */
#define _TIMER_MAX 0x011F
/* Actionzones, tweak, gestures: 0x500x, 0x501x */
/* Keep in sync with IS_EVENT_ACTIONZONE(...). */
/* Action-zones, tweak, gestures: 0x500x, 0x501x
* Keep in sync with #IS_EVENT_ACTIONZONE(...). */
EVT_ACTIONZONE_AREA = 0x5000, /* 20480 */
EVT_ACTIONZONE_REGION = 0x5001, /* 20481 */
EVT_ACTIONZONE_FULLSCREEN = 0x5011, /* 20497 */