ScummVM API documentation
Video::Subtitles Class Reference
Inheritance diagram for Video::Subtitles:
M4::M4Subtitles PhoenixVR::Subtitles

Public Types

enum  FontStyle : int { kFontStyleRegular = 0 , kFontStyleItalic }
 

Public Member Functions

void loadSRTFile (const Common::Path &fname)
 
void close ()
 
void setFont (const char *fontname, int height=18, FontStyle type=kFontStyleRegular)
 
void setBBox (const Common::Rect &bbox)
 
void setColor (byte r, byte g, byte b)
 
void setPadding (uint16 horizontal, uint16 vertical)
 
bool drawSubtitle (uint32 timestamp, bool force=false, bool showSFX=false) const
 
bool isSfx () const
 
bool isLoaded () const
 
virtual void clearSubtitle () const
 

Protected Member Functions

bool recalculateBoundingBox () const
 
void renderSubtitle () const
 
virtual void drawSubtitleText (const Graphics::Font &font, const Common::U32String &text, int x, int y, int width) const
 
void translateBBox (int16 dx, int16 dy) const
 
virtual void updateSubtitleOverlay () const
 
virtual bool shouldShowSubtitle () const
 

Protected Attributes

bool _loaded
 
const Common::Array< SubtitlePart > * _parts = nullptr
 
uint16 _splitPartCount = 0
 

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