Information functions

To get info about the device, display and several other parts More...

Functions
kodi::HardwareContext	kodi::addon::CInstanceScreensaver::Device ()
	Device that represents the display adapter. More...
int	kodi::addon::CInstanceScreensaver::X ()
	Returns the X position of the rendering window. More...
int	kodi::addon::CInstanceScreensaver::Y ()
	Returns the Y position of the rendering window. More...
int	kodi::addon::CInstanceScreensaver::Width ()
	Returns the width of the rendering window. More...
int	kodi::addon::CInstanceScreensaver::Height ()
	Returns the height of the rendering window. More...
float	kodi::addon::CInstanceScreensaver::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	kodi::addon::CInstanceScreensaver::Name ()
	Used to get the name of the add-on defined in addon.xml. More...
std::string	kodi::addon::CInstanceScreensaver::Presets ()
	Used to get the full path where the add-on is installed. More...
std::string	kodi::addon::CInstanceScreensaver::Profile ()
	Used to get the full path to the add-on's user profile. More...

Detailed Description

To get info about the device, display and several other parts

Function Documentation

Device()

kodi::HardwareContext kodi::addon::CInstanceScreensaver::Device ( )

inline

Device that represents the display adapter.

Returns

A pointer to the device

Note

This is only available on DirectX, It us unused (nullptr) on OpenGL

This value can also be becomed by kodi::gui::GetHWContext() and is recommended to use.

---

Example:

#include <d3d11_1.h>
..
// Note: Device() there is used inside addon child class about
// kodi::addon::CInstanceVisualization
ID3D11DeviceContext1* context = static_cast<ID3D11DeviceContext1*>(kodi::addon::CInstanceVisualization::Device());
..

Height()

int kodi::addon::CInstanceScreensaver::Height ( )

inline

Returns the height of the rendering window.

Returns

The height, in pixels

Name()

std::string kodi::addon::CInstanceScreensaver::Name ( )

inline

Used to get the name of the add-on defined in addon.xml.

Returns

The add-on name

PixelRatio()

float kodi::addon::CInstanceScreensaver::PixelRatio ( )

inline

Pixel aspect ratio (often abbreviated PAR) is a ratio that describes how the width of a pixel compares to the height of that pixel.

Returns

The pixel aspect ratio used by the display

Presets()

std::string kodi::addon::CInstanceScreensaver::Presets ( )

inline

Used to get the full path where the add-on is installed.

Returns

The add-on installation path

Profile()

std::string kodi::addon::CInstanceScreensaver::Profile ( )

inline

Used to get the full path to the add-on's user profile.

Note

The trailing folder (consisting of the add-on's ID) is not created by default. If it is needed, you must call kodi::vfs::CreateDirectory() to create the folder.

Returns

Path to the user profile

Width()

int kodi::addon::CInstanceScreensaver::Width ( )

inline

Returns the width of the rendering window.

Returns

The width, in pixels

X()

int kodi::addon::CInstanceScreensaver::X ( )

inline

Returns the X position of the rendering window.

Returns

The X position, in pixels

Y()

int kodi::addon::CInstanceScreensaver::Y ( )

inline

Returns the Y position of the rendering window.

Returns

The Y position, in pixels