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

#include <FN_multi_function_params.hh>

Public Member Functions

 MFParamsBuilder (const class MultiFunction &fn, int64_t size)
 
 MFParamsBuilder (const class MultiFunction &fn, const IndexMask *mask)
 
template<typename T >
void add_readonly_single_input_value (T value, StringRef expected_name="")
 
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 (GPointer value, StringRef expected_name="")
 
void add_readonly_single_input (GVArray varray, StringRef expected_name="")
 
void add_readonly_vector_input (const GVectorArray &vector_array, StringRef expected_name="")
 
void add_readonly_vector_input (const GSpan single_vector, 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_ignored_single_output (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)
 
GVectorArraycomputed_vector_array (int param_index)
 
ResourceScoperesource_scope ()
 

Friends

class MFParams
 

Detailed Description

Definition at line 25 of file FN_multi_function_params.hh.

Constructor & Destructor Documentation

◆ MFParamsBuilder() [1/2]

blender::fn::MFParamsBuilder::MFParamsBuilder ( const class MultiFunction fn,
int64_t  size 
)

◆ MFParamsBuilder() [2/2]

blender::fn::MFParamsBuilder::MFParamsBuilder ( const class MultiFunction fn,
const IndexMask mask 
)

The indices referenced by the mask has to live longer than the params builder. This is because the it might have to destruct elements for all masked indices in the end.

Member Function Documentation

◆ add_ignored_single_output()

void blender::fn::MFParamsBuilder::add_ignored_single_output ( StringRef  expected_name = "")
inline

◆ add_readonly_single_input() [1/4]

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

◆ add_readonly_single_input() [2/4]

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

◆ add_readonly_single_input() [3/4]

void blender::fn::MFParamsBuilder::add_readonly_single_input ( GPointer  value,
StringRef  expected_name = "" 
)
inline

◆ add_readonly_single_input() [4/4]

void blender::fn::MFParamsBuilder::add_readonly_single_input ( GVArray  varray,
StringRef  expected_name = "" 
)
inline

◆ add_readonly_single_input_value()

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

◆ add_readonly_vector_input() [1/3]

void blender::fn::MFParamsBuilder::add_readonly_vector_input ( const GSpan  single_vector,
StringRef  expected_name = "" 
)
inline

◆ add_readonly_vector_input() [2/3]

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

◆ add_readonly_vector_input() [3/3]

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

◆ add_single_mutable()

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

◆ add_uninitialized_single_output() [1/2]

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

◆ 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 107 of file FN_multi_function_params.hh.

◆ add_vector_mutable()

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

◆ add_vector_output()

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

◆ computed_array()

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

◆ computed_vector_array()

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

◆ resource_scope()

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

Definition at line 171 of file FN_multi_function_params.hh.

Friends And Related Function Documentation

◆ MFParams

friend class MFParams
friend

Definition at line 39 of file FN_multi_function_params.hh.


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