Blender  V2.93
Public Member Functions | Friends | List of all members
blender::fn::MFParamsBuilder Class Reference

#include <FN_multi_function_params.hh>

Public Member Functions

 MFParamsBuilder (const MFSignature &signature, int64_t min_array_size)
 
 MFParamsBuilder (const class MultiFunction &fn, int64_t min_array_size)
 
template<typename T >
void add_readonly_single_input (const T *value, StringRef expected_name="")
 
void add_readonly_single_input (const GSpan span, StringRef expected_name="")
 
void add_readonly_single_input (const GVArray &ref, StringRef expected_name="")
 
void add_readonly_vector_input (const GVectorArray &vector_array, StringRef expected_name="")
 
void add_readonly_vector_input (const GVVectorArray &ref, StringRef expected_name="")
 
template<typename T >
void add_uninitialized_single_output (T *value, StringRef expected_name="")
 
void add_uninitialized_single_output (GMutableSpan ref, StringRef expected_name="")
 
void add_vector_output (GVectorArray &vector_array, StringRef expected_name="")
 
void add_single_mutable (GMutableSpan ref, StringRef expected_name="")
 
void add_vector_mutable (GVectorArray &vector_array, StringRef expected_name="")
 
GMutableSpan computed_array (int param_index)
 
GVectorArray & computed_vector_array (int param_index)
 
ResourceScope & resource_scope ()
 

Friends

class MFParams
 

Detailed Description

Definition at line 36 of file FN_multi_function_params.hh.

Constructor & Destructor Documentation

◆ MFParamsBuilder() [1/2]

blender::fn::MFParamsBuilder::MFParamsBuilder ( const MFSignature &  signature,
int64_t  min_array_size 
)
inline

Definition at line 49 of file FN_multi_function_params.hh.

◆ MFParamsBuilder() [2/2]

blender::fn::MFParamsBuilder::MFParamsBuilder ( const class MultiFunction &  fn,
int64_t  min_array_size 
)
inline

Definition at line 124 of file FN_multi_function.hh.

Member Function Documentation

◆ add_readonly_single_input() [1/3]

void blender::fn::MFParamsBuilder::add_readonly_single_input ( const GSpan  span,
StringRef  expected_name = "" 
)
inline

Definition at line 62 of file FN_multi_function_params.hh.

References add_readonly_single_input(), and blender::ResourceScope::construct().

◆ add_readonly_single_input() [2/3]

void blender::fn::MFParamsBuilder::add_readonly_single_input ( const GVArray &  ref,
StringRef  expected_name = "" 
)
inline

Definition at line 67 of file FN_multi_function_params.hh.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, blender::fn::MFParamType::ForSingleInput(), blender::fn::GVArray::size(), and blender::fn::GVArray::type().

◆ add_readonly_single_input() [3/3]

template<typename T >
void blender::fn::MFParamsBuilder::add_readonly_single_input ( const T *  value,
StringRef  expected_name = "" 
)
inline

Definition at line 56 of file FN_multi_function_params.hh.

References blender::ResourceScope::construct().

Referenced by add_readonly_single_input().

◆ add_readonly_vector_input() [1/2]

void blender::fn::MFParamsBuilder::add_readonly_vector_input ( const GVectorArray &  vector_array,
StringRef  expected_name = "" 
)
inline

Definition at line 74 of file FN_multi_function_params.hh.

References blender::ResourceScope::construct().

◆ add_readonly_vector_input() [2/2]

void blender::fn::MFParamsBuilder::add_readonly_vector_input ( const GVVectorArray &  ref,
StringRef  expected_name = "" 
)
inline

Definition at line 79 of file FN_multi_function_params.hh.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, blender::fn::MFParamType::ForVectorInput(), blender::fn::GVVectorArray::size(), and blender::fn::GVVectorArray::type().

◆ add_single_mutable()

void blender::fn::MFParamsBuilder::add_single_mutable ( GMutableSpan  ref,
StringRef  expected_name = "" 
)
inline

Definition at line 106 of file FN_multi_function_params.hh.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, blender::fn::MFParamType::ForMutableSingle(), blender::fn::GMutableSpan::size(), and blender::fn::GMutableSpan::type().

◆ add_uninitialized_single_output() [1/2]

void blender::fn::MFParamsBuilder::add_uninitialized_single_output ( GMutableSpan  ref,
StringRef  expected_name = "" 
)
inline

Definition at line 91 of file FN_multi_function_params.hh.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, blender::fn::MFParamType::ForSingleOutput(), blender::fn::GMutableSpan::size(), and blender::fn::GMutableSpan::type().

◆ add_uninitialized_single_output() [2/2]

template<typename T >
void blender::fn::MFParamsBuilder::add_uninitialized_single_output ( T *  value,
StringRef  expected_name = "" 
)
inline

Definition at line 86 of file FN_multi_function_params.hh.

◆ add_vector_mutable()

void blender::fn::MFParamsBuilder::add_vector_mutable ( GVectorArray &  vector_array,
StringRef  expected_name = "" 
)
inline

Definition at line 113 of file FN_multi_function_params.hh.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, blender::fn::MFParamType::ForMutableVector(), blender::fn::GVectorArray::size(), and blender::fn::GVectorArray::type().

◆ add_vector_output()

void blender::fn::MFParamsBuilder::add_vector_output ( GVectorArray &  vector_array,
StringRef  expected_name = "" 
)
inline

Definition at line 98 of file FN_multi_function_params.hh.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), BLI_assert, blender::fn::MFParamType::ForVectorOutput(), blender::fn::GVectorArray::size(), and blender::fn::GVectorArray::type().

◆ computed_array()

GMutableSpan blender::fn::MFParamsBuilder::computed_array ( int  param_index)
inline

Definition at line 121 of file FN_multi_function_params.hh.

References BLI_assert, and ELEM.

◆ computed_vector_array()

GVectorArray& blender::fn::MFParamsBuilder::computed_vector_array ( int  param_index)
inline

Definition at line 130 of file FN_multi_function_params.hh.

References BLI_assert, and ELEM.

◆ resource_scope()

ResourceScope& blender::fn::MFParamsBuilder::resource_scope ( )
inline

Definition at line 139 of file FN_multi_function_params.hh.

Friends And Related Function Documentation

◆ MFParams

friend class MFParams
friend

Definition at line 46 of file FN_multi_function_params.hh.

The documentation for this class was generated from the following files:
Generated on Tue Jan 31 2023 14:37:24 for Blender by  doxygen 1.9.1