Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
OVERLAY::COverlay Class Referenceabstract

#include <OverlayRenderer.h>

Inheritance diagram for OVERLAY::COverlay:
OVERLAY::COverlayGlyphGL OVERLAY::COverlayGlyphGLES OVERLAY::COverlayImageDX OVERLAY::COverlayQuadsDX OVERLAY::COverlayTextureGL OVERLAY::COverlayTextureGLES

Public Types

enum  EType { TYPE_NONE , TYPE_TEXTURE }
 
enum  EAlign { ALIGN_SCREEN , ALIGN_SCREEN_AR , ALIGN_VIDEO , ALIGN_SUBTITLE }
 
enum  EPosition { POSITION_ABSOLUTE , POSITION_ABSOLUTE_SCREEN , POSITION_RELATIVE }
 

Public Member Functions

 COverlay ()
 
virtual ~COverlay ()
 
virtual void Render (SRenderState &state)=0
 

Static Public Member Functions

static std::shared_ptr< COverlayCreate (const CDVDOverlayImage &o, CRect &rSource)
 
static std::shared_ptr< COverlayCreate (const CDVDOverlaySpu &o)
 
static std::shared_ptr< COverlayCreate (ASS_Image *images, float width, float height)
 

Public Attributes

enum OVERLAY::COverlay::EType m_type
 
enum OVERLAY::COverlay::EAlign m_align
 
enum OVERLAY::COverlay::EPosition m_pos
 
float m_x {0}
 
float m_y {0}
 
float m_width {1.0f}
 
float m_height {1.0f}
 
float m_source_width {0}
 
float m_source_height {0}
 

Protected Member Functions

bool IsSquareResolution (float resRatio)
 Given the resolution ratio determines if it is a 4/3 resolution.
 

Member Enumeration Documentation

◆ EAlign

Enumerator
ALIGN_SCREEN 
ALIGN_SCREEN_AR 
ALIGN_VIDEO 
ALIGN_SUBTITLE 

◆ EPosition

Enumerator
POSITION_ABSOLUTE 
POSITION_ABSOLUTE_SCREEN 
POSITION_RELATIVE 

◆ EType

Enumerator
TYPE_NONE 
TYPE_TEXTURE 

Constructor & Destructor Documentation

◆ COverlay()

COverlay::COverlay ( )

◆ ~COverlay()

COverlay::~COverlay ( )
virtualdefault

Member Function Documentation

◆ Create() [1/3]

std::shared_ptr< COverlay > COverlay::Create ( ASS_Image * images,
float width,
float height )
static

◆ Create() [2/3]

std::shared_ptr< COverlay > COverlay::Create ( const CDVDOverlayImage & o,
CRect & rSource )
static

◆ Create() [3/3]

std::shared_ptr< COverlay > COverlay::Create ( const CDVDOverlaySpu & o)
static

◆ IsSquareResolution()

bool OVERLAY::COverlay::IsSquareResolution ( float resRatio)
inlineprotected

Given the resolution ratio determines if it is a 4/3 resolution.

Parameters
resRatioThe resolution ratio (the results of width / height)
Returns
True if the ratio refer to a 4/3 resolution, otherwise false

◆ Render()

Member Data Documentation

◆ m_align

enum OVERLAY::COverlay::EAlign OVERLAY::COverlay::m_align

◆ m_height

float OVERLAY::COverlay::m_height {1.0f}

◆ m_pos

enum OVERLAY::COverlay::EPosition OVERLAY::COverlay::m_pos

◆ m_source_height

float OVERLAY::COverlay::m_source_height {0}

◆ m_source_width

float OVERLAY::COverlay::m_source_width {0}

◆ m_type

enum OVERLAY::COverlay::EType OVERLAY::COverlay::m_type

◆ m_width

float OVERLAY::COverlay::m_width {1.0f}

◆ m_x

float OVERLAY::COverlay::m_x {0}

◆ m_y

float OVERLAY::COverlay::m_y {0}

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