blender::fn::MFParams Class Reference

#include <FN_multi_function_params.hh>

Public Member Functions
	MFParams (MFParamsBuilder &builder)
template<typename T >
VArray< T >	readonly_single_input (int param_index, StringRef name="")
const GVArray &	readonly_single_input (int param_index, StringRef name="")
bool	single_output_is_required (int param_index, StringRef name="")
template<typename T >
MutableSpan< T >	uninitialized_single_output (int param_index, StringRef name="")
GMutableSpan	uninitialized_single_output (int param_index, StringRef name="")
template<typename T >
MutableSpan< T >	uninitialized_single_output_if_required (int param_index, StringRef name="")
GMutableSpan	uninitialized_single_output_if_required (int param_index, StringRef name="")
template<typename T >
const VVectorArray< T > &	readonly_vector_input (int param_index, StringRef name="")
const GVVectorArray &	readonly_vector_input (int param_index, StringRef name="")
template<typename T >
GVectorArray_TypedMutableRef< T >	vector_output (int param_index, StringRef name="")
GVectorArray &	vector_output (int param_index, StringRef name="")
template<typename T >
MutableSpan< T >	single_mutable (int param_index, StringRef name="")
GMutableSpan	single_mutable (int param_index, StringRef name="")
template<typename T >
GVectorArray_TypedMutableRef< T >	vector_mutable (int param_index, StringRef name="")
GVectorArray &	vector_mutable (int param_index, StringRef name="")

Detailed Description

Definition at line 213 of file FN_multi_function_params.hh.

Constructor & Destructor Documentation

MFParams()

blender::fn::MFParams::MFParams ( MFParamsBuilder &  builder )

inline

Definition at line 218 of file FN_multi_function_params.hh.

Member Function Documentation

readonly_single_input() [1/2]

template<typename T >

VArray<T> blender::fn::MFParams::readonly_single_input ( int  param_index, StringRef  name = ""  )

inline

Definition at line 222 of file FN_multi_function_params.hh.

References T, and blender::GVArray::typed().

readonly_single_input() [2/2]

const GVArray& blender::fn::MFParams::readonly_single_input ( int  param_index, StringRef  name = ""  )

inline

Definition at line 227 of file FN_multi_function_params.hh.

References blender::fn::MFSignature::data_index(), and blender::fn::SingleInput.

readonly_vector_input() [1/2]

template<typename T >

const VVectorArray<T>& blender::fn::MFParams::readonly_vector_input ( int  param_index, StringRef  name = ""  )

inline

Definition at line 282 of file FN_multi_function_params.hh.

References blender::ResourceScope::construct().

readonly_vector_input() [2/2]

const GVVectorArray& blender::fn::MFParams::readonly_vector_input ( int  param_index, StringRef  name = ""  )

inline

Definition at line 287 of file FN_multi_function_params.hh.

References blender::fn::MFSignature::data_index(), and blender::fn::VectorInput.

single_mutable() [1/2]

template<typename T >

MutableSpan<T> blender::fn::MFParams::single_mutable ( int  param_index, StringRef  name = ""  )

inline

Definition at line 306 of file FN_multi_function_params.hh.

References T.

single_mutable() [2/2]

GMutableSpan blender::fn::MFParams::single_mutable ( int  param_index, StringRef  name = ""  )

inline

Definition at line 310 of file FN_multi_function_params.hh.

References blender::fn::MFSignature::data_index(), and blender::fn::SingleMutable.

single_output_is_required()

bool blender::fn::MFParams::single_output_is_required ( int  param_index, StringRef  name = ""  )

inline

Returns

True when the caller provided a buffer for this output parameter. This allows the called multi-function to skip some computation. It is still valid to call uninitialized_single_output when this returns false. In this case a new temporary buffer is allocated.

Definition at line 240 of file FN_multi_function_params.hh.

References blender::fn::MFSignature::data_index(), and blender::fn::SingleOutput.

uninitialized_single_output() [1/2]

template<typename T >

MutableSpan<T> blender::fn::MFParams::uninitialized_single_output ( int  param_index, StringRef  name = ""  )

inline

Definition at line 248 of file FN_multi_function_params.hh.

References T.

uninitialized_single_output() [2/2]

GMutableSpan blender::fn::MFParams::uninitialized_single_output ( int  param_index, StringRef  name = ""  )

inline

Definition at line 252 of file FN_multi_function_params.hh.

References blender::fn::MFSignature::data_index(), blender::GMutableSpan::is_empty(), and blender::fn::SingleOutput.

uninitialized_single_output_if_required() [1/2]

template<typename T >

MutableSpan<T> blender::fn::MFParams::uninitialized_single_output_if_required ( int  param_index, StringRef  name = ""  )

inline

Same as uninitialized_single_output, but returns an empty span when the output is not required.

Definition at line 270 of file FN_multi_function_params.hh.

References T.

uninitialized_single_output_if_required() [2/2]

GMutableSpan blender::fn::MFParams::uninitialized_single_output_if_required ( int  param_index, StringRef  name = ""  )

inline

Definition at line 274 of file FN_multi_function_params.hh.

References blender::fn::MFSignature::data_index(), and blender::fn::SingleOutput.

vector_mutable() [1/2]

template<typename T >

GVectorArray_TypedMutableRef<T> blender::fn::MFParams::vector_mutable ( int  param_index, StringRef  name = ""  )

inline

Definition at line 318 of file FN_multi_function_params.hh.

vector_mutable() [2/2]

GVectorArray& blender::fn::MFParams::vector_mutable ( int  param_index, StringRef  name = ""  )

inline

Definition at line 322 of file FN_multi_function_params.hh.

References blender::fn::MFSignature::data_index(), and blender::fn::VectorMutable.

vector_output() [1/2]

template<typename T >

GVectorArray_TypedMutableRef<T> blender::fn::MFParams::vector_output ( int  param_index, StringRef  name = ""  )

inline

Definition at line 295 of file FN_multi_function_params.hh.

vector_output() [2/2]

GVectorArray& blender::fn::MFParams::vector_output ( int  param_index, StringRef  name = ""  )

inline

Definition at line 299 of file FN_multi_function_params.hh.

References blender::fn::MFSignature::data_index(), and blender::fn::VectorOutput.

---

The documentation for this class was generated from the following files:

• FN_multi_function_params.hh
• multi_function_params.cc