blender::fn::multi_function::Params Class Reference

#include <FN_multi_function_params.hh>

Public Member Functions
	Params (ParamsBuilder &builder)

#Params Inline Methods
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 88 of file FN_multi_function_params.hh.

Constructor & Destructor Documentation

Params()

blender::fn::multi_function::Params::Params ( ParamsBuilder & builder )

inline

Definition at line 93 of file FN_multi_function_params.hh.

Member Function Documentation

readonly_single_input() [1/2]

template<typename T>

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

inline

Definition at line 342 of file FN_multi_function_params.hh.

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

Referenced by blender::fn::multi_function::add_sliced_parameters(), and readonly_single_input().

readonly_single_input() [2/2]

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

inline

Definition at line 348 of file FN_multi_function_params.hh.

References blender::fn::multi_function::SingleInput.

readonly_vector_input() [1/2]

template<typename T>

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

inline

Definition at line 393 of file FN_multi_function_params.hh.

References readonly_vector_input().

Referenced by readonly_vector_input().

readonly_vector_input() [2/2]

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

inline

Definition at line 399 of file FN_multi_function_params.hh.

References blender::fn::multi_function::VectorInput.

single_mutable() [1/2]

template<typename T>

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

inline

Definition at line 417 of file FN_multi_function_params.hh.

References single_mutable(), and T.

Referenced by blender::fn::multi_function::add_sliced_parameters(), and single_mutable().

single_mutable() [2/2]

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

inline

Definition at line 422 of file FN_multi_function_params.hh.

References blender::fn::multi_function::SingleMutable.

single_output_is_required()

bool blender::fn::multi_function::Params::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 354 of file FN_multi_function_params.hh.

References blender::fn::multi_function::SingleOutput.

uninitialized_single_output() [1/2]

template<typename T>

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

inline

Definition at line 361 of file FN_multi_function_params.hh.

References T, and uninitialized_single_output().

Referenced by blender::fn::multi_function::add_sliced_parameters(), and uninitialized_single_output().

uninitialized_single_output() [2/2]

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

inline

Definition at line 366 of file FN_multi_function_params.hh.

References BLI_assert, blender::fn::multi_function::SingleOutput, blender::GMutableSpan::size(), and blender::fn::multi_function::SupportsUnusedOutput.

uninitialized_single_output_if_required() [1/2]

template<typename T>

MutableSpan< T > blender::fn::multi_function::Params::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 377 of file FN_multi_function_params.hh.

References T, and uninitialized_single_output_if_required().

Referenced by blender::fn::multi_function::add_sliced_parameters(), and uninitialized_single_output_if_required().

uninitialized_single_output_if_required() [2/2]

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

inline

Definition at line 383 of file FN_multi_function_params.hh.

References BLI_assert, blender::fn::multi_function::SingleOutput, and blender::fn::multi_function::SupportsUnusedOutput.

vector_mutable() [1/2]

template<typename T>

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

inline

Definition at line 429 of file FN_multi_function_params.hh.

References vector_mutable().

Referenced by vector_mutable().

vector_mutable() [2/2]

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

inline

Definition at line 434 of file FN_multi_function_params.hh.

References blender::fn::multi_function::VectorMutable.

vector_output() [1/2]

template<typename T>

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

inline

Definition at line 406 of file FN_multi_function_params.hh.

References vector_output().

Referenced by vector_output().

vector_output() [2/2]

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

inline

Definition at line 411 of file FN_multi_function_params.hh.

References blender::fn::multi_function::VectorOutput.

---

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

• FN_multi_function_params.hh