Cleanup: spelling in comments

This commit is contained in:
2023-03-07 14:58:15 +11:00
parent 175b1b449e
commit 90dc655951
21 changed files with 48 additions and 49 deletions

View File

@@ -35,7 +35,7 @@ struct BVHReferenceCompare {
/* Compare two references. /* Compare two references.
* *
* Returns value is similar to return value of strcmp(). * Returns value is similar to return value of `strcmp()`.
*/ */
__forceinline int compare(const BVHReference &ra, const BVHReference &rb) const __forceinline int compare(const BVHReference &ra, const BVHReference &rb) const
{ {

View File

@@ -494,7 +494,7 @@ ccl_device int bsdf_microfacet_sample(ccl_private const ShaderClosure *sc,
float3 H; float3 H;
float cos_NH, cos_HI; float cos_NH, cos_HI;
float3 local_H, local_I, X, Y; /* Nneeded for anisotropic microfacets later. */ float3 local_H, local_I, X, Y; /* Needed for anisotropic microfacets later. */
if (m_singular) { if (m_singular) {
H = N; H = N;
cos_NH = 1.0f; cos_NH = 1.0f;

View File

@@ -979,7 +979,7 @@ ccl_device_forceinline int kernel_path_mnee_sample(KernelGlobals kg,
for (int ci = 0; ci < sd_mnee->num_closure; ci++) { for (int ci = 0; ci < sd_mnee->num_closure; ci++) {
ccl_private ShaderClosure *bsdf = &sd_mnee->closure[ci]; ccl_private ShaderClosure *bsdf = &sd_mnee->closure[ci];
if (CLOSURE_IS_REFRACTIVE(bsdf->type)) { if (CLOSURE_IS_REFRACTIVE(bsdf->type)) {
/* Note that Glass closures are treates as refractive further below. */ /* Note that Glass closures are treated as refractive further below. */
found_refractive_microfacet_bsdf = true; found_refractive_microfacet_bsdf = true;
ccl_private MicrofacetBsdf *microfacet_bsdf = (ccl_private MicrofacetBsdf *)bsdf; ccl_private MicrofacetBsdf *microfacet_bsdf = (ccl_private MicrofacetBsdf *)bsdf;

View File

@@ -1517,10 +1517,9 @@ void BKE_tracking_marker_get_subframe_position(MovieTrackingTrack *track,
MovieTrackingMarker *marker_next = marker + 1; MovieTrackingMarker *marker_next = marker + 1;
if (marker_next->framenr == marker->framenr + 1) { if (marker_next->framenr == marker->framenr + 1) {
/* currently only do subframing inside tracked ranges, do not extrapolate tracked segments /* Currently only do sub-framing inside tracked ranges, do not extrapolate tracked segments
* could be changed when / if mask parent would be interpolating position in-between * could be changed when / if mask parent would be interpolating position in-between
* tracked segments * tracked segments. */
*/
float fac = (framenr - int(framenr)) / (marker_next->framenr - marker->framenr); float fac = (framenr - int(framenr)) / (marker_next->framenr - marker->framenr);

View File

@@ -310,7 +310,7 @@ static bool tracking_check_marker_margin(const libmv_Marker *libmv_marker,
/** \} */ /** \} */
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/** \name Autotrack context initialization. /** \name Auto-Track Context Initialization
* \{ */ * \{ */
static bool autotrack_is_marker_usable(const MovieTrackingMarker *marker) static bool autotrack_is_marker_usable(const MovieTrackingMarker *marker)

View File

@@ -383,7 +383,7 @@ static AVFrame *generate_video_frame(FFMpegContext *context, const uint8_t *pixe
rgb_frame = context->current_frame; rgb_frame = context->current_frame;
} }
/* Copy the Blender pixels into the FFmpeg datastructure, taking care of endianness and flipping /* Copy the Blender pixels into the FFMPEG data-structure, taking care of endianness and flipping
* the image vertically. */ * the image vertically. */
int linesize = rgb_frame->linesize[0]; int linesize = rgb_frame->linesize[0];
for (int y = 0; y < height; y++) { for (int y = 0; y < height; y++) {

View File

@@ -241,7 +241,7 @@ int EEVEE_temporal_sampling_init(EEVEE_ViewLayerData *UNUSED(sldata), EEVEE_Data
} }
/** /**
* Reset for each "redraw". When rendering using ogl render, * Reset for each "redraw". When rendering using OpenGL render,
* we accumulate the redraw inside the drawing loop in eevee_draw_scene(). * we accumulate the redraw inside the drawing loop in eevee_draw_scene().
*/ */
if (DRW_state_is_opengl_render()) { if (DRW_state_is_opengl_render()) {

View File

@@ -106,7 +106,7 @@ void OVERLAY_edit_mesh_cache_init(OVERLAY_Data *vedata)
/* Complementary Depth Pass */ /* Complementary Depth Pass */
state = DRW_STATE_WRITE_DEPTH | DRW_STATE_DEPTH_LESS_EQUAL | DRW_STATE_CULL_BACK; state = DRW_STATE_WRITE_DEPTH | DRW_STATE_DEPTH_LESS_EQUAL | DRW_STATE_CULL_BACK;
if (show_retopology) { if (show_retopology) {
/* Do not cull backfaces for retopology depth pass. /* Do not cull back-faces for retopology depth pass.
* This prevents edit overlays from appearing behind any faces. * This prevents edit overlays from appearing behind any faces.
* Doing so reduces visual clutter. */ * Doing so reduces visual clutter. */
state &= ~DRW_STATE_CULL_BACK; state &= ~DRW_STATE_CULL_BACK;
@@ -162,9 +162,9 @@ void OVERLAY_edit_mesh_cache_init(OVERLAY_Data *vedata)
&pd->edit_mesh_faces_cage_grp[i]; &pd->edit_mesh_faces_cage_grp[i];
state = state_common; state = state_common;
if (show_retopology) { if (show_retopology) {
/* Cull backfaces for retopology face pass. /* Cull back-faces for retopology face pass.
* This makes it so backfaces are not drawn. * This makes it so back-faces are not drawn.
* Doing so lets us distinguish backfaces from frontfaces. */ * Doing so lets us distinguish back-faces from front-faces. */
state |= DRW_STATE_CULL_BACK; state |= DRW_STATE_CULL_BACK;
} }
DRW_PASS_CREATE(*edit_face_ps, state | pd->clipping_state); DRW_PASS_CREATE(*edit_face_ps, state | pd->clipping_state);

View File

@@ -577,7 +577,7 @@ static void write_render_z_output(struct RenderLayer *layer,
int pix_num = BLI_rcti_size_x(rect) * BLI_rcti_size_y(rect); int pix_num = BLI_rcti_size_x(rect) * BLI_rcti_size_y(rect);
/* Convert ogl depth [0..1] to view Z [near..far] */ /* Convert GPU depth [0..1] to view Z [near..far] */
if (DRW_view_is_persp_get(nullptr)) { if (DRW_view_is_persp_get(nullptr)) {
for (float &z : MutableSpan(rp->rect, pix_num)) { for (float &z : MutableSpan(rp->rect, pix_num)) {
if (z == 1.0f) { if (z == 1.0f) {

View File

@@ -120,7 +120,7 @@ static void workbench_render_result_z(struct RenderLayer *rl,
int pix_num = BLI_rcti_size_x(rect) * BLI_rcti_size_y(rect); int pix_num = BLI_rcti_size_x(rect) * BLI_rcti_size_y(rect);
/* Convert ogl depth [0..1] to view Z [near..far] */ /* Convert GPU depth [0..1] to view Z [near..far] */
if (DRW_view_is_persp_get(NULL)) { if (DRW_view_is_persp_get(NULL)) {
for (int i = 0; i < pix_num; i++) { for (int i = 0; i < pix_num; i++) {
if (rp->rect[i] == 1.0f) { if (rp->rect[i] == 1.0f) {

View File

@@ -313,15 +313,15 @@ bool GPU_framebuffer_check_valid(GPUFrameBuffer *framebuffer, char err_out[256])
/** \} */ /** \} */
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/** \name Empty framebuffer /** \name Empty frame-buffer
* *
* An empty framebuffer is a framebuffer with no attachments. This allow to rasterize geometry * An empty frame-buffer is a frame-buffer with no attachments. This allow to rasterize geometry
* without creating any dummy attachments and write some computation results using other means * without creating any dummy attachments and write some computation results using other means
* (SSBOs, Images). * (SSBOs, Images).
* \{ */ * \{ */
/** /**
* Default size is used if the framebuffer contains no attachments. * Default size is used if the frame-buffer contains no attachments.
* It needs to be re-specified each time an attachment is added. * It needs to be re-specified each time an attachment is added.
*/ */
void GPU_framebuffer_default_size(GPUFrameBuffer *framebuffer, int width, int height); void GPU_framebuffer_default_size(GPUFrameBuffer *framebuffer, int width, int height);
@@ -349,7 +349,7 @@ void GPU_framebuffer_viewport_set(
void GPU_framebuffer_viewport_get(GPUFrameBuffer *framebuffer, int r_viewport[4]); void GPU_framebuffer_viewport_get(GPUFrameBuffer *framebuffer, int r_viewport[4]);
/** /**
* Reset a framebuffer viewport bounds to its attachment(s) size. * Reset a frame-buffer viewport bounds to its attachment(s) size.
* \note Viewport and scissor size is stored per frame-buffer. * \note Viewport and scissor size is stored per frame-buffer.
*/ */
void GPU_framebuffer_viewport_reset(GPUFrameBuffer *framebuffer); void GPU_framebuffer_viewport_reset(GPUFrameBuffer *framebuffer);
@@ -361,7 +361,7 @@ void GPU_framebuffer_viewport_reset(GPUFrameBuffer *framebuffer);
* \{ */ * \{ */
/** /**
* Clear the framebuffer attachments. * Clear the frame-buffer attachments.
* \a buffers controls the types of attachments to clear. Setting GPU_COLOR_BIT will clear *all* * \a buffers controls the types of attachments to clear. Setting GPU_COLOR_BIT will clear *all*
* the color attachment. * the color attachment.
* Each attachment gets cleared to the value of its type: * Each attachment gets cleared to the value of its type:
@@ -438,19 +438,19 @@ void GPU_framebuffer_clear_color_depth_stencil(GPUFrameBuffer *fb,
void GPU_framebuffer_multi_clear(GPUFrameBuffer *framebuffer, const float (*clear_colors)[4]); void GPU_framebuffer_multi_clear(GPUFrameBuffer *framebuffer, const float (*clear_colors)[4]);
/** /**
* Clear all color attachment textures of the active framebuffer with the given red, green, blue, * Clear all color attachment textures of the active frame-buffer with the given red, green, blue,
* alpha values. * alpha values.
* \note `GPU_write_mask`, and stencil test do not affect this command. * \note `GPU_write_mask`, and stencil test do not affect this command.
* \note Viewport and scissor regions affect this command but are not efficient nor recommended. * \note Viewport and scissor regions affect this command but are not efficient nor recommended.
* DEPRECATED: Use `GPU_framebuffer_clear_color` with explicit framebuffer. * DEPRECATED: Use `GPU_framebuffer_clear_color` with explicit frame-buffer.
*/ */
void GPU_clear_color(float red, float green, float blue, float alpha); void GPU_clear_color(float red, float green, float blue, float alpha);
/** /**
* Clear the depth attachment texture of the active framebuffer with the given depth value. * Clear the depth attachment texture of the active frame-buffer with the given depth value.
* \note `GPU_write_mask`, and stencil test do not affect this command. * \note `GPU_write_mask`, and stencil test do not affect this command.
* \note Viewport and scissor regions affect this command but are not efficient nor recommended. * \note Viewport and scissor regions affect this command but are not efficient nor recommended.
* DEPRECATED: Use `GPU_framebuffer_clear_color` with explicit framebuffer. * DEPRECATED: Use `GPU_framebuffer_clear_color` with explicit frame-buffer.
*/ */
void GPU_clear_depth(float depth); void GPU_clear_depth(float depth);
@@ -467,7 +467,7 @@ const char *GPU_framebuffer_get_name(GPUFrameBuffer *framebuffer);
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/** \name Python API & meta-data /** \name Python API & meta-data
* *
* These are not intrinsic properties of a framebuffer but they are stored inside the * These are not intrinsic properties of a frame-buffer but they are stored inside the
* gpu::FrameBuffer structure for tracking purpose. * gpu::FrameBuffer structure for tracking purpose.
* \{ */ * \{ */
@@ -481,8 +481,8 @@ void GPU_framebuffer_py_reference_set(GPUFrameBuffer *framebuffer, void **py_ref
#endif #endif
/** /**
* Keep a stack of bound framebuffer to allow scoped binding of framebuffer in python. * Keep a stack of bound frame-buffer to allow scoped binding of frame-buffer in python.
* This is also used by #GPUOffScreen to save/restore the current framebuffers. * This is also used by #GPUOffScreen to save/restore the current frame-buffers.
* \note This isn't thread safe. * \note This isn't thread safe.
*/ */
/* TODO(fclem): This has nothing to do with the GPU module and should be move to the pyGPU module. /* TODO(fclem): This has nothing to do with the GPU module and should be move to the pyGPU module.
@@ -547,7 +547,7 @@ void GPU_frontbuffer_read_pixels(
* The attachments types are chosen by \a blit_buffers . * The attachments types are chosen by \a blit_buffers .
* Only one color buffer can by copied at a time and its index is chosen by \a read_slot and \a * Only one color buffer can by copied at a time and its index is chosen by \a read_slot and \a
* write_slot. * write_slot.
* The source and destination framebuffers dimensions have to match. * The source and destination frame-buffers dimensions have to match.
* DEPRECATED: Prefer using `GPU_texture_copy()`. * DEPRECATED: Prefer using `GPU_texture_copy()`.
*/ */
void GPU_framebuffer_blit(GPUFrameBuffer *fb_read, void GPU_framebuffer_blit(GPUFrameBuffer *fb_read,

View File

@@ -143,8 +143,8 @@ static void do_push_constants_test(const char *info_name, const int num_calls_si
shader.update_push_constants(call_data); shader.update_push_constants(call_data);
shader.dispatch(); shader.dispatch();
} }
/* All calls will be "simultaneously" in flight. First readback will wait until the dispatches /* All calls will be "simultaneously" in flight. First read-back will wait until the dispatches
* have finished execution.*/ * have finished execution. */
for (const int call_index : IndexRange(num_calls_simultaneously)) { for (const int call_index : IndexRange(num_calls_simultaneously)) {
CallData &call_data = shader.call_datas[call_index]; CallData &call_data = shader.call_datas[call_index];
call_data.read_back(); call_data.read_back();
@@ -152,7 +152,7 @@ static void do_push_constants_test(const char *info_name, const int num_calls_si
} }
} }
/* Test case with single call as sanity check, before we make it more interesting.*/ /* Test case with single call as sanity check, before we make it more interesting. */
static void test_push_constants() static void test_push_constants()
{ {
do_push_constants_test("gpu_push_constants_test"); do_push_constants_test("gpu_push_constants_test");
@@ -180,7 +180,7 @@ GPU_TEST(push_constants_512bytes)
#if 0 #if 0
/* Schedule multiple simultaneously. */ /* Schedule multiple simultaneously. */
/* These test have been disabled for now as this will to be solved in a separate PR. /* These test have been disabled for now as this will to be solved in a separate PR.
* - DescriptorSets may not be altered, when they are in the command queue or being executed. * - `DescriptorSets` may not be altered, when they are in the command queue or being executed.
*/ */
static void test_push_constants_multiple() static void test_push_constants_multiple()
{ {
@@ -207,4 +207,4 @@ static void test_push_constants_multiple_512bytes()
GPU_TEST(push_constants_multiple_512bytes) GPU_TEST(push_constants_multiple_512bytes)
#endif #endif
} // namespace blender::gpu::tests } // namespace blender::gpu::tests

View File

@@ -23,10 +23,10 @@ namespace blender::io::ply {
std::unique_ptr<PlyData> import_ply_ascii(fstream &file, PlyHeader *header); std::unique_ptr<PlyData> import_ply_ascii(fstream &file, PlyHeader *header);
/** /**
* Loads the information from the PLY file in ASCII format to the PlyData datastructure. * Loads the information from the PLY file in ASCII format to the #PlyData data-structure.
* \param file: The PLY file that was opened. * \param file: The PLY file that was opened.
* \param header: The information in the PLY header. * \param header: The information in the PLY header.
* \return The PlyData datastructure that can be used for conversion to a Mesh. * \return The #PlyData data-structure that can be used for conversion to a Mesh.
*/ */
PlyData load_ply_ascii(fstream &file, const PlyHeader *header); PlyData load_ply_ascii(fstream &file, const PlyHeader *header);

View File

@@ -17,15 +17,15 @@ namespace blender::io::ply {
* The function that gets called from the importer. * The function that gets called from the importer.
* \param file: The PLY file that was opened. * \param file: The PLY file that was opened.
* \param header: The information in the PLY header. * \param header: The information in the PLY header.
* \return The PlyData datastructure that can be used for conversion to a Mesh. * \return The #PlyData data-structure that can be used for conversion to a #Mesh.
*/ */
std::unique_ptr<PlyData> import_ply_binary(fstream &file, const PlyHeader *header); std::unique_ptr<PlyData> import_ply_binary(fstream &file, const PlyHeader *header);
/** /**
* Loads the information from the PLY file in binary format to the PlyData datastructure. * Loads the information from the PLY file in binary format to the #PlyData data-structure.
* \param file: The PLY file that was opened. * \param file: The PLY file that was opened.
* \param header: The information in the PLY header. * \param header: The information in the PLY header.
* \return The PlyData datastructure that can be used for conversion to a Mesh. * \return The #PlyData data-structure that can be used for conversion to a Mesh.
*/ */
PlyData load_ply_binary(fstream &file, const PlyHeader *header); PlyData load_ply_binary(fstream &file, const PlyHeader *header);

View File

@@ -12,7 +12,7 @@
namespace blender::io::ply { namespace blender::io::ply {
/** /**
* Converts the PlyData datastructure to a mesh. * Converts the #PlyData data-structure to a mesh.
* \param data: The PLY data. * \param data: The PLY data.
* \return The mesh that can be used inside blender. * \return The mesh that can be used inside blender.
*/ */

View File

@@ -243,7 +243,7 @@ typedef struct bArmatureConstraint {
ListBase targets; ListBase targets;
} bArmatureConstraint; } bArmatureConstraint;
/* Single-target subobject constraints --------------------- */ /* Single-target sub-object constraints --------------------- */
/* Track To Constraint */ /* Track To Constraint */
typedef struct bTrackToConstraint { typedef struct bTrackToConstraint {

View File

@@ -16,14 +16,14 @@
* *
* The main missing features in this code compared to the paper are: * The main missing features in this code compared to the paper are:
* *
* + No mesh evolution. The paper suggests iteratively subsurfing the * - No mesh evolution. The paper suggests iteratively subdivision-surfacing the
* skin output and adapting the output to better conform with the * skin output and adapting the output to better conform with the
* spheres of influence surrounding each vertex. * spheres of influence surrounding each vertex.
* *
* + No mesh fairing. The paper suggests re-aligning output edges to * - No mesh fairing. The paper suggests re-aligning output edges to
* follow principal mesh curvatures. * follow principal mesh curvatures.
* *
* + No auxiliary balls. These would serve to influence mesh * - No auxiliary balls. These would serve to influence mesh
* evolution, which as noted above is not implemented. * evolution, which as noted above is not implemented.
* *
* The code also adds some features not present in the paper: * The code also adds some features not present in the paper:

View File

@@ -54,7 +54,7 @@ typedef struct RenderView {
float *rectf; float *rectf;
/* if this exists, result of composited layers */ /* if this exists, result of composited layers */
float *rectz; float *rectz;
/* optional, 32 bits version of picture, used for sequencer, ogl render and image curves */ /* optional, 32 bits version of picture, used for sequencer, OpenGL render and image curves */
int *rect32; int *rect32;
} RenderView; } RenderView;
@@ -105,7 +105,7 @@ typedef struct RenderResult {
/* The following rect32, rectf and rectz buffers are for temporary storage only, /* The following rect32, rectf and rectz buffers are for temporary storage only,
* for RenderResult structs created in #RE_AcquireResultImage - which do not have RenderView */ * for RenderResult structs created in #RE_AcquireResultImage - which do not have RenderView */
/* optional, 32 bits version of picture, used for ogl render and image curves */ /* Optional, 32 bits version of picture, used for OpenGL render and image curves. */
int *rect32; int *rect32;
/* if this exists, a copy of one of layers, or result of composited layers */ /* if this exists, a copy of one of layers, or result of composited layers */
float *rectf; float *rectf;

View File

@@ -116,7 +116,7 @@ bool RE_engine_is_external(const Render *re)
bool RE_engine_is_opengl(RenderEngineType *render_type) bool RE_engine_is_opengl(RenderEngineType *render_type)
{ {
/* TODO: refine? Can we have ogl render engine without ogl render pipeline? */ /* TODO: refine? Can we have OpenGL render engine without OpenGL render pipeline? */
return (render_type->draw_engine != nullptr) && return (render_type->draw_engine != nullptr) &&
DRW_engine_render_support(render_type->draw_engine); DRW_engine_render_support(render_type->draw_engine);
} }

View File

@@ -862,7 +862,7 @@ void RE_test_break_cb(Render *re, void *handle, bool (*f)(void *handle))
void RE_gl_context_create(Render *re) void RE_gl_context_create(Render *re)
{ {
/* Needs to be created in the main ogl thread. */ /* Needs to be created in the main OpenGL thread. */
re->gl_context = WM_opengl_context_create(); re->gl_context = WM_opengl_context_create();
/* So we activate the window's one afterwards. */ /* So we activate the window's one afterwards. */
wm_window_reset_drawable(); wm_window_reset_drawable();
@@ -870,7 +870,7 @@ void RE_gl_context_create(Render *re)
void RE_gl_context_destroy(Render *re) void RE_gl_context_destroy(Render *re)
{ {
/* Needs to be called from the thread which used the ogl context for rendering. */ /* Needs to be called from the thread which used the OpenGL context for rendering. */
if (re->gl_context) { if (re->gl_context) {
if (re->gpu_context) { if (re->gpu_context) {
WM_opengl_context_activate(re->gl_context); WM_opengl_context_activate(re->gl_context);

View File

@@ -849,7 +849,7 @@ typedef enum {
/** Do not attempt to free custom-data pointer even if non-NULL. */ /** Do not attempt to free custom-data pointer even if non-NULL. */
WM_TIMER_NO_FREE_CUSTOM_DATA = 1 << 0, WM_TIMER_NO_FREE_CUSTOM_DATA = 1 << 0,
/* Internal falgs, should not be used outside of WM code. */ /* Internal flags, should not be used outside of WM code. */
/** This timer has been tagged for removal and deletion, handled by WM code to ensure timers are /** This timer has been tagged for removal and deletion, handled by WM code to ensure timers are
* deleted in a safe context. */ * deleted in a safe context. */
WM_TIMER_TAGGED_FOR_REMOVAL = 1 << 16, WM_TIMER_TAGGED_FOR_REMOVAL = 1 << 16,