StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::Property::Resolution Class Referencefinal

Frame width and height. More...

#include <StormByte/multimedia/property/resolution.hxx>

Public Member Functions

 Resolution () noexcept=default
 Constructs a zero-sized resolution for Safe value storage.
 Resolution (std::uint32_t width, std::uint32_t height) noexcept
 Constructs a resolution.
 Resolution (const Resolution &)=default
 Copy constructor.
 Resolution (Resolution &&) noexcept=default
 Move constructor.
 ~Resolution () noexcept=default
 Destructor.
Resolution & operator= (const Resolution &)=default
 Copy assignment.
Resolution & operator= (Resolution &&) noexcept=default
 Move assignment.
std::uint32_t Width () const noexcept
 Width in pixels.
std::uint32_t Height () const noexcept
 Height in pixels.
StormByte::Safe::String Name () const
 "WIDTHxHEIGHT" string.
StormByte::Safe::String StandardName () const
 Coarse label (e.g.

Detailed Description

Frame width and height.

Constructor & Destructor Documentation

◆ Resolution() [1/4]

StormByte::Multimedia::Property::Resolution::Resolution ( )
defaultnoexcept

Constructs a zero-sized resolution for Safe value storage.

◆ Resolution() [2/4]

StormByte::Multimedia::Property::Resolution::Resolution ( std::uint32_t width,
std::uint32_t height )
noexcept

Constructs a resolution.

Parameters
widthWidth in pixels.
heightHeight in pixels.

◆ Resolution() [3/4]

StormByte::Multimedia::Property::Resolution::Resolution ( const Resolution & )
default

Copy constructor.

◆ Resolution() [4/4]

StormByte::Multimedia::Property::Resolution::Resolution ( Resolution && )
defaultnoexcept

Move constructor.

◆ ~Resolution()

StormByte::Multimedia::Property::Resolution::~Resolution ( )
defaultnoexcept

Destructor.

Member Function Documentation

◆ Height()

std::uint32_t StormByte::Multimedia::Property::Resolution::Height ( ) const
noexcept

Height in pixels.

Returns
Height.

◆ Name()

StormByte::Safe::String StormByte::Multimedia::Property::Resolution::Name ( ) const

"WIDTHxHEIGHT" string.

Returns
Size string.
Exceptions
StormByte::ExceptionIf Base-owned text cannot be allocated.
std::bad_allocIf temporary formatting storage cannot be allocated.

◆ operator=() [1/2]

Resolution & StormByte::Multimedia::Property::Resolution::operator= ( const Resolution & )
default

Copy assignment.

Returns
*this.

◆ operator=() [2/2]

Resolution & StormByte::Multimedia::Property::Resolution::operator= ( Resolution && )
defaultnoexcept

Move assignment.

Returns
*this.

◆ StandardName()

StormByte::Safe::String StormByte::Multimedia::Property::Resolution::StandardName ( ) const

Coarse label (e.g.

"1080p", "4K").

Returns
Standard name.
Exceptions
StormByte::ExceptionIf Base-owned text cannot be allocated.

◆ Width()

std::uint32_t StormByte::Multimedia::Property::Resolution::Width ( ) const
noexcept

Width in pixels.

Returns
Width.

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