Detailed Description

General GUI related functions
This includes independent functions which can be used by different locations and called up independently.

Permits the use of the required functions of the add-on to Kodi.

These are pure functions them no other initialization need.

It has the header #include <kodi/gui/General.h> be included to enjoy it.

Enumeration Type Documentation

◆ AdjustRefreshRateStatus

enum AdjustRefreshRateStatus

Adjust refresh rate enum
Used to get the Adjust refresh rate status info.

Function Documentation

◆ Lock()

void ATTR_DLL_LOCAL Lock ( )

inline

Performs a graphical lock of rendering engine.

◆ Unlock()

void ATTR_DLL_LOCAL Unlock ( )

inline

Performs a graphical unlock of previous locked rendering engine.

◆ GetScreenHeight()

int ATTR_DLL_LOCAL GetScreenHeight ( )

inline

Return the the current screen height with pixel.

Returns: Screen height with pixel

◆ GetScreenWidth()

int ATTR_DLL_LOCAL GetScreenWidth ( )

inline

Return the the current screen width with pixel.

Returns: Screen width with pixel

◆ GetVideoResolution()

int ATTR_DLL_LOCAL GetVideoResolution ( )

inline

Return the the current screen rendering resolution.

Returns: Current screen rendering resolution

◆ GetCurrentWindowDialogId()

int ATTR_DLL_LOCAL GetCurrentWindowDialogId ( )

inline

Returns the id for the current 'active' dialog as an integer.

Returns: The currently active dialog Id

Example:

..
int wid = kodi::gui::GetCurrentWindowDialogId();
..

◆ GetCurrentWindowId()

int ATTR_DLL_LOCAL GetCurrentWindowId ( )

inline

Returns the id for the current 'active' window as an integer.

Returns: The currently active window Id

Example:

..
int wid = kodi::gui::GetCurrentWindowId();
..

◆ GetHWContext()

kodi::HardwareContext GetHWContext ( )

inline

To get hardware specific device context interface.

Returns: A pointer to the used device with kodi::HardwareContext

Warning: This function is only be supported under Windows, on all other OS it return nullptr!

Note: Returned Windows class pointer is ID3D11DeviceContext1.

Example:

#include <d3d11_1.h>
..
ID3D11DeviceContext1* context = static_cast<ID3D11DeviceContext1*>(kodi::gui::GetHWContext());
..

◆ GetAdjustRefreshRateStatus()

AdjustRefreshRateStatus ATTR_DLL_LOCAL GetAdjustRefreshRateStatus ( )

inline

Get Adjust refresh rate setting status.

Returns: The Adjust refresh rate setting status