Information functions

To get info about the device, display and several other parts
These are functions to query any values or to transfer them to Kodi. More...

Functions
void	kodi::addon::CInstanceVisualization::TransferPresets (const std::vector< std::string > &presets)
	To transfer available presets on addon. More...
kodi::HardwareContext	kodi::addon::CInstanceVisualization::Device ()
	Device that represents the display adapter. More...
int	kodi::addon::CInstanceVisualization::X ()
	Returns the X position of the rendering window. More...
int	kodi::addon::CInstanceVisualization::Y ()
	Returns the Y position of the rendering window. More...
int	kodi::addon::CInstanceVisualization::Width ()
	Returns the width of the rendering window. More...
int	kodi::addon::CInstanceVisualization::Height ()
	Returns the height of the rendering window. More...
float	kodi::addon::CInstanceVisualization::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::CInstanceVisualization::Name ()
	Used to get the name of the add-on defined in addon.xml. More...
std::string	kodi::addon::CInstanceVisualization::Presets ()
	Used to get the full path where the add-on is installed. More...
std::string	kodi::addon::CInstanceVisualization::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
These are functions to query any values or to transfer them to Kodi.

Function Documentation

Device()

kodi::HardwareContext kodi::addon::CInstanceVisualization::Device ( )

inline

Device that represents the display adapter.

Returns

A pointer to the used device with HardwareContext

Note

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

---

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::CInstanceVisualization::Height ( )

inline

Returns the height of the rendering window.

Returns

The height, in pixels

Name()

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

inline

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

Returns

The add-on name

PixelRatio()

float kodi::addon::CInstanceVisualization::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::CInstanceVisualization::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::CInstanceVisualization::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

TransferPresets()

void kodi::addon::CInstanceVisualization::TransferPresets ( const std::vector< std::string > &  presets )

inline

To transfer available presets on addon.

Used if GetPresets not possible to use, e.g. where available presets are only known during Start call.

Parameters

[in]

presets

List to store available presets.

Note

The function should only be called once, if possible

Width()

int kodi::addon::CInstanceVisualization::Width ( )

inline

Returns the width of the rendering window.

Returns

The width, in pixels

X()

int kodi::addon::CInstanceVisualization::X ( )

inline

Returns the X position of the rendering window.

Returns

The X position, in pixels

Y()

int kodi::addon::CInstanceVisualization::Y ( )

inline

Returns the Y position of the rendering window.

Returns

The Y position, in pixels