Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches

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.
 
kodi::HardwareContext kodi::addon::CInstanceVisualization::Device ()
 Device that represents the display adapter.
 
int kodi::addon::CInstanceVisualization::X ()
 Returns the X position of the rendering window.
 
int kodi::addon::CInstanceVisualization::Y ()
 Returns the Y position of the rendering window.
 
int kodi::addon::CInstanceVisualization::Width ()
 Returns the width of the rendering window.
 
int kodi::addon::CInstanceVisualization::Height ()
 Returns the height of the rendering window.
 
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.
 

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());
..
kodi::HardwareContext Device()
Device that represents the display adapter.
Definition kodi-dev-kit/include/kodi/addon-instance/visualization.h:717

◆ Height()

int kodi::addon::CInstanceVisualization::Height ( )
inline

Returns the height of the rendering window.

Returns
The height, in pixels

◆ 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

◆ 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]presetsList 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