From 8aed5dbcf8e05675be8128b6197026e480622254 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Thu, 9 Dec 2021 20:01:49 +1100 Subject: Cleanup: move public doc-strings into headers for 'compositor' Ref T92709 --- source/blender/compositor/operations/COM_BlurBaseOperation.cc | 2 -- source/blender/compositor/operations/COM_BlurBaseOperation.h | 4 ++++ source/blender/compositor/operations/COM_DilateErodeOperation.cc | 5 ----- source/blender/compositor/operations/COM_DilateErodeOperation.h | 5 +++++ source/blender/compositor/operations/COM_InpaintOperation.cc | 1 - source/blender/compositor/operations/COM_InpaintOperation.h | 1 + source/blender/compositor/operations/COM_RenderLayersProg.cc | 3 +++ source/blender/compositor/operations/COM_SMAAOperation.cc | 6 ------ source/blender/compositor/operations/COM_SMAAOperation.h | 6 ++++++ source/blender/compositor/operations/COM_ScaleOperation.cc | 1 - source/blender/compositor/operations/COM_ScaleOperation.h | 1 + source/blender/compositor/operations/COM_TransformOperation.cc | 2 -- source/blender/compositor/operations/COM_TransformOperation.h | 2 ++ source/blender/compositor/operations/COM_VectorBlurOperation.cc | 1 + 14 files changed, 23 insertions(+), 17 deletions(-) (limited to 'source/blender/compositor/operations') diff --git a/source/blender/compositor/operations/COM_BlurBaseOperation.cc b/source/blender/compositor/operations/COM_BlurBaseOperation.cc index aefe74a7e26..702733498c8 100644 --- a/source/blender/compositor/operations/COM_BlurBaseOperation.cc +++ b/source/blender/compositor/operations/COM_BlurBaseOperation.cc @@ -111,8 +111,6 @@ __m128 *BlurBaseOperation::convert_gausstab_sse(const float *gausstab, int size) } #endif -/* normalized distance from the current (inverted so 1.0 is close and 0.0 is far) - * 'ease' is applied after, looks nicer */ float *BlurBaseOperation::make_dist_fac_inverse(float rad, int size, int falloff) { float *dist_fac_invert, val; diff --git a/source/blender/compositor/operations/COM_BlurBaseOperation.h b/source/blender/compositor/operations/COM_BlurBaseOperation.h index ab378983100..e12c5427082 100644 --- a/source/blender/compositor/operations/COM_BlurBaseOperation.h +++ b/source/blender/compositor/operations/COM_BlurBaseOperation.h @@ -41,6 +41,10 @@ class BlurBaseOperation : public MultiThreadedOperation, public QualityStepHelpe #ifdef BLI_HAVE_SSE2 __m128 *convert_gausstab_sse(const float *gausstab, int size); #endif + /** + * Normalized distance from the current (inverted so 1.0 is close and 0.0 is far) + * 'ease' is applied after, looks nicer. + */ float *make_dist_fac_inverse(float rad, int size, int falloff); void update_size(); diff --git a/source/blender/compositor/operations/COM_DilateErodeOperation.cc b/source/blender/compositor/operations/COM_DilateErodeOperation.cc index 2abc4f71b5e..3aaf402ae24 100644 --- a/source/blender/compositor/operations/COM_DilateErodeOperation.cc +++ b/source/blender/compositor/operations/COM_DilateErodeOperation.cc @@ -21,7 +21,6 @@ namespace blender::compositor { -/* DilateErode Distance Threshold */ DilateErodeThresholdOperation::DilateErodeThresholdOperation() { this->add_input_socket(DataType::Value); @@ -268,7 +267,6 @@ void DilateErodeThresholdOperation::update_memory_buffer_partial(MemoryBuffer *o } } -/* Dilate Distance. */ DilateDistanceOperation::DilateDistanceOperation() { this->add_input_socket(DataType::Value); @@ -458,7 +456,6 @@ void DilateDistanceOperation::update_memory_buffer_partial(MemoryBuffer *output, } } -/* Erode Distance */ ErodeDistanceOperation::ErodeDistanceOperation() : DilateDistanceOperation() { /* pass */ @@ -531,7 +528,6 @@ void ErodeDistanceOperation::update_memory_buffer_partial(MemoryBuffer *output, } } -/* Dilate step */ DilateStepOperation::DilateStepOperation() { this->add_input_socket(DataType::Value); @@ -809,7 +805,6 @@ void DilateStepOperation::update_memory_buffer_partial(MemoryBuffer *output, step_update_memory_buffer(output, inputs[0], area, iterations_, -FLT_MAX); } -/* Erode step */ ErodeStepOperation::ErodeStepOperation() : DilateStepOperation() { /* pass */ diff --git a/source/blender/compositor/operations/COM_DilateErodeOperation.h b/source/blender/compositor/operations/COM_DilateErodeOperation.h index 04d25a1fca6..2ca6431862d 100644 --- a/source/blender/compositor/operations/COM_DilateErodeOperation.h +++ b/source/blender/compositor/operations/COM_DilateErodeOperation.h @@ -43,6 +43,7 @@ class DilateErodeThresholdOperation : public MultiThreadedOperation { int scope_; public: + /* DilateErode Distance Threshold */ DilateErodeThresholdOperation(); /** @@ -98,6 +99,7 @@ class DilateDistanceOperation : public MultiThreadedOperation { int scope_; public: + /* Dilate Distance. */ DilateDistanceOperation(); /** @@ -140,6 +142,7 @@ class DilateDistanceOperation : public MultiThreadedOperation { class ErodeDistanceOperation : public DilateDistanceOperation { public: + /* Erode Distance */ ErodeDistanceOperation(); /** @@ -169,6 +172,7 @@ class DilateStepOperation : public MultiThreadedOperation { int iterations_; public: + /* Dilate step */ DilateStepOperation(); /** @@ -205,6 +209,7 @@ class DilateStepOperation : public MultiThreadedOperation { class ErodeStepOperation : public DilateStepOperation { public: + /** Erode step. */ ErodeStepOperation(); void *initialize_tile_data(rcti *rect) override; diff --git a/source/blender/compositor/operations/COM_InpaintOperation.cc b/source/blender/compositor/operations/COM_InpaintOperation.cc index 2d632bb3681..83bc81d35fc 100644 --- a/source/blender/compositor/operations/COM_InpaintOperation.cc +++ b/source/blender/compositor/operations/COM_InpaintOperation.cc @@ -25,7 +25,6 @@ namespace blender::compositor { #define ASSERT_XY_RANGE(x, y) \ BLI_assert(x >= 0 && x < this->get_width() && y >= 0 && y < this->get_height()) -/* In-paint (simple convolve using average of known pixels). */ InpaintSimpleOperation::InpaintSimpleOperation() { this->add_input_socket(DataType::Color); diff --git a/source/blender/compositor/operations/COM_InpaintOperation.h b/source/blender/compositor/operations/COM_InpaintOperation.h index b0d44e22b85..989d154dab5 100644 --- a/source/blender/compositor/operations/COM_InpaintOperation.h +++ b/source/blender/compositor/operations/COM_InpaintOperation.h @@ -39,6 +39,7 @@ class InpaintSimpleOperation : public NodeOperation { short *manhattan_distance_; public: + /** In-paint (simple convolve using average of known pixels). */ InpaintSimpleOperation(); /** diff --git a/source/blender/compositor/operations/COM_RenderLayersProg.cc b/source/blender/compositor/operations/COM_RenderLayersProg.cc index 7650def2c87..d8e73b7c979 100644 --- a/source/blender/compositor/operations/COM_RenderLayersProg.cc +++ b/source/blender/compositor/operations/COM_RenderLayersProg.cc @@ -263,6 +263,7 @@ void RenderLayersProg::update_memory_buffer_partial(MemoryBuffer *output, } /* ******** Render Layers AO Operation ******** */ + void RenderLayersAOOperation::execute_pixel_sampled(float output[4], float x, float y, @@ -294,6 +295,7 @@ void RenderLayersAOOperation::update_memory_buffer_partial(MemoryBuffer *output, } /* ******** Render Layers Alpha Operation ******** */ + void RenderLayersAlphaProg::execute_pixel_sampled(float output[4], float x, float y, @@ -326,6 +328,7 @@ void RenderLayersAlphaProg::update_memory_buffer_partial(MemoryBuffer *output, } /* ******** Render Layers Depth Operation ******** */ + void RenderLayersDepthProg::execute_pixel_sampled(float output[4], float x, float y, diff --git a/source/blender/compositor/operations/COM_SMAAOperation.cc b/source/blender/compositor/operations/COM_SMAAOperation.cc index ef67b6ca5f9..20e85c69ac8 100644 --- a/source/blender/compositor/operations/COM_SMAAOperation.cc +++ b/source/blender/compositor/operations/COM_SMAAOperation.cc @@ -664,9 +664,6 @@ void SMAABlendingWeightCalculationOperation::get_area_of_interest(const int UNUS /*-----------------------------------------------------------------------------*/ /* Diagonal Search Functions */ -/** - * These functions allows to perform diagonal pattern searches. - */ int SMAABlendingWeightCalculationOperation::search_diag1(int x, int y, int dir, bool *found) { float e[4]; @@ -714,9 +711,6 @@ int SMAABlendingWeightCalculationOperation::search_diag2(int x, int y, int dir, return x - dir; } -/** - * This searches for diagonal patterns and returns the corresponding weights. - */ void SMAABlendingWeightCalculationOperation::calculate_diag_weights(int x, int y, const float edges[2], diff --git a/source/blender/compositor/operations/COM_SMAAOperation.h b/source/blender/compositor/operations/COM_SMAAOperation.h index 65a88d43fdf..ec04594e0aa 100644 --- a/source/blender/compositor/operations/COM_SMAAOperation.h +++ b/source/blender/compositor/operations/COM_SMAAOperation.h @@ -111,8 +111,14 @@ class SMAABlendingWeightCalculationOperation : public MultiThreadedOperation { private: /* Diagonal Search Functions */ + /** + * These functions allows to perform diagonal pattern searches. + */ int search_diag1(int x, int y, int dir, bool *found); int search_diag2(int x, int y, int dir, bool *found); + /** + * This searches for diagonal patterns and returns the corresponding weights. + */ void calculate_diag_weights(int x, int y, const float edges[2], float weights[2]); bool is_vertical_search_unneeded(int x, int y); diff --git a/source/blender/compositor/operations/COM_ScaleOperation.cc b/source/blender/compositor/operations/COM_ScaleOperation.cc index 5a351055241..281087bb4c7 100644 --- a/source/blender/compositor/operations/COM_ScaleOperation.cc +++ b/source/blender/compositor/operations/COM_ScaleOperation.cc @@ -374,7 +374,6 @@ bool ScaleAbsoluteOperation::determine_depending_area_of_interest( return ScaleOperation::determine_depending_area_of_interest(&new_input, read_operation, output); } -/* Absolute fixed size. */ ScaleFixedSizeOperation::ScaleFixedSizeOperation() : BaseScaleOperation() { this->add_input_socket(DataType::Color, ResizeMode::None); diff --git a/source/blender/compositor/operations/COM_ScaleOperation.h b/source/blender/compositor/operations/COM_ScaleOperation.h index 7710aa34c54..cac865b41aa 100644 --- a/source/blender/compositor/operations/COM_ScaleOperation.h +++ b/source/blender/compositor/operations/COM_ScaleOperation.h @@ -173,6 +173,7 @@ class ScaleFixedSizeOperation : public BaseScaleOperation { bool is_offset_; public: + /** Absolute fixed size. */ ScaleFixedSizeOperation(); bool determine_depending_area_of_interest(rcti *input, ReadBufferOperation *read_operation, diff --git a/source/blender/compositor/operations/COM_TransformOperation.cc b/source/blender/compositor/operations/COM_TransformOperation.cc index 5b8cd35cb26..f18e7e44094 100644 --- a/source/blender/compositor/operations/COM_TransformOperation.cc +++ b/source/blender/compositor/operations/COM_TransformOperation.cc @@ -171,7 +171,6 @@ void TransformOperation::determine_canvas(const rcti &preferred_area, rcti &r_ar } } -/** Translate -> Rotate -> Scale. */ void TransformOperation::transform(BuffersIterator &it, const MemoryBuffer *input_img) { float rotate_center_x, rotate_center_y; @@ -198,7 +197,6 @@ void TransformOperation::transform(BuffersIterator &it, const MemoryBuffe } } -/** Scale -> Rotate -> Translate. */ void TransformOperation::transform_inverted(BuffersIterator &it, const MemoryBuffer *input_img) { diff --git a/source/blender/compositor/operations/COM_TransformOperation.h b/source/blender/compositor/operations/COM_TransformOperation.h index 5c646b215f2..4db2145cc2d 100644 --- a/source/blender/compositor/operations/COM_TransformOperation.h +++ b/source/blender/compositor/operations/COM_TransformOperation.h @@ -82,7 +82,9 @@ class TransformOperation : public MultiThreadedOperation { void determine_canvas(const rcti &preferred_area, rcti &r_area) override; private: + /** Translate -> Rotate -> Scale. */ void transform(BuffersIterator &it, const MemoryBuffer *input_img); + /** Scale -> Rotate -> Translate. */ void transform_inverted(BuffersIterator &it, const MemoryBuffer *input_img); }; diff --git a/source/blender/compositor/operations/COM_VectorBlurOperation.cc b/source/blender/compositor/operations/COM_VectorBlurOperation.cc index b220990db76..e34b629f457 100644 --- a/source/blender/compositor/operations/COM_VectorBlurOperation.cc +++ b/source/blender/compositor/operations/COM_VectorBlurOperation.cc @@ -40,6 +40,7 @@ void zbuf_free_span(ZSpan *zspan); void antialias_tagbuf(int xsize, int ysize, char *rectmove); /* VectorBlurOperation */ + VectorBlurOperation::VectorBlurOperation() { this->add_input_socket(DataType::Color); -- cgit v1.2.3