Blender
V5.3
source
blender
compositor
COM_implicit_input_operation.hh
Go to the documentation of this file.
1
/* SPDX-FileCopyrightText: 2025 Blender Authors
2
*
3
* SPDX-License-Identifier: GPL-2.0-or-later */
4
5
#pragma once
6
7
#include <optional>
8
9
#include "
BLI_string_ref.hh
"
10
11
#include "
COM_context.hh
"
12
#include "
COM_domain.hh
"
13
#include "
COM_input_descriptor.hh
"
14
#include "
COM_operation.hh
"
15
#include "
COM_result.hh
"
16
17
namespace
blender::compositor
{
18
19
/* ------------------------------------------------------------------------------------------------
20
* Implicit Input Operation
21
*
22
* An operation that outputs a result representing a specific implicit input. */
23
class
ImplicitInputOperation
:
public
Operation
{
24
private
:
25
/* The identifier of the output. */
26
static
const
StringRef
output_identifier_;
27
/* The type of implicit input needed. */
28
ImplicitInputType
implicit_input_;
29
30
public
:
31
ImplicitInputOperation
(
Context
&
context
,
const
ImplicitInputType
implicit_input);
32
33
void
execute
()
override
;
34
35
/* Get a reference to the output result of the operation, this essentially calls the super
36
* get_result with the output identifier of the operation. */
37
Result
&
get_result
();
38
39
/* Returns the domain of the implicit input. If the implicit input is a single value,
40
* std::nullopt is returned. */
41
static
std::optional<Domain>
get_domain
(
const
Context
&
context
,
42
const
ImplicitInputType
implicit_input);
43
};
44
45
}
// namespace blender::compositor
BLI_string_ref.hh
COM_context.hh
COM_domain.hh
COM_input_descriptor.hh
COM_operation.hh
COM_result.hh
blender::StringRef
Definition
BLI_string_ref.hh:165
blender::compositor::Context
Definition
COM_context.hh:53
blender::compositor::ImplicitInputOperation::get_domain
static std::optional< Domain > get_domain(const Context &context, const ImplicitInputType implicit_input)
Definition
implicit_input_operation.cc:64
blender::compositor::ImplicitInputOperation::execute
void execute() override
Definition
implicit_input_operation.cc:39
blender::compositor::ImplicitInputOperation::get_result
Result & get_result()
Definition
implicit_input_operation.cc:59
blender::compositor::ImplicitInputOperation::ImplicitInputOperation
ImplicitInputOperation(Context &context, const ImplicitInputType implicit_input)
Definition
implicit_input_operation.cc:32
blender::compositor::Operation::Operation
Operation(Context &context)
Definition
operation.cc:22
blender::compositor::Operation::context
Context & context() const
Definition
operation.cc:57
blender::compositor::Result
Definition
COM_result.hh:125
blender::compositor
Definition
BKE_node.hh:77
blender::compositor::ImplicitInputType
ImplicitInputType
Definition
COM_input_descriptor.hh:34
Generated on
for Blender by
doxygen
1.18.0