Blender V5.0
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 199 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 220 of file FN_lazy_function.hh.

References debug_name, type, usage, and blender::fn::lazy_function::Used.

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 204 of file FN_lazy_function.hh.

Referenced by Input().

◆ type

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

Data type of this input.

Definition at line 208 of file FN_lazy_function.hh.

Referenced by Input().

◆ 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 218 of file FN_lazy_function.hh.

Referenced by blender::fn::lazy_function::LazyFunction::always_used_inputs_available(), and Input().


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