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

Public Member Functions

 Subtitles (Graphics::ManagedSurface *target)
 
void setBBox (const Common::Rect &bbox)
 
void setColor (byte r, byte g, byte b)
 
void drawSubtitle (uint32 timestamp)
 
void clearSubtitle () const override
 
- Public Member Functions inherited from Video::Subtitles
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

void drawSubtitleText (const Graphics::Font &font, const Common::U32String &text, int x, int y, int width) const override
 
void updateSubtitleOverlay () const override
 
- Protected Member Functions inherited from Video::Subtitles
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
 

Additional Inherited Members

- Public Types inherited from Video::Subtitles
enum  FontStyle : int { kFontStyleRegular = 0 , kFontStyleItalic }
 
- Protected Attributes inherited from Video::Subtitles
bool _loaded
 
const Common::Array< SubtitlePart > * _parts = nullptr
 
uint16 _splitPartCount = 0
 

Constructor & Destructor Documentation

◆ ~Subtitles()

PhoenixVR::Subtitles::~Subtitles ( )
overridevirtual

Reimplemented from Video::Subtitles.

Member Function Documentation

◆ clearSubtitle()

void PhoenixVR::Subtitles::clearSubtitle ( ) const
overridevirtual

Reimplemented from Video::Subtitles.

◆ drawSubtitleText()

void PhoenixVR::Subtitles::drawSubtitleText ( const Graphics::Font &  font,
const Common::U32String &  text,
int  x,
int  y,
int  width 
) const
overrideprotectedvirtual

Reimplemented from Video::Subtitles.

◆ updateSubtitleOverlay()

void PhoenixVR::Subtitles::updateSubtitleOverlay ( ) const
inlineoverrideprotectedvirtual

Reimplemented from Video::Subtitles.


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