pulp::timeline::Modulator Struct Reference

A track-owned generator of modulation signal. More...

#include <modulation.hpp>

Public Member Functions
bool	valid () const noexcept
	Returns whether id is a usable, non-sentinel document identity.
bool	operator== (const Modulator &) const =default

Public Attributes
ItemId	id
ModulatorKind	kind = ModulatorKind::Lfo
std::string	name

Detailed Description

A track-owned generator of modulation signal.

Identity and declared kind are the whole document contract. No modulator runtime ships yet; what must be right now is that a route authored against this identity survives to the phase that adds one.

Member Function Documentation

operator==()

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

default

valid()

bool pulp::timeline::Modulator::valid ( ) const

inlinenoexcept

Returns whether id is a usable, non-sentinel document identity.

Member Data Documentation

id

ItemId pulp::timeline::Modulator::id

kind

ModulatorKind pulp::timeline::Modulator::kind = ModulatorKind::Lfo

name

std::string pulp::timeline::Modulator::name

---

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

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