CInstanceScreensaver

Inherits IAddonInstance.

Public Member Functions
	CInstanceScreensaver ()
	Screensaver class constructor.
	CInstanceScreensaver (const IInstanceInfo &instance)
	Screensaver class constructor used to support multiple instance types.
kodi::HardwareContext	Device ()
	Device that represents the display adapter.
int	Height ()
	Returns the height of the rendering window.
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.
virtual void	Render ()
	Used to indicate when the add-on should render.
virtual bool	Start ()
	Used to notify the screensaver that it has been started.
virtual void	Stop ()
	Used to inform the screensaver that the rendering control was stopped.
int	Width ()
	Returns the width of the rendering window.
int	X ()
	Returns the X position of the rendering window.
int	Y ()
	Returns the Y position of the rendering window.
	~CInstanceScreensaver () override=default
	Destructor.
Public Member Functions inherited from IAddonInstance
bool	CheckInstanceSettingBoolean (const std::string &settingName, bool &settingValue)
template<typename enumType >
bool	CheckInstanceSettingEnum (const std::string &settingName, enumType &settingValue)
bool	CheckInstanceSettingFloat (const std::string &settingName, float &settingValue)
bool	CheckInstanceSettingInt (const std::string &settingName, int &settingValue)
bool	CheckInstanceSettingString (const std::string &settingName, std::string &settingValue)
virtual ADDON_STATUS	CreateInstance (const kodi::addon::IInstanceInfo &instance, KODI_ADDON_INSTANCE_HDL &hdl)
std::string	GetInstanceAPIVersion () const
bool	GetInstanceSettingBoolean (const std::string &settingName, bool defaultValue=false)
template<typename enumType >
enumType	GetInstanceSettingEnum (const std::string &settingName, enumType defaultValue=static_cast< enumType >(0))
float	GetInstanceSettingFloat (const std::string &settingName, float defaultValue=0.0f)
int	GetInstanceSettingInt (const std::string &settingName, int defaultValue=0)
std::string	GetInstanceSettingString (const std::string &settingName, const std::string &defaultValue="")
std::string	GetInstanceUserPath (const std::string &append="")
	IAddonInstance (const kodi::addon::IInstanceInfo &instance)
bool	IsInstanceSettingUsingDefault (const std::string &settingName)
virtual ADDON_STATUS	SetInstanceSetting (const std::string &settingName, const kodi::addon::CSettingValue &settingValue)
void	SetInstanceSettingBoolean (const std::string &settingName, bool settingValue)
template<typename enumType >
void	SetInstanceSettingEnum (const std::string &settingName, enumType settingValue)
void	SetInstanceSettingFloat (const std::string &settingName, float settingValue)
void	SetInstanceSettingInt (const std::string &settingName, int settingValue)
void	SetInstanceSettingString (const std::string &settingName, const std::string &settingValue)

---

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

• /github/workspace/xbmc/addons/kodi-dev-kit/include/kodi/addon-instance/Screensaver.h