Kodi Docs 20.0
Kodi is an open source media player and entertainment hub.
CDVDOverlay Class Reference

#include <DVDOverlay.h>

Inheritance diagram for CDVDOverlay:
CDVDOverlayGroup CDVDOverlayImage CDVDOverlayLibass CDVDOverlaySpu CDVDOverlaySSA CDVDOverlayText

Public Member Functions

 CDVDOverlay (DVDOverlayType type)
 
 CDVDOverlay (const CDVDOverlay &src)
 
virtual ~CDVDOverlay ()
 
CDVDOverlayAcquire ()
 
int Release ()
 
bool IsOverlayType (DVDOverlayType type)
 
virtual CDVDOverlayClone ()
 
virtual void SetTextAlignEnabled (bool enable)
 
bool IsTextAlignEnabled ()
 
void SetOverlayContainerFlushable (bool isFlushable)
 
bool IsOverlayContainerFlushable ()
 
void SetForcedMargins (bool setForcedMargins)
 
bool IsForcedMargins ()
 

Static Public Member Functions

static void Release (CDVDOverlay *ov)
 

Public Attributes

double iPTSStartTime
 
double iPTSStopTime
 
bool bForced
 
bool replace
 
unsigned long m_textureid
 

Protected Attributes

DVDOverlayType m_type
 
bool m_enableTextAlign
 
bool m_overlayContainerFlushable
 
bool m_setForcedMargins
 

Constructor & Destructor Documentation

◆ CDVDOverlay() [1/2]

CDVDOverlay::CDVDOverlay ( DVDOverlayType  type)
inlineexplicit

◆ CDVDOverlay() [2/2]

CDVDOverlay::CDVDOverlay ( const CDVDOverlay src)
inline

◆ ~CDVDOverlay()

virtual CDVDOverlay::~CDVDOverlay ( )
inlinevirtual

Member Function Documentation

◆ Acquire()

CDVDOverlay * CDVDOverlay::Acquire ( )
inline

increase the reference counter by one.

◆ Clone()

virtual CDVDOverlay * CDVDOverlay::Clone ( )
inlinevirtual

return a copy to VideoPlayerSubtitle in order to have hw resources cleared after rendering

Reimplemented in CDVDOverlayImage, CDVDOverlaySSA, and CDVDOverlayText.

◆ IsForcedMargins()

bool CDVDOverlay::IsForcedMargins ( )
inline

◆ IsOverlayContainerFlushable()

bool CDVDOverlay::IsOverlayContainerFlushable ( )
inline

◆ IsOverlayType()

bool CDVDOverlay::IsOverlayType ( DVDOverlayType  type)
inline

◆ IsTextAlignEnabled()

bool CDVDOverlay::IsTextAlignEnabled ( )
inline

◆ Release() [1/2]

int CDVDOverlay::Release ( )
inline

decrease the reference counter by one.

◆ Release() [2/2]

static void CDVDOverlay::Release ( CDVDOverlay ov)
inlinestatic

static release function for use with shared ptr for example

◆ SetForcedMargins()

void CDVDOverlay::SetForcedMargins ( bool  setForcedMargins)
inline

◆ SetOverlayContainerFlushable()

void CDVDOverlay::SetOverlayContainerFlushable ( bool  isFlushable)
inline

◆ SetTextAlignEnabled()

virtual void CDVDOverlay::SetTextAlignEnabled ( bool  enable)
inlinevirtual

Reimplemented in CDVDOverlayText.

Member Data Documentation

◆ bForced

bool CDVDOverlay::bForced

◆ iPTSStartTime

double CDVDOverlay::iPTSStartTime

◆ iPTSStopTime

double CDVDOverlay::iPTSStopTime

◆ m_enableTextAlign

bool CDVDOverlay::m_enableTextAlign
protected

◆ m_overlayContainerFlushable

bool CDVDOverlay::m_overlayContainerFlushable
protected

◆ m_setForcedMargins

bool CDVDOverlay::m_setForcedMargins
protected

◆ m_textureid

unsigned long CDVDOverlay::m_textureid

◆ m_type

DVDOverlayType CDVDOverlay::m_type
protected

◆ replace

bool CDVDOverlay::replace

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