pulp::host::SampleRegionParameterContract Class Reference

#include <sample_region_parameters.hpp>

Public Member Functions
	SampleRegionParameterContract ()=default
SampleRegionParameterContract	freeze (std::span< const state::ParamInfo > ordinary_parameters) const
bool	valid () const noexcept
bool	frozen () const noexcept
const std::string &	error () const noexcept
std::span< const SampleRegionParameterContractEntry >	entries () const noexcept
std::span< const state::ParamInfo >	promoted_parameters () const noexcept
std::span< const state::ParamInfo >	parameters () const noexcept
bool	matches_promoted (const SampleRegionParameterContract &other) const noexcept
std::unique_ptr< SampleRegionParameterBinding >	bind (state::StateStore &store) const

Static Public Member Functions
static SampleRegionParameterContract	from_regions (std::span< const SampleRegionDefinition > regions)

Friends
class	SampleRegionParameterBinding
class	SampleRegionParameterOwner

Constructor & Destructor Documentation

SampleRegionParameterContract()

pulp::host::SampleRegionParameterContract::SampleRegionParameterContract ( )

default

Member Function Documentation

bind()

std::unique_ptr< SampleRegionParameterBinding > pulp::host::SampleRegionParameterContract::bind

(

state::StateStore &

store

)

const

entries()

std::span< const SampleRegionParameterContractEntry > pulp::host::SampleRegionParameterContract::entries ( ) const

inlinenoexcept

error()

const std::string & pulp::host::SampleRegionParameterContract::error ( ) const

inlinenoexcept

freeze()

SampleRegionParameterContract pulp::host::SampleRegionParameterContract::freeze

(

std::span< const state::ParamInfo >

ordinary_parameters

)

const

from_regions()

SampleRegionParameterContract pulp::host::SampleRegionParameterContract::from_regions ( std::span< const SampleRegionDefinition > regions )

static

frozen()

bool pulp::host::SampleRegionParameterContract::frozen ( ) const

inlinenoexcept

matches_promoted()

bool pulp::host::SampleRegionParameterContract::matches_promoted ( const SampleRegionParameterContract & other ) const

noexcept

parameters()

std::span< const state::ParamInfo > pulp::host::SampleRegionParameterContract::parameters ( ) const

inlinenoexcept

promoted_parameters()

std::span< const state::ParamInfo > pulp::host::SampleRegionParameterContract::promoted_parameters ( ) const

inlinenoexcept

valid()

bool pulp::host::SampleRegionParameterContract::valid ( ) const

inlinenoexcept

Friends And Related Symbol Documentation

SampleRegionParameterBinding

friend class SampleRegionParameterBinding

friend

SampleRegionParameterOwner

friend class SampleRegionParameterOwner

friend

---

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

• /home/runner/work/pulp/pulp/core/host/include/pulp/host/sample_region_parameters.hpp