Kodi Development  20.0
for Binary and Script based Add-Ons
CInstanceScreensaver

Inherits 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...
 
kodi::HardwareContext Device ()
 Device that represents the display adapter. More...
 
int Height ()
 Returns the height of the rendering window. More...
 
std::string Name ()
 Used to get the name of the add-on defined in addon.xml. 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 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...
 
virtual void Render ()
 Used to indicate when the add-on should render. 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...
 
int Width ()
 Returns the width of the rendering window. More...
 
int X ()
 Returns the X position of the rendering window. More...
 
int Y ()
 Returns the Y position of the rendering window. More...
 
 ~CInstanceScreensaver () override=default
 Destructor. More...
 
- Public Member Functions inherited from IAddonInstance
virtual ADDON_STATUS CreateInstance (int instanceType, const std::string &instanceID, KODI_HANDLE instance, const std::string &version, KODI_HANDLE &addonInstance)
 
 IAddonInstance (ADDON_TYPE type, const std::string &version)
 

Additional Inherited Members

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

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