Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'source/blender/compositor/realtime_compositor/COM_input_descriptor.hh')
-rw-r--r--source/blender/compositor/realtime_compositor/COM_input_descriptor.hh34
1 files changed, 34 insertions, 0 deletions
diff --git a/source/blender/compositor/realtime_compositor/COM_input_descriptor.hh b/source/blender/compositor/realtime_compositor/COM_input_descriptor.hh
new file mode 100644
index 00000000000..215a92ab3b4
--- /dev/null
+++ b/source/blender/compositor/realtime_compositor/COM_input_descriptor.hh
@@ -0,0 +1,34 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later */
+
+#pragma once
+
+#include "COM_result.hh"
+
+namespace blender::realtime_compositor {
+
+/* ------------------------------------------------------------------------------------------------
+ * Input Descriptor
+ *
+ * A class that describes an input of an operation. */
+class InputDescriptor {
+ public:
+ /* The type of input. This may be different that the type of result that the operation will
+ * receive for the input, in which case, an implicit conversion operation will be added as an
+ * input processor to convert it to the required type. */
+ ResultType type;
+ /* If true, then the input does not need to be realized on the domain of the operation before its
+ * execution. See the discussion in COM_domain.hh for more information. */
+ bool skip_realization = false;
+ /* The priority of the input for determining the operation domain. The non-single value input
+ * with the highest priority will be used to infer the operation domain, the highest priority
+ * being zero. See the discussion in COM_domain.hh for more information. */
+ int domain_priority = 0;
+ /* If true, the input expects a single value, and if a non-single value is provided, a default
+ * single value will be used instead, see the get_<type>_value_default methods in the Result
+ * class. It follows that this also implies skip_realization, because we don't need to realize a
+ * result that will be discarded anyways. If false, the input can work with both single and
+ * non-single values. */
+ bool expects_single_value = false;
+};
+
+} // namespace blender::realtime_compositor