diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-07-03 16:08:40 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-07-03 17:43:40 +0300 |
commit | 9b89de2571b0c3fa2276b5c2ae589e0ec831d1f5 (patch) | |
tree | 63f1007a5262b4d6f1c1a96734c521d836eb6fc6 /source/blender/compositor | |
parent | 05f970847e12ce30e8c4c624677d94ae239ce2bc (diff) |
Cleanup: consistent use of tags: NOTE/TODO/FIXME/XXX
Also use doxy style function reference `#` prefix chars when
referencing identifiers.
Diffstat (limited to 'source/blender/compositor')
18 files changed, 26 insertions, 26 deletions
diff --git a/source/blender/compositor/intern/COM_NodeGraph.cc b/source/blender/compositor/intern/COM_NodeGraph.cc index fbe56dd4b5a..205fbcc0440 100644 --- a/source/blender/compositor/intern/COM_NodeGraph.cc +++ b/source/blender/compositor/intern/COM_NodeGraph.cc @@ -174,7 +174,7 @@ void NodeGraph::add_bNodeLink(const NodeRange &node_range, bNodeLink *b_nodelink return; } - /* Note: a DNA input socket can have multiple NodeInput in the compositor tree! (proxies) + /* NOTE: a DNA input socket can have multiple NodeInput in the compositor tree! (proxies) * The output then gets linked to each one of them. */ diff --git a/source/blender/compositor/intern/COM_NodeOperationBuilder.cc b/source/blender/compositor/intern/COM_NodeOperationBuilder.cc index 1beb83bb477..3036e3f55dd 100644 --- a/source/blender/compositor/intern/COM_NodeOperationBuilder.cc +++ b/source/blender/compositor/intern/COM_NodeOperationBuilder.cc @@ -79,7 +79,7 @@ void NodeOperationBuilder::convertToOperations(ExecutionSystem *system) if (!op_from || op_to_list.is_empty()) { /* XXX allow this? error/debug message? */ // BLI_assert(false); - /* XXX note: this can happen with certain nodes (e.g. OutputFile) + /* XXX NOTE: this can happen with certain nodes (e.g. OutputFile) * which only generate operations in certain circumstances (rendering) * just let this pass silently for now ... */ @@ -138,7 +138,7 @@ void NodeOperationBuilder::mapInputSocket(NodeInput *node_socket, BLI_assert(m_current_node); BLI_assert(node_socket->getNode() == m_current_node); - /* note: this maps operation sockets to node sockets. + /* NOTE: this maps operation sockets to node sockets. * for resolving links the map will be inverted first in convertToOperations, * to get a list of links for each node input socket. */ @@ -284,7 +284,7 @@ void NodeOperationBuilder::add_datatype_conversions() void NodeOperationBuilder::add_operation_input_constants() { - /* Note: unconnected inputs cached first to avoid modifying + /* NOTE: unconnected inputs cached first to avoid modifying * m_operations while iterating over it */ Vector<NodeOperationInput *> pending_inputs; @@ -537,7 +537,7 @@ void NodeOperationBuilder::add_output_buffers(NodeOperation *operation, void NodeOperationBuilder::add_complex_operation_buffers() { - /* note: complex ops and get cached here first, since adding operations + /* NOTE: complex ops and get cached here first, since adding operations * will invalidate iterators over the main m_operations */ Vector<NodeOperation *> complex_ops; diff --git a/source/blender/compositor/intern/COM_compositor.cc b/source/blender/compositor/intern/COM_compositor.cc index 5839f53976b..c05234f3bd0 100644 --- a/source/blender/compositor/intern/COM_compositor.cc +++ b/source/blender/compositor/intern/COM_compositor.cc @@ -70,7 +70,7 @@ void COM_execute(RenderData *render_data, const ColorManagedDisplaySettings *displaySettings, const char *viewName) { - /* Initialize mutex, TODO this mutex init is actually not thread safe and + /* Initialize mutex, TODO: this mutex init is actually not thread safe and * should be done somewhere as part of blender startup, all the other * initializations can be done lazily. */ if (!g_compositor.is_initialized) { diff --git a/source/blender/compositor/nodes/COM_CornerPinNode.cc b/source/blender/compositor/nodes/COM_CornerPinNode.cc index 6a120cffe0a..3cfa20f4e05 100644 --- a/source/blender/compositor/nodes/COM_CornerPinNode.cc +++ b/source/blender/compositor/nodes/COM_CornerPinNode.cc @@ -30,7 +30,7 @@ void CornerPinNode::convertToOperations(NodeConverter &converter, const CompositorContext & /*context*/) const { NodeInput *input_image = this->getInputSocket(0); - /* note: socket order differs between UI node and operations: + /* NOTE: socket order differs between UI node and operations: * bNode uses intuitive order following top-down layout: * upper-left, upper-right, lower-left, lower-right * Operations use same order as the tracking blenkernel functions expect: diff --git a/source/blender/compositor/nodes/COM_OutputFileNode.cc b/source/blender/compositor/nodes/COM_OutputFileNode.cc index 8b5140636c1..25ec7331849 100644 --- a/source/blender/compositor/nodes/COM_OutputFileNode.cc +++ b/source/blender/compositor/nodes/COM_OutputFileNode.cc @@ -36,7 +36,7 @@ void OutputFileNode::add_input_sockets(OutputOpenExrMultiLayerOperation &operati for (NodeInput *input : inputs) { NodeImageMultiFileSocket *sockdata = (NodeImageMultiFileSocket *)input->getbNodeSocket()->storage; - /* note: layer becomes an empty placeholder if the input is not linked */ + /* NOTE: layer becomes an empty placeholder if the input is not linked. */ operation.add_layer(sockdata->layer, input->getDataType(), input->isLinked()); } } diff --git a/source/blender/compositor/operations/COM_DilateErodeOperation.cc b/source/blender/compositor/operations/COM_DilateErodeOperation.cc index 9e18a8e2f2c..2454f507664 100644 --- a/source/blender/compositor/operations/COM_DilateErodeOperation.cc +++ b/source/blender/compositor/operations/COM_DilateErodeOperation.cc @@ -370,7 +370,7 @@ void *DilateStepOperation::initializeTileData(rcti *rect) int bwidth = rect->xmax - rect->xmin; int bheight = rect->ymax - rect->ymin; - // Note: Cache buffer has original tilesize width, but new height. + // NOTE: Cache buffer has original tilesize width, but new height. // We have to calculate the additional rows in the first pass, // to have valid data available for the second pass. tile_info *result = create_cache(rect->xmin, rect->xmax, ymin, ymax); @@ -500,7 +500,7 @@ void *ErodeStepOperation::initializeTileData(rcti *rect) int bwidth = rect->xmax - rect->xmin; int bheight = rect->ymax - rect->ymin; - // Note: Cache buffer has original tilesize width, but new height. + // NOTE: Cache buffer has original tilesize width, but new height. // We have to calculate the additional rows in the first pass, // to have valid data available for the second pass. tile_info *result = create_cache(rect->xmin, rect->xmax, ymin, ymax); diff --git a/source/blender/compositor/operations/COM_GlareBaseOperation.h b/source/blender/compositor/operations/COM_GlareBaseOperation.h index 7ae15595e3b..50db4e02940 100644 --- a/source/blender/compositor/operations/COM_GlareBaseOperation.h +++ b/source/blender/compositor/operations/COM_GlareBaseOperation.h @@ -27,7 +27,7 @@ namespace blender::compositor { /* soms macros for color handling */ typedef float fRGB[4]; -/* TODO - replace with BLI_math_vector */ +/* TODO: replace with BLI_math_vector. */ /* multiply c2 by color rgb, rgb as separate arguments */ #define fRGB_rgbmult(c, r, g, b) \ { \ diff --git a/source/blender/compositor/operations/COM_MaskOperation.h b/source/blender/compositor/operations/COM_MaskOperation.h index 92a2c291a72..e8cd9c722df 100644 --- a/source/blender/compositor/operations/COM_MaskOperation.h +++ b/source/blender/compositor/operations/COM_MaskOperation.h @@ -35,7 +35,7 @@ class MaskOperation : public NodeOperation { protected: Mask *m_mask; - /* note, these are used more like aspect, + /* NOTE: these are used more like aspect, * but they _do_ impact on mask detail */ int m_maskWidth; int m_maskHeight; diff --git a/source/blender/compositor/operations/COM_OutputFileOperation.cc b/source/blender/compositor/operations/COM_OutputFileOperation.cc index 1ee749b1a49..7e896046f01 100644 --- a/source/blender/compositor/operations/COM_OutputFileOperation.cc +++ b/source/blender/compositor/operations/COM_OutputFileOperation.cc @@ -426,8 +426,8 @@ void OutputOpenExrMultiLayerOperation::deinitExecution() IMB_exr_write_channels(exrhandle); } else { - /* TODO, get the error from openexr's exception */ - /* XXX nice way to do report? */ + /* TODO: get the error from openexr's exception. */ + /* XXX: nice way to do report? */ printf("Error Writing Render Result, see console\n"); } diff --git a/source/blender/compositor/operations/COM_PlaneTrackOperation.h b/source/blender/compositor/operations/COM_PlaneTrackOperation.h index d240c8b06e9..3bae230aa06 100644 --- a/source/blender/compositor/operations/COM_PlaneTrackOperation.h +++ b/source/blender/compositor/operations/COM_PlaneTrackOperation.h @@ -37,7 +37,7 @@ class PlaneTrackCommon { char m_trackingObjectName[64]; char m_planeTrackName[64]; - /* note: this class is not an operation itself (to prevent virtual inheritance issues) + /* NOTE: this class is not an operation itself (to prevent virtual inheritance issues) * implementation classes must make wrappers to use these methods, see below. */ void read_and_calculate_corners(PlaneDistortBaseOperation *distort_op); diff --git a/source/blender/compositor/operations/COM_ReadBufferOperation.cc b/source/blender/compositor/operations/COM_ReadBufferOperation.cc index cc58f29e8d9..d35d2516f16 100644 --- a/source/blender/compositor/operations/COM_ReadBufferOperation.cc +++ b/source/blender/compositor/operations/COM_ReadBufferOperation.cc @@ -44,7 +44,7 @@ void ReadBufferOperation::determineResolution(unsigned int resolution[2], operation->determineResolution(resolution, preferredResolution); operation->setResolution(resolution); - /** \todo: may not occur!, but does with blur node */ + /** \todo may not occur! But does with blur node. */ if (this->m_memoryProxy->getExecutor()) { this->m_memoryProxy->getExecutor()->setResolution(resolution); } diff --git a/source/blender/compositor/operations/COM_RenderLayersProg.h b/source/blender/compositor/operations/COM_RenderLayersProg.h index 33e4fb163c5..56f83f691e8 100644 --- a/source/blender/compositor/operations/COM_RenderLayersProg.h +++ b/source/blender/compositor/operations/COM_RenderLayersProg.h @@ -31,7 +31,7 @@ namespace blender::compositor { /** * Base class for all renderlayeroperations * - * \todo: rename to operation. + * \todo Rename to operation. */ class RenderLayersProg : public NodeOperation { protected: diff --git a/source/blender/compositor/operations/COM_SMAAOperation.cc b/source/blender/compositor/operations/COM_SMAAOperation.cc index 7a272fa8795..9dde73269fc 100644 --- a/source/blender/compositor/operations/COM_SMAAOperation.cc +++ b/source/blender/compositor/operations/COM_SMAAOperation.cc @@ -43,7 +43,7 @@ namespace blender::compositor { * Currently only SMAA 1x mode is provided, so the operation will be done * with no spatial multisampling nor temporal supersampling. * - * Note: This program assumes the screen coordinates are DirectX style, so + * NOTE: This program assumes the screen coordinates are DirectX style, so * the vertical direction is upside-down. "top" and "bottom" actually mean * bottom and top, respectively. */ diff --git a/source/blender/compositor/operations/COM_ScaleOperation.cc b/source/blender/compositor/operations/COM_ScaleOperation.cc index 03525d4ea01..18276fcc072 100644 --- a/source/blender/compositor/operations/COM_ScaleOperation.cc +++ b/source/blender/compositor/operations/COM_ScaleOperation.cc @@ -21,10 +21,10 @@ namespace blender::compositor { #define USE_FORCE_BILINEAR -/* XXX - ignore input and use default from old compositor, - * could become an option like the transform node - campbell +/* XXX(campbell): ignore input and use default from old compositor, + * could become an option like the transform node. * - * note: use bilinear because bicubic makes fuzzy even when not scaling at all (1:1) + * NOTE: use bilinear because bicubic makes fuzzy even when not scaling at all (1:1) */ BaseScaleOperation::BaseScaleOperation() diff --git a/source/blender/compositor/operations/COM_SunBeamsOperation.cc b/source/blender/compositor/operations/COM_SunBeamsOperation.cc index 839eeb9ff8f..ff117841e8e 100644 --- a/source/blender/compositor/operations/COM_SunBeamsOperation.cc +++ b/source/blender/compositor/operations/COM_SunBeamsOperation.cc @@ -197,7 +197,7 @@ template<int fxu, int fxv, int fyu, int fyv> struct BufferLineAccumulator { madd_v4_v4fl(output, border, border[3] * weight); } - /* TODO implement proper filtering here, see + /* TODO: implement proper filtering here, see * https://en.wikipedia.org/wiki/Lanczos_resampling * https://en.wikipedia.org/wiki/Sinc_function * diff --git a/source/blender/compositor/operations/COM_TextureOperation.h b/source/blender/compositor/operations/COM_TextureOperation.h index e5f56673694..6fec9ab8f33 100644 --- a/source/blender/compositor/operations/COM_TextureOperation.h +++ b/source/blender/compositor/operations/COM_TextureOperation.h @@ -31,7 +31,7 @@ namespace blender::compositor { /** * Base class for all renderlayeroperations * - * \todo: rename to operation. + * \todo Rename to operation. */ class TextureBaseOperation : public NodeOperation { private: diff --git a/source/blender/compositor/operations/COM_VectorBlurOperation.cc b/source/blender/compositor/operations/COM_VectorBlurOperation.cc index fd64bda156b..5adcc4fdd4c 100644 --- a/source/blender/compositor/operations/COM_VectorBlurOperation.cc +++ b/source/blender/compositor/operations/COM_VectorBlurOperation.cc @@ -449,7 +449,7 @@ void antialias_tagbuf(int xsize, int ysize, char *rectmove) /* now we can blend values */ next = row1[step]; - /* note, prev value can be next value, but we do this loop to clear 128 then */ + /* NOTE: prev value can be next value, but we do this loop to clear 128 then. */ for (a = 0; a < step; a++) { int fac, mfac; @@ -480,7 +480,7 @@ void antialias_tagbuf(int xsize, int ysize, char *rectmove) if (y + step != ysize) { /* now we can blend values */ next = row1[step * xsize]; - /* note, prev value can be next value, but we do this loop to clear 128 then */ + /* NOTE: prev value can be next value, but we do this loop to clear 128 then. */ for (a = 0; a < step; a++) { int fac, mfac; diff --git a/source/blender/compositor/operations/COM_WriteBufferOperation.cc b/source/blender/compositor/operations/COM_WriteBufferOperation.cc index 1aa19f26e2b..e2dc6287baf 100644 --- a/source/blender/compositor/operations/COM_WriteBufferOperation.cc +++ b/source/blender/compositor/operations/COM_WriteBufferOperation.cc @@ -124,7 +124,7 @@ void WriteBufferOperation::executeOpenCLRegion(OpenCLDevice *device, * 3. schedule read back from opencl to main device (outputbuffer) * 4. schedule native callback * - * note: list of cl_mem will be filled by 2, and needs to be cleaned up by 4 + * NOTE: list of cl_mem will be filled by 2, and needs to be cleaned up by 4 */ // STEP 1 const unsigned int outputBufferWidth = outputBuffer->getWidth(); |