Donner SVG 0.8.0
0.8.0 ยท ebf353960.8.0 main
SVG editor and embeddable C⁠+⁠+⁠20 engine.
Loading...
Searching...
No Matches
donner::svg::components::ComputedFilterResourceBudget Class Reference

Owns computed-filter structural reservations and shared raster payload admission. More...

#include "donner/svg/components/filter/ComputedFilterResourceBudget.h"

Classes

struct  Limits
 Per-document computed-filter memory ceiling. More...

Public Member Functions

 ComputedFilterResourceBudget (std::shared_ptr< DocumentResourceFamilyBudget > family=nullptr)
 Create a budget with the default local limit and optional shared family budget.
 ComputedFilterResourceBudget (std::shared_ptr< DocumentResourceFamilyBudget > family, Limits limits)
 Create a budget with a caller-selected local limit and optional shared family budget.
 ComputedFilterResourceBudget (const ComputedFilterResourceBudget &)=delete
ComputedFilterResourceBudget & operator= (const ComputedFilterResourceBudget &)=delete
 ComputedFilterResourceBudget (ComputedFilterResourceBudget &&other) noexcept
 Transfer reservations and accounting without releasing the family's retained bytes.
ComputedFilterResourceBudget & operator= (ComputedFilterResourceBudget &&)=delete
bool reserve (Entity entity, std::size_t bytes)
 Set the structural reservation for one entity; a smaller value releases the difference.
void release (Entity entity)
 Release an entity's structural reservation and prune expired shared image entries.
std::shared_ptr< const std::vector< std::uint8_t > > shareImage (Entity sourceEntity, std::uint64_t sourceRevision, const std::vector< std::uint8_t > &sourcePixels)
 Return one immutable copy of a loaded image, shared by every graph using the same source.
std::shared_ptr< const std::vector< std::uint8_t > > adoptImage (std::vector< std::uint8_t > &&sourcePixels)
 Adopt a transient renderer-produced image after reserving its full retained lifetime.
std::size_t retainedBytes () const
 Current structural bytes plus live shared image bytes retained by this budget.
std::size_t sharedImageMaterializations () const
 Number of shared image payloads materialized through this budget.
std::size_t sharedImageComparedBytes () const
 Reserved diagnostic counter for shared-image byte comparisons; currently remains zero.
bool rejected () const
 Whether an admission exceeded a local or shared resource limit.
const Limits & limits () const
 Configured local retained-byte limit.

Static Public Attributes

static constexpr std::size_t kMaximumBytes = 16 * 1024 * 1024
 Default ceiling for retained computed-filter structures and shared image pixels.

Detailed Description

Owns computed-filter structural reservations and shared raster payload admission.


Class Documentation

◆ donner::svg::components::ComputedFilterResourceBudget::Limits

struct donner::svg::components::ComputedFilterResourceBudget::Limits

Per-document computed-filter memory ceiling.

Class Members
size_t maximumBytes = kMaximumBytes Maximum retained bytes across structural reservations and live shared images.

Constructor & Destructor Documentation

◆ ComputedFilterResourceBudget() [1/3]

donner::svg::components::ComputedFilterResourceBudget::ComputedFilterResourceBudget ( std::shared_ptr< DocumentResourceFamilyBudget > family = nullptr)
inlineexplicit

Create a budget with the default local limit and optional shared family budget.

Parameters
familyShared document resource budget, or null for local accounting only.

◆ ComputedFilterResourceBudget() [2/3]

donner::svg::components::ComputedFilterResourceBudget::ComputedFilterResourceBudget ( std::shared_ptr< DocumentResourceFamilyBudget > family,
Limits limits )
inline

Create a budget with a caller-selected local limit and optional shared family budget.

Parameters
familyShared document resource budget, or null for local accounting only.
limitsLocal retained-byte limit.

◆ ComputedFilterResourceBudget() [3/3]

donner::svg::components::ComputedFilterResourceBudget::ComputedFilterResourceBudget ( ComputedFilterResourceBudget && other)
inlinenoexcept

Transfer reservations and accounting without releasing the family's retained bytes.

Parameters
otherBudget whose reservations are moved into this object.

Member Function Documentation

◆ adoptImage()

std::shared_ptr< const std::vector< std::uint8_t > > donner::svg::components::ComputedFilterResourceBudget::adoptImage ( std::vector< std::uint8_t > && sourcePixels)
inline

Adopt a transient renderer-produced image after reserving its full retained lifetime.

Parameters
sourcePixelsTightly packed straight-alpha RGBA pixels.
Returns
Shared immutable pixels, or null when admission fails.

◆ release()

void donner::svg::components::ComputedFilterResourceBudget::release ( Entity entity)
inline

Release an entity's structural reservation and prune expired shared image entries.

Parameters
entityOwner whose structural reservation is removed.

◆ reserve()

bool donner::svg::components::ComputedFilterResourceBudget::reserve ( Entity entity,
std::size_t bytes )
inline

Set the structural reservation for one entity; a smaller value releases the difference.

Parameters
entityOwner of the computed filter structure.
bytesNew retained structural-byte reservation for this entity.
Returns
False if an increase exceeds either the local or shared family limit.

◆ shareImage()

std::shared_ptr< const std::vector< std::uint8_t > > donner::svg::components::ComputedFilterResourceBudget::shareImage ( Entity sourceEntity,
std::uint64_t sourceRevision,
const std::vector< std::uint8_t > & sourcePixels )
inline

Return one immutable copy of a loaded image, shared by every graph using the same source.

The family reservation is captured by the allocation's deleter, so accounting remains live until the final computed graph or render snapshot releases the pixels.

Parameters
sourceEntityEntity that owns the decoded image.
sourceRevisionMonotonic identity of the decoded image payload.
sourcePixelsDecoded straight-alpha RGBA pixels.
Returns
Shared immutable pixels, or null when admission fails.

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