StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::Pipeline::QueueLimit Class Reference

Automatic, explicitly bounded, or unlimited queue element cap. More...

#include <StormByte/multimedia/pipeline/buffering.hxx>

Public Types

enum class  Mode : std::uint8_t { Automatic , Unlimited , Bounded }

Public Member Functions

constexpr QueueLimit () noexcept=default
constexpr Mode GetMode () const noexcept
constexpr StormByte::Size Value () const noexcept
constexpr bool Valid (StormByte::Size minimum) const noexcept
constexpr StormByte::Size Resolve (StormByte::Size automatic) const noexcept

Static Public Member Functions

static constexpr QueueLimit Automatic () noexcept
static constexpr QueueLimit Unlimited () noexcept
static constexpr QueueLimit Bounded (StormByte::Size value) noexcept

Detailed Description

Automatic, explicitly bounded, or unlimited queue element cap.

A bounded value of zero is invalid. Zero is never overloaded to mean automatic or unlimited.

Member Enumeration Documentation

◆ Mode

enum class StormByte::Multimedia::Pipeline::QueueLimit::Mode : std::uint8_t
strong
Enumerator
Automatic 
Unlimited 
Bounded 

Constructor & Destructor Documentation

◆ QueueLimit()

StormByte::Multimedia::Pipeline::QueueLimit::QueueLimit ( )
constexprdefaultnoexcept

Member Function Documentation

◆ Automatic()

constexpr QueueLimit StormByte::Multimedia::Pipeline::QueueLimit::Automatic ( )
inlinestaticconstexprnoexcept

◆ Bounded()

constexpr QueueLimit StormByte::Multimedia::Pipeline::QueueLimit::Bounded ( StormByte::Size value)
inlinestaticconstexprnoexcept

◆ GetMode()

Mode StormByte::Multimedia::Pipeline::QueueLimit::GetMode ( ) const
inlineconstexprnoexcept

◆ Resolve()

StormByte::Size StormByte::Multimedia::Pipeline::QueueLimit::Resolve ( StormByte::Size automatic) const
inlineconstexprnoexcept

◆ Unlimited()

constexpr QueueLimit StormByte::Multimedia::Pipeline::QueueLimit::Unlimited ( )
inlinestaticconstexprnoexcept

◆ Valid()

bool StormByte::Multimedia::Pipeline::QueueLimit::Valid ( StormByte::Size minimum) const
inlineconstexprnoexcept

◆ Value()

StormByte::Size StormByte::Multimedia::Pipeline::QueueLimit::Value ( ) const
inlineconstexprnoexcept

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