libdcp
Public Member Functions | Private Attributes | List of all members
dcp::SubtitleImage Class Reference

A bitmap subtitle with all the associated attributes. More...

#include <subtitle_image.h>

Inheritance diagram for dcp::SubtitleImage:
dcp::Subtitle

Public Member Functions

 SubtitleImage (ArrayData png_image, Time in, Time out, float h_position, HAlign h_align, float v_position, VAlign v_align, Time fade_up_time, Time fade_down_time)
 
 SubtitleImage (ArrayData png_image, std::string id, Time in, Time out, float h_position, HAlign h_align, float v_position, VAlign v_align, Time fade_up_time, Time fade_down_time)
 
ArrayData png_image () const
 
void set_png_image (ArrayData png)
 
void read_png_file (boost::filesystem::path file)
 
void write_png_file (boost::filesystem::path file) const
 
std::string id () const
 
boost::optional< boost::filesystem::path > file () const
 
bool equals (std::shared_ptr< dcp::SubtitleImage > other, EqualityOptions options, NoteHandler note)
 
- Public Member Functions inherited from dcp::Subtitle
Time in () const
 
Time out () const
 
float h_position () const
 
HAlign h_align () const
 
float v_position () const
 
VAlign v_align () const
 
Time fade_up_time () const
 
Time fade_down_time () const
 
void set_in (Time i)
 
void set_out (Time o)
 
void set_h_position (float p)
 
void set_v_position (float p)
 
void set_fade_up_time (Time t)
 
void set_fade_down_time (Time t)
 

Private Attributes

ArrayData _png_image
 
std::string _id
 
boost::optional< boost::filesystem::path > _file
 

Additional Inherited Members

- Protected Member Functions inherited from dcp::Subtitle
 Subtitle (Time in, Time out, float h_position, HAlign h_align, float v_position, VAlign v_align, Time fade_up_time, Time fade_down_time)
 
- Protected Attributes inherited from dcp::Subtitle
Time _in
 
Time _out
 
float _h_position = 0
 
HAlign _h_align = HAlign::CENTER
 
float _v_position = 0
 
VAlign _v_align = VAlign::CENTER
 
Time _fade_up_time
 
Time _fade_down_time
 

Detailed Description

A bitmap subtitle with all the associated attributes.

Definition at line 58 of file subtitle_image.h.

Member Function Documentation

◆ file()

boost::optional<boost::filesystem::path> dcp::SubtitleImage::file ( ) const
inline
Returns
the most recent disk file used to read or write this asset, if there is one

Definition at line 102 of file subtitle_image.h.


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