blender::SubFrame Struct Reference

#include <BLI_sub_frame.hh>

Public Member Functions
	SubFrame (const int frame=0, float subframe=0.0f)
	SubFrame (const float frame)
int	frame () const
float	subframe () const
	operator float () const
	operator double () const
uint64_t	hash () const

Static Public Member Functions
static SubFrame	min ()
static SubFrame	max ()

Friends
bool	operator< (const SubFrame &a, const SubFrame &b)
bool	operator<= (const SubFrame &a, const SubFrame &b)
bool	operator> (const SubFrame &a, const SubFrame &b)
bool	operator>= (const SubFrame &a, const SubFrame &b)

Detailed Description

Contains an integer frame number and a subframe float in the range [0, 1).

Definition at line 23 of file BLI_sub_frame.hh.

Constructor & Destructor Documentation

SubFrame() [1/2]

blender::SubFrame::SubFrame ( const int frame = 0, float subframe = 0.0f )

inline

Definition at line 29 of file BLI_sub_frame.hh.

References BLI_assert, frame(), and subframe().

Referenced by max(), min(), operator<, operator<=, operator>, operator>=, and SubFrame().

SubFrame() [2/2]

blender::SubFrame::SubFrame ( const float frame )

inline

Definition at line 35 of file BLI_sub_frame.hh.

References floorf, fractf, frame(), and SubFrame().

Member Function Documentation

frame()

int blender::SubFrame::frame ( ) const

inline

Definition at line 37 of file BLI_sub_frame.hh.

Referenced by blender::ed::object::bake_simulation::bake_geometry_nodes_startjob(), blender::ed::object::bake_simulation::simulate_to_frame_startjob(), SubFrame(), and SubFrame().

hash()

uint64_t blender::SubFrame::hash ( ) const

inline

Definition at line 67 of file BLI_sub_frame.hh.

References blender::get_default_hash().

max()

SubFrame blender::SubFrame::max ( )

inlinestatic

Definition at line 62 of file BLI_sub_frame.hh.

References INT32_MAX, and SubFrame().

min()

SubFrame blender::SubFrame::min ( )

inlinestatic

Definition at line 57 of file BLI_sub_frame.hh.

References INT32_MIN, and SubFrame().

operator double()

blender::SubFrame::operator double ( ) const

inlineexplicit

Definition at line 52 of file BLI_sub_frame.hh.

operator float()

blender::SubFrame::operator float ( ) const

inlineexplicit

Definition at line 47 of file BLI_sub_frame.hh.

References float.

subframe()

float blender::SubFrame::subframe ( ) const

inline

Definition at line 42 of file BLI_sub_frame.hh.

Referenced by blender::ed::object::bake_simulation::bake_geometry_nodes_startjob(), blender::ed::object::bake_simulation::simulate_to_frame_startjob(), and SubFrame().

Friends And Related Symbol Documentation

operator<

bool operator< ( const SubFrame & a, const SubFrame & b )

friend

Definition at line 74 of file BLI_sub_frame.hh.

References b, and SubFrame().

operator<=

bool operator<= ( const SubFrame & a, const SubFrame & b )

friend

Definition at line 79 of file BLI_sub_frame.hh.

References b, and SubFrame().

operator>

bool operator> ( const SubFrame & a, const SubFrame & b )

friend

Definition at line 84 of file BLI_sub_frame.hh.

References b, and SubFrame().

operator>=

bool operator>= ( const SubFrame & a, const SubFrame & b )

friend

Definition at line 89 of file BLI_sub_frame.hh.

References b, and SubFrame().

---

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

• BLI_sub_frame.hh