pulp::format::FactoryProgramTable Class Reference

#include <factory_program_table.hpp>

Public Member Functions
void	build (state::StateStore &store, const std::string &manufacturer, const std::string &plugin_name, const std::filesystem::path &dir={})
	Scan dir (or the loaded module's bundle folder when dir is empty) and cache every readable preset's parameter values.
std::size_t	size () const noexcept
	Number of programs the host can select.
const std::string &	name_at (std::size_t index) const noexcept
	UTF-8 name of program index, or empty when out of range.
std::span< const state::ParamSetting >	values_at (std::size_t index) const noexcept
	The parameter values program index sets, or an empty span when out of range.

Member Function Documentation

build()

void pulp::format::FactoryProgramTable::build	(	state::StateStore &	store,
		const std::string &	manufacturer,
		const std::string &	plugin_name,
		const std::filesystem::path &	dir = {} )

Scan dir (or the loaded module's bundle folder when dir is empty) and cache every readable preset's parameter values.

A preset file that cannot be read is left out. Main thread only.

Must be called after the processor has defined its parameters: a preset is matched to parameters by name.

name_at()

const std::string & pulp::format::FactoryProgramTable::name_at ( std::size_t index ) const

noexcept

UTF-8 name of program index, or empty when out of range.

size()

std::size_t pulp::format::FactoryProgramTable::size ( ) const

inlinenoexcept

Number of programs the host can select.

values_at()

std::span< const state::ParamSetting > pulp::format::FactoryProgramTable::values_at ( std::size_t index ) const

noexcept

The parameter values program index sets, or an empty span when out of range.

Valid until the next build. Safe to read from any thread once build has returned.

---

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

• /home/runner/work/pulp/pulp/core/format/include/pulp/format/factory_program_table.hpp