Cleanup: spelling

This commit is contained in:
Campbell Barton 2021-02-16 21:15:45 +11:00
parent a059f07274
commit c03650073e
20 changed files with 36 additions and 41 deletions

@ -487,11 +487,11 @@ ccl_device float3 bsdf_microfacet_ggx_eval_reflect(const ShaderClosure *sc,
float3 out = F * G * common;
/* eq. 2 in distribution of visible normals sampling
* pm = Dw = G1o * dot(m, I) * D / dot(N, I); */
* `pm = Dw = G1o * dot(m, I) * D / dot(N, I);` */
/* eq. 38 - but see also:
* eq. 17 in http://www.graphics.cornell.edu/~bjw/wardnotes.pdf
* pdf = pm * 0.25 / dot(m, I); */
* `pdf = pm * 0.25 / dot(m, I);` */
*pdf = G1o * common;
return out;

@ -390,8 +390,8 @@ ccl_device_forceinline float eval_phase_dwivedi(float v, float phase_log, float
ccl_device_forceinline float sample_phase_dwivedi(float v, float phase_log, float rand)
{
/* Based on Eq. 10 from [2]: v - (v + 1) * pow((v - 1) / (v + 1), rand)
* Since we're already precomputing phase_log = log((v + 1) / (v - 1)) for the evaluation,
/* Based on Eq. 10 from [2]: `v - (v + 1) * pow((v - 1) / (v + 1), rand)`
* Since we're already pre-computing `phase_log = log((v + 1) / (v - 1))` for the evaluation,
* we can implement the power function like this. */
return v - (v + 1) * expf(-rand * phase_log);
}
@ -455,7 +455,7 @@ ccl_device_noinline
float3 sigma_s = sigma_t * alpha;
/* Theoretically it should be better to use the exact alpha for the channel we're sampling at
* each bounce, but in practise there doesn't seem to be a noticeable difference in exchange
* each bounce, but in practice there doesn't seem to be a noticeable difference in exchange
* for making the code significantly more complex and slower (if direction sampling depends on
* the sampled channel, we need to compute its PDF per-channel and consider it for MIS later on).
*

@ -52,7 +52,7 @@ string string_remove_trademark(const string &s);
string string_from_bool(const bool var);
string to_string(const char *str);
/* Wide char strings are only used on Windows to deal with non-ascii
/* Wide char strings are only used on Windows to deal with non-ASCII
* characters in file names and such. No reason to use such strings
* for something else at this moment.
*

@ -1286,7 +1286,7 @@ GHOST_TSuccess GHOST_SystemCocoa::handleDraggingEvent(GHOST_TEventType eventType
return GHOST_kFailure;
}
/* Then get Alpha values by getting the RGBA image (that is premultiplied btw) */
/* Then get Alpha values by getting the RGBA image (that is pre-multiplied BTW) */
blBitmapFormatImageRGBA = [[NSBitmapImageRep alloc]
initWithBitmapDataPlanes:NULL
pixelsWide:imgSize.width

@ -18,8 +18,6 @@
# <pep8 compliant>
# TODO, use PREFERENCES_OT_* prefix for operators.
import bpy
from bpy.types import (
Operator,
@ -899,7 +897,6 @@ class PREFERENCES_OT_app_template_install(Operator):
traceback.print_exc()
return {'CANCELLED'}
# _module_extract_prepare(file_to_extract)
file_to_extract_root = _zipfile_root_namelist(file_to_extract)
if self.overwrite:
for f in file_to_extract_root:

@ -612,7 +612,7 @@ static GeometrySet object_get_geometry_set_for_read(const Object &object)
}
}
/* TODO: Cover the case of pointclouds without modifiers-- they may not be covered by the
/* TODO: Cover the case of point-clouds without modifiers-- they may not be covered by the
* #geometry_set_eval case above. */
/* TODO: Add volume support. */

@ -330,7 +330,7 @@ static void blo_update_defaults_scene(Main *bmain, Scene *scene)
/* Enable Soft Shadows by default. */
scene->eevee.flag |= SCE_EEVEE_SHADOW_SOFT;
/* Be sure curfalloff and primitive are initializated */
/* Be sure `curfalloff` and primitive are initialized. */
ToolSettings *ts = scene->toolsettings;
if (ts->gp_sculpt.cur_falloff == NULL) {
ts->gp_sculpt.cur_falloff = BKE_curvemapping_add(1, 0.0f, 0.0f, 1.0f, 1.0f);

@ -23,7 +23,7 @@
*
* There are 2 methods to achieve this effect.
* - The first uses projection matrix offsetting and sample accumulation to give reference quality
* depth of field. But this needs many samples to hide the undersampling.
* depth of field. But this needs many samples to hide the under-sampling.
* - The second one is a post-processing based one. It follows the implementation described in
* the presentation "Life of a Bokeh - Siggraph 2018" from Guillaume Abadie. There are some
* difference with our actual implementation that prioritize quality.
@ -139,7 +139,7 @@ bool EEVEE_depth_of_field_jitter_get(EEVEE_EffectsInfo *fx,
r_jitter[1] = (float)ring_sample / ring_sample_count;
{
/* Bokeh shape parametrisation */
/* Bokeh shape parameterization. */
float r = r_jitter[0];
float T = r_jitter[1] * 2.0f * M_PI;
@ -388,7 +388,7 @@ static void dof_bokeh_pass_init(EEVEE_FramebufferList *fbl,
}
/**
* Ouputs halfResColorBuffer and halfResCocBuffer.
* Outputs halfResColorBuffer and halfResCocBuffer.
**/
static void dof_setup_pass_init(EEVEE_FramebufferList *fbl,
EEVEE_PassList *psl,
@ -422,7 +422,7 @@ static void dof_setup_pass_init(EEVEE_FramebufferList *fbl,
}
/**
* Ouputs min & max coc in each 8x8 half res pixel tiles (so 1/16th of fullres).
* Outputs min & max COC in each 8x8 half res pixel tiles (so 1/16th of full resolution).
**/
static void dof_flatten_tiles_pass_init(EEVEE_FramebufferList *fbl,
EEVEE_PassList *psl,
@ -453,7 +453,7 @@ static void dof_flatten_tiles_pass_init(EEVEE_FramebufferList *fbl,
}
/**
* Dilates the min & max cocs to cover maximum coc values.
* Dilates the min & max COCS to cover maximum COC values.
* Output format/dimensions should be the same as coc_flatten_pass as they are swapped for
* doing multiple dilation passes.
**/
@ -536,7 +536,7 @@ static void dof_dilate_tiles_pass_draw(EEVEE_FramebufferList *fbl,
}
/**
* Create mipmaped color & coc textures for gather passes.
* Create mipmaped color & COC textures for gather passes.
**/
static void dof_reduce_pass_init(EEVEE_FramebufferList *fbl,
EEVEE_PassList *psl,

@ -517,7 +517,7 @@ void EEVEE_draw_effects(EEVEE_ViewLayerData *sldata, EEVEE_Data *vedata)
DRW_viewport_request_redraw();
}
/* Record pers matrix for the next frame. */
/* Record perspective matrix for the next frame. */
DRW_view_persmat_get(effects->taa_view, effects->prev_persmat, false);
/* Update double buffer status if render mode. */

@ -173,14 +173,14 @@ void EEVEE_temporal_sampling_matrices_calc(EEVEE_EffectsInfo *effects, const dou
/* Get focus distance in NDC. */
float focus_pt[3] = {0.0f, 0.0f, -focus_distance};
mul_project_m4_v3(winmat, focus_pt);
/* Get pixel footprint in viewspace. */
/* Get pixel footprint in view-space. */
float jitter_scaled[3] = {dof_jitter[0], dof_jitter[1], focus_pt[2]};
float center[3] = {0.0f, 0.0f, focus_pt[2]};
mul_project_m4_v3(wininv, jitter_scaled);
mul_project_m4_v3(wininv, center);
/* FIXME(fclem) The offset is noticeably large and the culling might make object pop out
* of the bluring radius. To fix this, use custom enlarged culling matrix. */
/* FIXME(fclem): The offset is noticeably large and the culling might make object pop out
* of the blurring radius. To fix this, use custom enlarged culling matrix. */
sub_v2_v2v2(jitter_scaled, jitter_scaled, center);
add_v2_v2(viewmat[3], jitter_scaled);

@ -639,7 +639,7 @@ int insert_vert_fcurve(
/* don't recalculate handles if fast is set
* - this is a hack to make importers faster
* - we may calculate twice (due to autohandle needing to be calculated twice)
* - we may calculate twice (due to auto-handle needing to be calculated twice)
*/
if ((flag & INSERTKEY_FAST) == 0) {
calchandles_fcurve(fcu);

@ -126,12 +126,12 @@ void ED_armature_origin_set(
bArmature *arm = ob->data;
float cent[3];
/* Put the armature into editmode */
/* Put the armature into edit-mode. */
if (is_editmode == false) {
ED_armature_to_edit(arm);
}
/* Find the centerpoint */
/* Find the center-point. */
if (centermode == 2) {
copy_v3_v3(cent, cursor);
invert_m4_m4(ob->imat, ob->obmat);
@ -173,7 +173,7 @@ void ED_armature_origin_set(
ED_armature_edit_free(arm);
}
/* Adjust object location for new centerpoint */
/* Adjust object location for new center-point. */
if (centermode && (is_editmode == false)) {
mul_mat3_m4_v3(ob->obmat, cent); /* omit translation part */
add_v3_v3(ob->loc, cent);

@ -3111,7 +3111,7 @@ void CURVE_OT_smooth_weight(wmOperatorType *ot)
ot->description = "Interpolate weight of selected points";
ot->idname = "CURVE_OT_smooth_weight";
/* api clastbacks */
/* api callbacks */
ot->exec = curve_smooth_weight_exec;
ot->poll = ED_operator_editsurfcurve;
@ -3154,7 +3154,7 @@ void CURVE_OT_smooth_radius(wmOperatorType *ot)
ot->description = "Interpolate radii of selected points";
ot->idname = "CURVE_OT_smooth_radius";
/* api clastbacks */
/* api callbacks */
ot->exec = curve_smooth_radius_exec;
ot->poll = ED_operator_editsurfcurve;
@ -3197,7 +3197,7 @@ void CURVE_OT_smooth_tilt(wmOperatorType *ot)
ot->description = "Interpolate tilt of selected points";
ot->idname = "CURVE_OT_smooth_tilt";
/* api clastbacks */
/* api callbacks */
ot->exec = curve_smooth_tilt_exec;
ot->poll = ED_operator_editsurfcurve;

@ -1746,8 +1746,7 @@ void UI_view2d_smooth_view(bContext *C, ARegion *region, const rctf *cur, const
if (v2d->smooth_timer) {
WM_event_remove_timer(wm, win, v2d->smooth_timer);
}
/* TIMER1 is hardcoded in keymap */
/* max 30 frs/sec */
/* TIMER1 is hard-coded in key-map. */
v2d->smooth_timer = WM_event_add_timer(wm, win, TIMER1, 1.0 / 100.0);
ok = true;

@ -995,7 +995,7 @@ bool EDBM_unified_findnearest(ViewContext *vc,
/* -------------------------------------------------------------------- */
/** \name Alternate Find Nearest Vert/Edge (optional boundary)
*
* \note This uses ray-cast method instead of backbuffer,
* \note This uses ray-cast method instead of back-buffer,
* currently used for poly-build.
* \{ */

@ -2422,7 +2422,7 @@ void ED_vgroup_mirror(Object *ob,
BM_mesh_elem_hflag_disable_all(em->bm, BM_VERT, BM_ELEM_TAG, false);
/* Go through the list of editverts and assign them */
/* Go through the list of edit-vertices and assign them. */
BM_ITER_MESH (eve, &iter, em->bm, BM_VERTS_OF_MESH) {
if (!BM_elem_flag_test(eve, BM_ELEM_TAG)) {
if ((eve_mirr = EDBM_verts_mirror_get(em, eve))) {
@ -2602,7 +2602,7 @@ static void vgroup_assign_verts(Object *ob, const float weight)
cd_dvert_offset = CustomData_get_offset(&em->bm->vdata, CD_MDEFORMVERT);
/* Go through the list of editverts and assign them */
/* Go through the list of edit-vertices and assign them. */
BM_ITER_MESH (eve, &iter, em->bm, BM_VERTS_OF_MESH) {
if (BM_elem_flag_test(eve, BM_ELEM_SELECT)) {
MDeformVert *dv;

@ -5083,7 +5083,7 @@ static void SCREEN_OT_delete(wmOperatorType *ot)
/** \name Region Alpha Blending Operator
*
* Implementation note: a disappearing region needs at least 1 last draw with
* 100% backbuffer texture over it - then triple buffer will clear it entirely.
* 100% back-buffer texture over it - then triple buffer will clear it entirely.
* This because flag #RGN_FLAG_HIDDEN is set in end - region doesn't draw at all then.
*
* \{ */

@ -2230,8 +2230,7 @@ static int file_directory_new_exec(bContext *C, wmOperator *op)
params->rename_flag = FILE_PARAMS_RENAME_PENDING;
}
/* set timer to smoothly view newly generated file */
/* max 30 frs/sec */
/* Set timer to smoothly view newly generated file. */
if (sfile->smoothscroll_timer != NULL) {
WM_event_remove_timer(wm, CTX_wm_window(C), sfile->smoothscroll_timer);
}

@ -2156,7 +2156,7 @@ bool ED_view3d_clipping_test(const RegionView3D *rv3d, const float co[3], const
/** \} */
/* -------------------------------------------------------------------- */
/** \name Backdraw for Selection
/** \name Back-Draw for Selection
* \{ */
/**
@ -2200,7 +2200,7 @@ static void validate_object_select_id(struct Depsgraph *depsgraph,
}
/* TODO: Create a flag in `DRW_manager` because the drawing is no longer
* made on the backbuffer in this case. */
* made on the back-buffer in this case. */
v3d->flag &= ~V3D_INVALID_BACKBUF;
}
@ -2229,7 +2229,7 @@ static void view3d_opengl_read_Z_pixels(GPUViewport *viewport, rcti *rect, void
void ED_view3d_select_id_validate(ViewContext *vc)
{
/* TODO: Create a flag in `DRW_manager` because the drawing is no longer
* made on the backbuffer in this case. */
* made on the back-buffer in this case. */
if (vc->v3d->flag & V3D_INVALID_BACKBUF) {
validate_object_select_id(vc->depsgraph, vc->view_layer, vc->region, vc->v3d, vc->obact);
}

@ -178,7 +178,7 @@ static void geo_node_point_separate_exec(GeoNodeExecParams params)
GeometrySet out_set_a(geometry_set);
GeometrySet out_set_b;
/* TODO: This is not necessary-- the input goemetry set can be read only,
/* TODO: This is not necessary-- the input geometry set can be read only,
* but it must be rewritten to handle instance groups. */
geometry_set = geometry_set_realize_instances(geometry_set);