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

One decoded subtitle rectangle. More...

#include <StormByte/multimedia/display.hxx>

Collaboration diagram for StormByte::Multimedia::SubtitleRegion:

Public Member Functions

 SubtitleRegion ()=default
 Construct an empty rectangle.
 SubtitleRegion (const SubtitleRegion &other)=default
 Copy a rectangle.
 SubtitleRegion (SubtitleRegion &&other) noexcept=default
 Move a rectangle.
 ~SubtitleRegion () noexcept=default
 Release rectangle storage.
SubtitleRegion & operator= (const SubtitleRegion &other)=default
 Copy a rectangle.
SubtitleRegion & operator= (SubtitleRegion &&other) noexcept=default
 Move a rectangle.

Public Attributes

SubtitleContent m_content = SubtitleContent::Text
 Interpretation of this rectangle.
Safe::String m_text
 UTF-8 text or an ASS event.
Safe::Binary m_pixels
 RGBA8 bitmap, tightly packed.
int m_x = 0
 Canvas left.
int m_y = 0
 Canvas top.
int m_width = 0
 Bitmap width.
int m_height = 0
 Bitmap height.

Detailed Description

One decoded subtitle rectangle.

Constructor & Destructor Documentation

◆ SubtitleRegion() [1/3]

StormByte::Multimedia::SubtitleRegion::SubtitleRegion ( )
default

Construct an empty rectangle.

◆ SubtitleRegion() [2/3]

StormByte::Multimedia::SubtitleRegion::SubtitleRegion ( const SubtitleRegion & other)
default

Copy a rectangle.

Parameters
otherSource.

◆ SubtitleRegion() [3/3]

StormByte::Multimedia::SubtitleRegion::SubtitleRegion ( SubtitleRegion && other)
defaultnoexcept

Move a rectangle.

Parameters
otherSource.

◆ ~SubtitleRegion()

StormByte::Multimedia::SubtitleRegion::~SubtitleRegion ( )
defaultnoexcept

Release rectangle storage.

Member Function Documentation

◆ operator=() [1/2]

SubtitleRegion & StormByte::Multimedia::SubtitleRegion::operator= ( const SubtitleRegion & other)
default

Copy a rectangle.

Parameters
otherSource.
Returns
This rectangle.

◆ operator=() [2/2]

SubtitleRegion & StormByte::Multimedia::SubtitleRegion::operator= ( SubtitleRegion && other)
defaultnoexcept

Move a rectangle.

Parameters
otherSource.
Returns
This rectangle.

Member Data Documentation

◆ m_content

SubtitleContent StormByte::Multimedia::SubtitleRegion::m_content = SubtitleContent::Text

Interpretation of this rectangle.

◆ m_height

int StormByte::Multimedia::SubtitleRegion::m_height = 0

Bitmap height.

◆ m_pixels

Safe::Binary StormByte::Multimedia::SubtitleRegion::m_pixels

RGBA8 bitmap, tightly packed.

◆ m_text

Safe::String StormByte::Multimedia::SubtitleRegion::m_text

UTF-8 text or an ASS event.

◆ m_width

int StormByte::Multimedia::SubtitleRegion::m_width = 0

Bitmap width.

◆ m_x

int StormByte::Multimedia::SubtitleRegion::m_x = 0

Canvas left.

◆ m_y

int StormByte::Multimedia::SubtitleRegion::m_y = 0

Canvas top.


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