pulp::timeline::FollowActionSet Struct Reference

Bounded weighted follow behavior attached to a slot. More...

#include <clip_launch.hpp>

Public Member Functions
constexpr std::span< const FollowAction >	active () const noexcept
	Returns the populated prefix of choices.
constexpr bool	enabled () const noexcept
	Returns whether this set has candidates, a positive period, and repetitions.
constexpr bool	operator== (const FollowActionSet &) const =default

Public Attributes
std::array< FollowAction, kMaxChoices >	choices {}
std::uint8_t	choice_count = 0
std::uint32_t	repetitions = 1
timebase::TickDuration	grid {0}

Static Public Attributes
static constexpr std::size_t	kMaxChoices = 4

Detailed Description

Bounded weighted follow behavior attached to a slot.

Stores up to kMaxChoices candidates, their period, and the number of periods before firing. A non-positive grid disables the timer. The duration is measured from launch and therefore has no shared-grid phase.

Member Function Documentation

active()

std::span< const FollowAction > pulp::timeline::FollowActionSet::active ( ) const

inlineconstexprnoexcept

Returns the populated prefix of choices.

An out-of-range choice_count is clamped rather than trusted.

enabled()

bool pulp::timeline::FollowActionSet::enabled ( ) const

inlineconstexprnoexcept

Returns whether this set has candidates, a positive period, and repetitions.

operator==()

bool pulp::timeline::FollowActionSet::operator== ( const FollowActionSet & ) const

constexprdefault

Member Data Documentation

choice_count

std::uint8_t pulp::timeline::FollowActionSet::choice_count = 0

choices

std::array<FollowAction, kMaxChoices> pulp::timeline::FollowActionSet::choices {}

grid

timebase::TickDuration pulp::timeline::FollowActionSet::grid {0}

kMaxChoices

std::size_t pulp::timeline::FollowActionSet::kMaxChoices = 4

staticconstexpr

repetitions

std::uint32_t pulp::timeline::FollowActionSet::repetitions = 1

---

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

• /home/runner/work/pulp/pulp/core/timeline/include/pulp/timeline/clip_launch.hpp