Kodi Docs 20.0
Kodi is an open source media player and entertainment hub.
kodi::addon::CInstanceScreensaver Class Reference

#include <Screensaver.h>

Inheritance diagram for kodi::addon::CInstanceScreensaver:
kodi::addon::IAddonInstance

Public Member Functions

 CInstanceScreensaver ()
 Screensaver class constructor. More...
 
 CInstanceScreensaver (KODI_HANDLE instance, const std::string &kodiVersion="")
 Screensaver class constructor used to support multiple instance types. More...
 
 ~CInstanceScreensaver () override=default
 Destructor. More...
 
virtual bool Start ()
 Used to notify the screensaver that it has been started. More...
 
virtual void Stop ()
 Used to inform the screensaver that the rendering control was stopped. More...
 
virtual void Render ()
 Used to indicate when the add-on should render. More...
 
kodi::HardwareContext Device ()
 Device that represents the display adapter. More...
 
int X ()
 Returns the X position of the rendering window. More...
 
int Y ()
 Returns the Y position of the rendering window. More...
 
int Width ()
 Returns the width of the rendering window. More...
 
int Height ()
 Returns the height of the rendering window. More...
 
float PixelRatio ()
 Pixel aspect ratio (often abbreviated PAR) is a ratio that describes how the width of a pixel compares to the height of that pixel. More...
 
std::string Name ()
 Used to get the name of the add-on defined in addon.xml. More...
 
std::string Presets ()
 Used to get the full path where the add-on is installed. More...
 
std::string Profile ()
 Used to get the full path to the add-on's user profile. More...
 
- Public Member Functions inherited from kodi::addon::IAddonInstance
 IAddonInstance (ADDON_TYPE type, const std::string &version)
 
virtual ~IAddonInstance ()=default
 
virtual ADDON_STATUS CreateInstance (int instanceType, const std::string &instanceID, KODI_HANDLE instance, const std::string &version, KODI_HANDLE &addonInstance)
 

Additional Inherited Members

- Public Attributes inherited from kodi::addon::IAddonInstance
const ADDON_TYPE m_type
 
const std::string m_kodiVersion
 
std::string m_id
 

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