Blender V5.3
blender::fn::GFieldRef Class Reference

#include <FN_field.hh>

Classes

struct  Value
struct  Input
struct  MultiFn

Public Types

using Variant = std::variant<Value, Input, MultiFn>

Public Member Functions

 GFieldRef (const GField &field)
const FieldInputsPtr & field_inputs () const
uint64_t hash () const

Inline Methods

template<typename T>
 GFieldRef (const Field< T > &field)
 GFieldRef (const FieldInput &field_input)
 GFieldRef (const FieldOperation &field_multi_fn, int output_i=0)
 GFieldRef (Variant variant)
const Variant & variant () const
const CPPType & cpp_type () const
static GFieldRef from_constant (const CPPType &type, const void *value)

Detailed Description

A version of GField that only references data from other fields but does not own any data itself. This allows it to be smaller and trivially copyable making it more efficient in some contexts. This is mainly used during field evaluation.

Definition at line 246 of file FN_field.hh.

Member Typedef Documentation

◆ Variant

Definition at line 260 of file FN_field.hh.

Constructor & Destructor Documentation

◆ GFieldRef() [1/5]

blender::fn::GFieldRef::GFieldRef ( const GField & field)

Create a reference to the given fields. The caller is responsible for making sure that the referenced data stays valid.

Definition at line 373 of file field.cc.

References blender::if(), T, and blender::v.

Referenced by from_constant(), and GFieldRef().

◆ GFieldRef() [2/5]

template<typename T>
blender::fn::GFieldRef::GFieldRef ( const Field< T > & field)
inline

Definition at line 674 of file FN_field.hh.

References GFieldRef().

◆ GFieldRef() [3/5]

blender::fn::GFieldRef::GFieldRef ( const FieldInput & field_input)
inlineexplicit

Definition at line 659 of file FN_field.hh.

◆ GFieldRef() [4/5]

blender::fn::GFieldRef::GFieldRef ( const FieldOperation & field_multi_fn,
int output_i = 0 )
inlineexplicit

Definition at line 661 of file FN_field.hh.

◆ GFieldRef() [5/5]

blender::fn::GFieldRef::GFieldRef ( Variant variant)
inlineexplicit

Definition at line 666 of file FN_field.hh.

References variant().

Member Function Documentation

◆ cpp_type()

const CPPType & blender::fn::GFieldRef::cpp_type ( ) const
inline

These are the same as the corresponding GField methods.

Definition at line 683 of file FN_field.hh.

References BLI_assert_unreachable_static_t, T, and blender::v.

Referenced by blender::fn::evaluate_fields().

◆ field_inputs()

const FieldInputsPtr & blender::fn::GFieldRef::field_inputs ( ) const

◆ from_constant()

GFieldRef blender::fn::GFieldRef::from_constant ( const CPPType & type,
const void * value )
inlinestatic

Definition at line 668 of file FN_field.hh.

References GFieldRef().

Referenced by blender::fn::FieldEvaluator::evaluate().

◆ hash()

uint64_t blender::fn::GFieldRef::hash ( ) const

Definition at line 456 of file field.cc.

References BLI_assert_unreachable_static_t, blender::get_default_hash(), hash(), T, and blender::v.

Referenced by hash().

◆ variant()


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