blob: b5a63937749414d08dd927d90efdf851e76926af (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
#include "../AddonBase.h"
#include "definitions.h"
namespace kodi
{
namespace gui
{
//============================================================================
///
// \defgroup cpp_kodi_gui ::general
/// \addtogroup cpp_kodi_gui
/// @{
/// @brief **Allow use of binary classes and function to use on add-on's**
///
/// Permits the use of the required functions of the add-on to Kodi. This class
/// also contains some functions to the control.
///
/// These are pure functions them no other initialization need.
///
/// It has the header \ref kodi/gui/General.h "#include <kodi/gui/General.h>" be included
/// to enjoy it.
///
//==========================================================================
///
/// \ingroup cpp_kodi_gui
/// @brief Performs a graphical lock of rendering engine
///
inline void ATTRIBUTE_HIDDEN Lock()
{
using namespace ::kodi::addon;
CAddonBase::m_interface->toKodi->kodi_gui->general->lock();
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui
/// @brief Performs a graphical unlock of previous locked rendering engine
///
inline void ATTRIBUTE_HIDDEN Unlock()
{
using namespace ::kodi::addon;
CAddonBase::m_interface->toKodi->kodi_gui->general->unlock();
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui
/// @brief Return the the current screen height with pixel
///
inline int ATTRIBUTE_HIDDEN GetScreenHeight()
{
using namespace ::kodi::addon;
return CAddonBase::m_interface->toKodi->kodi_gui->general->get_screen_height(CAddonBase::m_interface->toKodi->kodiBase);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui
/// @brief Return the the current screen width with pixel
///
inline int ATTRIBUTE_HIDDEN GetScreenWidth()
{
using namespace ::kodi::addon;
return CAddonBase::m_interface->toKodi->kodi_gui->general->get_screen_width(CAddonBase::m_interface->toKodi->kodiBase);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui
/// @brief Return the the current screen rendering resolution
///
inline int ATTRIBUTE_HIDDEN GetVideoResolution()
{
using namespace ::kodi::addon;
return CAddonBase::m_interface->toKodi->kodi_gui->general->get_video_resolution(CAddonBase::m_interface->toKodi->kodiBase);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui
/// @brief Returns the id for the current 'active' dialog as an integer.
///
/// @return The currently active dialog Id
///
///
///-------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.cpp}
/// ..
/// int wid = kodi::gui::GetCurrentWindowDialogId();
/// ..
/// ~~~~~~~~~~~~~
///
inline int ATTRIBUTE_HIDDEN GetCurrentWindowDialogId()
{
using namespace ::kodi::addon;
return CAddonBase::m_interface->toKodi->kodi_gui->general->get_current_window_dialog_id(CAddonBase::m_interface->toKodi->kodiBase);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui
/// @brief Returns the id for the current 'active' window as an integer.
///
/// @return The currently active window Id
///
///
///-------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.cpp}
/// ..
/// int wid = kodi::gui::GetCurrentWindowId();
/// ..
/// ~~~~~~~~~~~~~
///
inline int ATTRIBUTE_HIDDEN GetCurrentWindowId()
{
using namespace ::kodi::addon;
return CAddonBase::m_interface->toKodi->kodi_gui->general->get_current_window_id(CAddonBase::m_interface->toKodi->kodiBase);
}
//--------------------------------------------------------------------------
//==========================================================================
///
/// \ingroup cpp_kodi_gui
/// \brief To get hardware specific device context interface
///
/// \return The currently active device context
///
/// \warning This function is only be supported under Windows, on all other
/// OS it return `nullptr`!
///
/// \note Returned Windows class pointer is `ID3D11DeviceContext1`.
///
///
///-------------------------------------------------------------------------
///
/// **Example:**
/// ~~~~~~~~~~~~~{.cpp}
/// #include <d3d11_1.h>
/// ..
/// ID3D11DeviceContext1* context = static_cast<ID3D11DeviceContext1*>(kodi::gui::GetHWContext());
/// ..
/// ~~~~~~~~~~~~~
///
inline void* GetHWContext()
{
using namespace ::kodi::addon;
return CAddonBase::m_interface->toKodi->kodi_gui->general->get_hw_context(CAddonBase::m_interface->toKodi->kodiBase);
}
//--------------------------------------------------------------------------
} /* namespace gui */
} /* namespace kodi */
|
