Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::format::PrepareResourceUsage Struct Reference

Processor-reported prepared resource usage estimate. More...

#include <prepare_resources.hpp>

Public Member Functions

std::size_t total_bytes () const noexcept

Public Attributes

std::size_t persistent_bytes = 0
std::size_t block_scratch_bytes = 0
int block_size = 0
int input_channels = 0
int output_channels = 0
int parameter_events = 0
int midi_events = 0
int voices = 0

Detailed Description

Processor-reported prepared resource usage estimate.

This is a preflight/accounting surface, not an allocator. Values should represent storage that will be allocated or reserved during prepare(), plus fixed per-block scratch required by process(). Hosts can compare this with PrepareResourceLimits before committing a large prepare.

Member Function Documentation

◆ total_bytes()

std::size_t pulp::format::PrepareResourceUsage::total_bytes ( ) const
inlinenoexcept

Member Data Documentation

◆ block_scratch_bytes

std::size_t pulp::format::PrepareResourceUsage::block_scratch_bytes = 0

◆ block_size

int pulp::format::PrepareResourceUsage::block_size = 0

◆ input_channels

int pulp::format::PrepareResourceUsage::input_channels = 0

◆ midi_events

int pulp::format::PrepareResourceUsage::midi_events = 0

◆ output_channels

int pulp::format::PrepareResourceUsage::output_channels = 0

◆ parameter_events

int pulp::format::PrepareResourceUsage::parameter_events = 0

◆ persistent_bytes

std::size_t pulp::format::PrepareResourceUsage::persistent_bytes = 0

◆ voices

int pulp::format::PrepareResourceUsage::voices = 0

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