Kodi Documentation 23.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CApplicationContentGeometry Class Reference

The content rectangle in force, resolved once for the OSD, subtitle placement and external controllers. More...

#include <ApplicationContentGeometry.h>

Inheritance diagram for CApplicationContentGeometry:
IApplicationComponent ISettingCallback

Classes

struct  RenderInputs
 Everything the render path reads, scalars only. More...
 

Public Member Functions

 CApplicationContentGeometry ()
 
void RefreshAtRest ()
 
void OnSettingChanged (const std::shared_ptr< const CSetting > &setting) override
 The value of the given setting has changed.
 
void SetFileInputs (const KODI::VIDEO::GEOMETRY::ContentGeometryLookup &cached)
 Take the stored inputs for the file that is opening, cached already verified against it.
 
void Refresh ()
 Resolve again against the stream that is playing now.
 
void SetLive (const CRectInt &rect, bool varies)
 Take a reading confirmed during playback, in coded space, and serve it.
 
void ClearLive ()
 Leaves the stored inputs to answer as they did before playback.
 
void SetOverrides (const KODI::VIDEO::GEOMETRY::GeometryOverrides &overrides)
 Take what an automation has stated for this playback, over the settings. Cleared as the next file opens.
 
void SetPendingOverrides (const KODI::VIDEO::GEOMETRY::GeometryOverrides &overrides)
 Arm overrides for the file that is about to open. SetFileInputs() promotes them.
 
void ClearPendingOverrides ()
 Disarm without disturbing the playback in progress.
 
KODI::VIDEO::GEOMETRY::GeometryOverrides GetOverrides () const
 
float RasterAspect () const
 The raster in force, the override before the setting. Zero means the display's own.
 
KODI::VIDEO::GEOMETRY::OsdPlacement OsdPlacementInForce () const
 Where the OSD is laid out, the override taking precedence over the setting.
 
void RefreshOsdPlacement ()
 Take the OSD placement setting. Call once the settings store is up; after that OnSettingChanged() keeps it current.
 
void SetDrawn (const KODI::VIDEO::GEOMETRY::DrawnGeometry &drawn)
 Take where the renderer has just drawn the picture, in screen pixels, or empty rectangles while nothing is drawn. Announced only when it moves.
 
KODI::VIDEO::GEOMETRY::DrawnGeometry Drawn () const
 Where the picture was last drawn, empty while nothing is on the screen.
 
void Clear ()
 Forget the file, leaving the answer describing the GUI rather than nothing.
 
KODI::VIDEO::GEOMETRY::EffectiveGeometry Get () const
 
RenderInputs GetRenderInputs () const
 
- Public Member Functions inherited from IApplicationComponent
virtual ~IApplicationComponent ()=default
 
- Public Member Functions inherited from ISettingCallback
virtual ~ISettingCallback ()=default
 
virtual bool OnSettingChanging (const std::shared_ptr< const CSetting > &setting)
 The value of the given setting is being changed.
 
virtual void OnSettingAction (const std::shared_ptr< const CSetting > &setting)
 The given setting has been activated.
 
virtual bool OnSettingUpdate (const std::shared_ptr< CSetting > &setting, const char *oldSettingId, const TiXmlNode *oldSettingNode)
 The given setting needs to be updated.
 
virtual void OnSettingPropertyChanged (const std::shared_ptr< const CSetting > &setting, const char *propertyName)
 The given property of the given setting has changed.
 

Detailed Description

The content rectangle in force, resolved once for the OSD, subtitle placement and external controllers.

Constructor & Destructor Documentation

◆ CApplicationContentGeometry()

CApplicationContentGeometry::CApplicationContentGeometry ( )
default

Member Function Documentation

◆ Clear()

void CApplicationContentGeometry::Clear ( )

Forget the file, leaving the answer describing the GUI rather than nothing.

◆ ClearLive()

void CApplicationContentGeometry::ClearLive ( )

Leaves the stored inputs to answer as they did before playback.

◆ ClearPendingOverrides()

void CApplicationContentGeometry::ClearPendingOverrides ( )

Disarm without disturbing the playback in progress.

◆ Drawn()

DrawnGeometry CApplicationContentGeometry::Drawn ( ) const

Where the picture was last drawn, empty while nothing is on the screen.

◆ Get()

EffectiveGeometry CApplicationContentGeometry::Get ( ) const

◆ GetOverrides()

GeometryOverrides CApplicationContentGeometry::GetOverrides ( ) const

◆ GetRenderInputs()

CApplicationContentGeometry::RenderInputs CApplicationContentGeometry::GetRenderInputs ( ) const

◆ OnSettingChanged()

void CApplicationContentGeometry::OnSettingChanged ( const std::shared_ptr< const CSetting > & setting)
overridevirtual

The value of the given setting has changed.

This callback is triggered whenever the value of a setting has been successfully changed (i.e. none of the OnSettingChanging() handlers) has reverted the change.

Parameters
settingThe setting whose value has been changed

Reimplemented from ISettingCallback.

◆ OsdPlacementInForce()

OsdPlacement CApplicationContentGeometry::OsdPlacementInForce ( ) const

Where the OSD is laid out, the override taking precedence over the setting.

◆ RasterAspect()

float CApplicationContentGeometry::RasterAspect ( ) const

The raster in force, the override before the setting. Zero means the display's own.

◆ Refresh()

void CApplicationContentGeometry::Refresh ( )

Resolve again against the stream that is playing now.

◆ RefreshAtRest()

void CApplicationContentGeometry::RefreshAtRest ( )

◆ RefreshOsdPlacement()

void CApplicationContentGeometry::RefreshOsdPlacement ( )

Take the OSD placement setting. Call once the settings store is up; after that OnSettingChanged() keeps it current.

◆ SetDrawn()

void CApplicationContentGeometry::SetDrawn ( const KODI::VIDEO::GEOMETRY::DrawnGeometry & drawn)

Take where the renderer has just drawn the picture, in screen pixels, or empty rectangles while nothing is drawn. Announced only when it moves.

◆ SetFileInputs()

void CApplicationContentGeometry::SetFileInputs ( const KODI::VIDEO::GEOMETRY::ContentGeometryLookup & cached)

Take the stored inputs for the file that is opening, cached already verified against it.

◆ SetLive()

void CApplicationContentGeometry::SetLive ( const CRectInt & rect,
bool varies )

Take a reading confirmed during playback, in coded space, and serve it.

◆ SetOverrides()

void CApplicationContentGeometry::SetOverrides ( const KODI::VIDEO::GEOMETRY::GeometryOverrides & overrides)

Take what an automation has stated for this playback, over the settings. Cleared as the next file opens.

◆ SetPendingOverrides()

void CApplicationContentGeometry::SetPendingOverrides ( const KODI::VIDEO::GEOMETRY::GeometryOverrides & overrides)

Arm overrides for the file that is about to open. SetFileInputs() promotes them.


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