[Bf-blender-cvs] [8aed5dbcf8e] master: Cleanup: move public doc-strings into headers for 'compositor'
Campbell Barton
noreply at git.blender.org
Thu Dec 9 10:04:01 CET 2021
Commit: 8aed5dbcf8e05675be8128b6197026e480622254
Author: Campbell Barton
Date: Thu Dec 9 20:01:49 2021 +1100
Branches: master
https://developer.blender.org/rB8aed5dbcf8e05675be8128b6197026e480622254
Cleanup: move public doc-strings into headers for 'compositor'
Ref T92709
===================================================================
M source/blender/compositor/intern/COM_ConstantFolder.cc
M source/blender/compositor/intern/COM_ConstantFolder.h
M source/blender/compositor/intern/COM_ExecutionGroup.cc
M source/blender/compositor/intern/COM_ExecutionGroup.h
M source/blender/compositor/intern/COM_ExecutionSystem.cc
M source/blender/compositor/intern/COM_ExecutionSystem.h
M source/blender/compositor/intern/COM_FullFrameExecutionModel.cc
M source/blender/compositor/intern/COM_FullFrameExecutionModel.h
M source/blender/compositor/intern/COM_MemoryBuffer.cc
M source/blender/compositor/intern/COM_MemoryBuffer.h
M source/blender/compositor/intern/COM_MetaData.cc
M source/blender/compositor/intern/COM_MetaData.h
M source/blender/compositor/intern/COM_NodeOperation.cc
M source/blender/compositor/intern/COM_NodeOperation.h
M source/blender/compositor/intern/COM_NodeOperationBuilder.cc
M source/blender/compositor/intern/COM_NodeOperationBuilder.h
M source/blender/compositor/intern/COM_SharedOperationBuffers.cc
M source/blender/compositor/intern/COM_SharedOperationBuffers.h
M source/blender/compositor/operations/COM_BlurBaseOperation.cc
M source/blender/compositor/operations/COM_BlurBaseOperation.h
M source/blender/compositor/operations/COM_DilateErodeOperation.cc
M source/blender/compositor/operations/COM_DilateErodeOperation.h
M source/blender/compositor/operations/COM_InpaintOperation.cc
M source/blender/compositor/operations/COM_InpaintOperation.h
M source/blender/compositor/operations/COM_RenderLayersProg.cc
M source/blender/compositor/operations/COM_SMAAOperation.cc
M source/blender/compositor/operations/COM_SMAAOperation.h
M source/blender/compositor/operations/COM_ScaleOperation.cc
M source/blender/compositor/operations/COM_ScaleOperation.h
M source/blender/compositor/operations/COM_TransformOperation.cc
M source/blender/compositor/operations/COM_TransformOperation.h
M source/blender/compositor/operations/COM_VectorBlurOperation.cc
===================================================================
diff --git a/source/blender/compositor/intern/COM_ConstantFolder.cc b/source/blender/compositor/intern/COM_ConstantFolder.cc
index 2cf3ac001d1..ca5fd9e8274 100644
--- a/source/blender/compositor/intern/COM_ConstantFolder.cc
+++ b/source/blender/compositor/intern/COM_ConstantFolder.cc
@@ -30,10 +30,6 @@ namespace blender::compositor {
using Link = NodeOperationBuilder::Link;
-/**
- * \param operations_builder: Contains all operations to fold.
- * \param exec_system: Execution system.
- */
ConstantFolder::ConstantFolder(NodeOperationBuilder &operations_builder)
: operations_builder_(operations_builder)
{
@@ -135,7 +131,6 @@ Vector<MemoryBuffer *> ConstantFolder::get_constant_input_buffers(NodeOperation
return inputs_bufs;
}
-/** Returns constant operations resulted from folded operations. */
Vector<ConstantOperation *> ConstantFolder::try_fold_operations(Span<NodeOperation *> operations)
{
Set<NodeOperation *> foldable_ops = find_constant_foldable_operations(operations);
@@ -151,9 +146,6 @@ Vector<ConstantOperation *> ConstantFolder::try_fold_operations(Span<NodeOperati
return new_folds;
}
-/**
- * Evaluate operations with constant elements into primitive constant operations.
- */
int ConstantFolder::fold_operations()
{
WorkScheduler::start(operations_builder_.context());
diff --git a/source/blender/compositor/intern/COM_ConstantFolder.h b/source/blender/compositor/intern/COM_ConstantFolder.h
index f31cb4f4e78..972dbf0e125 100644
--- a/source/blender/compositor/intern/COM_ConstantFolder.h
+++ b/source/blender/compositor/intern/COM_ConstantFolder.h
@@ -42,10 +42,18 @@ class ConstantFolder {
rcti first_elem_area_;
public:
+ /**
+ * \param operations_builder: Contains all operations to fold.
+ * \param exec_system: Execution system.
+ */
ConstantFolder(NodeOperationBuilder &operations_builder);
+ /**
+ * Evaluate operations with constant elements into primitive constant operations.
+ */
int fold_operations();
private:
+ /** Returns constant operations resulted from folded operations. */
Vector<ConstantOperation *> try_fold_operations(Span<NodeOperation *> operations);
ConstantOperation *fold_operation(NodeOperation *operation);
diff --git a/source/blender/compositor/intern/COM_ExecutionGroup.cc b/source/blender/compositor/intern/COM_ExecutionGroup.cc
index d2198fc14e8..63ca642d52d 100644
--- a/source/blender/compositor/intern/COM_ExecutionGroup.cc
+++ b/source/blender/compositor/intern/COM_ExecutionGroup.cc
@@ -302,10 +302,6 @@ blender::Array<unsigned int> ExecutionGroup::get_execution_order() const
return chunk_order;
}
-/**
- * this method is called for the top execution groups. containing the compositor node or the
- * preview node or the viewer node)
- */
void ExecutionGroup::execute(ExecutionSystem *graph)
{
const CompositorContext &context = graph->get_context();
diff --git a/source/blender/compositor/intern/COM_ExecutionGroup.h b/source/blender/compositor/intern/COM_ExecutionGroup.h
index ce5e9dd4699..430cde89a3b 100644
--- a/source/blender/compositor/intern/COM_ExecutionGroup.h
+++ b/source/blender/compositor/intern/COM_ExecutionGroup.h
@@ -365,6 +365,10 @@ class ExecutionGroup {
* \see ViewerOperation
* \param graph:
*/
+ /**
+ * This method is called for the top execution groups. containing the compositor node or the
+ * preview node or the viewer node).
+ */
void execute(ExecutionSystem *graph);
/**
diff --git a/source/blender/compositor/intern/COM_ExecutionSystem.cc b/source/blender/compositor/intern/COM_ExecutionSystem.cc
index 82821a1ddb1..038df6ed9df 100644
--- a/source/blender/compositor/intern/COM_ExecutionSystem.cc
+++ b/source/blender/compositor/intern/COM_ExecutionSystem.cc
@@ -118,9 +118,6 @@ void ExecutionSystem::execute()
execution_model_->execute(*this);
}
-/**
- * Multi-threadedly execute given work function passing work_rect splits as argument.
- */
void ExecutionSystem::execute_work(const rcti &work_rect,
std::function<void(const rcti &split_rect)> work_func)
{
diff --git a/source/blender/compositor/intern/COM_ExecutionSystem.h b/source/blender/compositor/intern/COM_ExecutionSystem.h
index 4a3fecaca47..4456ec107fa 100644
--- a/source/blender/compositor/intern/COM_ExecutionSystem.h
+++ b/source/blender/compositor/intern/COM_ExecutionSystem.h
@@ -208,6 +208,9 @@ class ExecutionSystem {
return active_buffers_;
}
+ /**
+ * Multi-threadedly execute given work function passing work_rect splits as argument.
+ */
void execute_work(const rcti &work_rect, std::function<void(const rcti &split_rect)> work_func);
/**
diff --git a/source/blender/compositor/intern/COM_FullFrameExecutionModel.cc b/source/blender/compositor/intern/COM_FullFrameExecutionModel.cc
index 1295437785f..15dbbfde7ed 100644
--- a/source/blender/compositor/intern/COM_FullFrameExecutionModel.cc
+++ b/source/blender/compositor/intern/COM_FullFrameExecutionModel.cc
@@ -73,10 +73,6 @@ void FullFrameExecutionModel::determine_areas_to_render_and_reads()
}
}
-/**
- * Returns input buffers with an offset relative to given output coordinates. Returned memory
- * buffers must be deleted.
- */
Vector<MemoryBuffer *> FullFrameExecutionModel::get_input_buffers(NodeOperation *op,
const int output_x,
const int output_y)
@@ -137,9 +133,6 @@ void FullFrameExecutionModel::render_operation(NodeOperation *op)
operation_finished(op);
}
-/**
- * Render output operations in order of priority.
- */
void FullFrameExecutionModel::render_operations()
{
const bool is_rendering = context_.is_rendering();
@@ -200,9 +193,6 @@ void FullFrameExecutionModel::render_output_dependencies(NodeOperation *output_o
}
}
-/**
- * Determines all operations areas needed to render given output area.
- */
void FullFrameExecutionModel::determine_areas_to_render(NodeOperation *output_op,
const rcti &output_area)
{
@@ -235,10 +225,6 @@ void FullFrameExecutionModel::determine_areas_to_render(NodeOperation *output_op
}
}
-/**
- * Determines reads to receive by operations in output operation tree (i.e: Number of dependent
- * operations each operation has).
- */
void FullFrameExecutionModel::determine_reads(NodeOperation *output_op)
{
BLI_assert(output_op->is_output_operation(context_.is_rendering()));
@@ -258,10 +244,6 @@ void FullFrameExecutionModel::determine_reads(NodeOperation *output_op)
}
}
-/**
- * Calculates given output operation area to be rendered taking into account viewer and render
- * borders.
- */
void FullFrameExecutionModel::get_output_render_area(NodeOperation *output_op, rcti &r_area)
{
BLI_assert(output_op->is_output_operation(context_.is_rendering()));
diff --git a/source/blender/compositor/intern/COM_FullFrameExecutionModel.h b/source/blender/compositor/intern/COM_FullFrameExecutionModel.h
index 36d42886c27..ce724a6b934 100644
--- a/source/blender/compositor/intern/COM_FullFrameExecutionModel.h
+++ b/source/blender/compositor/intern/COM_FullFrameExecutionModel.h
@@ -42,8 +42,8 @@ class SharedOperationBuffers;
class FullFrameExecutionModel : public ExecutionModel {
private:
/**
- * Contains operations active buffers data. Buffers will be disposed once reader operations are
- * finished.
+ * Contains operations active buffers data.
+ * Buffers will be disposed once reader operations are finished.
*/
SharedOperationBuffers &active_buffers_;
@@ -66,8 +66,15 @@ class FullFrameExecutionModel : public ExecutionModel {
private:
void determine_areas_to_render_and_reads();
+ /**
+ * Render output operations in order of priority.
+ */
void render_operations();
void render_output_dependencies(NodeOperation *output_op);
+ /**
+ * Returns input buffers with an offset relative to given output coordinates.
+ * Returned memory buffers must be deleted.
+ */
Vector<MemoryBuffer *> get_input_buffers(NodeOperation *op,
const int output_x,
const int output_y);
@@ -76,8 +83,19 @@ class FullFrameExecutionModel : public ExecutionModel {
void operation_finished(NodeOperation *operation);
+ /**
+ * Calculates given output operation area to be rendered taking into account viewer and render
+ * borders.
+ */
void get_output_render_area(NodeOperation *output_op, rcti &r_area);
+ /**
+ * Determines all operations areas needed to render given output area.
+ */
void determine_areas_to_render(NodeOperation *output_op, const rcti &output_area);
+ /**
+ * Determines reads to receive by operations in output operation tree (i.e: Number of dependent
+ * operations each operation has).
+ */
void determine_reads(NodeOperation *output_op);
void update_progress_bar();
diff --git a/source/blender/compositor/intern/COM_MemoryBuffer.cc b/source/blender/compositor/intern/COM_MemoryBuffer.cc
index 96888ea1c96..ae925f796ee 100644
--- a/source/blender/compositor/intern/COM_MemoryBuffer.cc
+++ b/source/blender/compositor/intern/COM_MemoryBuffer.cc
@@ -74,20 +74,12 @@ MemoryBuffer::MemoryBuffer(DataType data_type, const rcti &rect, bool is_a_singl
set_strides();
}
-/**
- * Construct MemoryBuffer from a float buffer. MemoryBuffer is not responsible for
- * freeing it.
- */
MemoryBuffer::MemoryBuffer(
float *buffer, int num_channels, int width, int height, bool is_a_single_elem)
: MemoryBuffer(buffer, num_channels, create_rect(width, height), is_a_single_elem)
{
}
-/**
- * Construct MemoryBuffer from a float buffer area. MemoryBuffer is not responsible for
- * freeing given buffer.
- */
MemoryBuffer::MemoryBuffer(float *buffer,
const int num_channels,
const rcti &rect,
@@ -145,10 +137,6 @@ BuffersIterator<float> MemoryBuffer::iterate_with(Span<MemoryBuffer *> inputs, c
return builder.build();
}
-/**
- * Converts a single elem buffer to a full size buffer (allocates memory for all
-
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list