FN_multi_function_param_type.hh File Reference

#include "FN_multi_function_data_type.hh"

Go to the source code of this file.

Classes
struct	blender::fn::multi_function::ParamTag< Category, T >
class	blender::fn::multi_function::ParamType

Namespaces
namespace	blender
namespace	blender::fn
namespace	blender::fn::multi_function

Enumerations
enum class	blender::fn::multi_function::ParamCategory {   blender::fn::multi_function::SingleInput , blender::fn::multi_function::VectorInput , blender::fn::multi_function::SingleOutput , blender::fn::multi_function::VectorOutput ,   blender::fn::multi_function::SingleMutable , blender::fn::multi_function::VectorMutable }

Detailed Description

A multi-function has an arbitrary amount of parameters. Every parameter belongs to one of three interface types:

• Input: An input parameter is readonly inside the function. The values have to be provided by the caller.
• Output: An output parameter has to be initialized by the function. However, the caller provides the memory where the data has to be constructed.
• Mutable: A mutable parameter can be considered to be an input and output. The caller has to initialize the data, but the function is allowed to modify it.

Furthermore, every parameter has a DataType that describes what kind of data is being passed around.

Definition in file FN_multi_function_param_type.hh.