Blender V4.3
blender::fn::lazy_function::Input Struct Reference

#include <FN_lazy_function.hh>

Public Member Functions

 Input (const char *debug_name, const CPPType &type, const ValueUsage usage=ValueUsage::Used)
 

Public Attributes

const char * debug_name
 
const CPPTypetype
 
ValueUsage usage
 

Detailed Description

Describes an input of a #LazyFunction.

Definition at line 227 of file FN_lazy_function.hh.

Constructor & Destructor Documentation

◆ Input()

blender::fn::lazy_function::Input::Input ( const char * debug_name,
const CPPType & type,
const ValueUsage usage = ValueUsage::Used )
inline

Definition at line 248 of file FN_lazy_function.hh.

Member Data Documentation

◆ debug_name

const char* blender::fn::lazy_function::Input::debug_name

Name used for debugging purposes. The string has to be static or has to be owned by something else.

Definition at line 232 of file FN_lazy_function.hh.

◆ type

const CPPType* blender::fn::lazy_function::Input::type

Data type of this input.

Definition at line 236 of file FN_lazy_function.hh.

◆ usage

ValueUsage blender::fn::lazy_function::Input::usage

Can be used to indicate a caller or this function if this input is used statically before executing it the first time. This is technically not needed but can improve efficiency because a round-trip through the execute method can be avoided.

When this is ValueUsage::Used, the caller has to ensure that the input is definitely available when the #execute method is first called. The #execute method does not have to check whether the value is actually available.

Definition at line 246 of file FN_lazy_function.hh.

Referenced by blender::fn::lazy_function::LazyFunction::always_used_inputs_available().


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