KODI::GAME Namespace Reference

Classes
class	CAgentController
	Class to represent the controller of a game player (a.k.a. agent) More...
class	CAgentInput
	Class to manage game-playing agents for a running game client. More...
class	CAgentJoystick
	Handles game controller events for game agent functionality. More...
class	CAgentKeyboard
	Handles keyboard events for game agent functionality. More...
class	CAgentMouse
	Handles mouse events for game agent functionality. More...
class	CController
class	CControllerActivity
	Class to hold state about the current activity of a controller. More...
class	CControllerGrid
	Class to encapsulate grid operations. More...
class	CControllerHub
	A branch in the controller tree. More...
class	CControllerInstaller
class	CControllerLayout
class	CControllerManager
class	CControllerNode
	Node in the controller tree. More...
class	CControllerSelect
class	CControllerState
	Stores the input state of a controller. More...
class	CControllerTranslator
class	CDefaultButtonMap
	A fallback buttonmap to be used with the default keyboard profile. More...
class	CDefaultController
class	CDefaultKeyboardTranslator
class	CDefaultMouseTranslator
class	CDialogGameAdvancedSettings
class	CDialogGameOSD
class	CDialogGameOSDHelp
class	CDialogGameSaves
class	CDialogGameStretchMode
class	CDialogGameVideoFilter
class	CDialogGameVideoRotation
class	CDialogGameVideoSelect
class	CDialogGameVolume
class	CDialogInGameSaves
class	CGameClient
	Interface between Kodi and Game add-ons. More...
class	CGameClientCheevos
class	CGameClientController
	A container for the layout of a controller connected to a game client input port. More...
class	CGameClientDevice
	Represents a device connected to a port. More...
class	CGameClientHardware
	Handles events for hardware such as reset buttons. More...
class	CGameClientInGameSaves
	This class implements in-game saves. More...
class	CGameClientInput
class	CGameClientJoystick
	Handles game controller events for games. More...
class	CGameClientKeyboard
	Handles keyboard events for games. More...
class	CGameClientMouse
	Handles mouse events for games. More...
class	CGameClientPort
	Represents a port that devices can connect to. More...
class	CGameClientProperties
	C++ wrapper for properties to pass to the DLL. More...
class	CGameClientStreamAudio
class	CGameClientStreamHwFramebuffer
class	CGameClientStreams
class	CGameClientStreamSwFramebuffer
class	CGameClientStreamVideo
class	CGameClientStruct
	Helper class to have "C" struct created before other parts becomes his pointer. More...
class	CGameClientSubsystem
	Base class for game client subsystems. More...
class	CGameClientTopology
class	CGameClientTranslator
	Translates data types from Game API to the corresponding format in Kodi. More...
class	CGameInfoTag
class	CGameServices
class	CGameSettings
class	CGameUtils
	Game related utilities. More...
class	CGUIActivePortList
class	CGUIAgentControllerList
class	CGUIAgentWindow
class	CGUICardinalFeatureButton
class	CGUIConfigurationWizard
class	CGUIControllerButton
class	CGUIControllerList
class	CGUIControllerWindow
class	CGUIDialogAxisDetection
class	CGUIDialogButtonCapture
class	CGUIDialogIgnoreInput
class	CGUIDialogSelectGameClient
class	CGUIDialogSelectSavestate
class	CGUIFeatureButton
class	CGUIFeatureFactory
class	CGUIFeatureGroupTitle
class	CGUIFeatureList
class	CGUIFeatureSeparator
class	CGUIFeatureTranslator
class	CGUIGameController
class	CGUIGameControllerList
class	CGUIGameControllerProvider
	Controller list provider for the IAgentList control in the Player Viewer (GameAgents) window. More...
class	CGUIPortList
class	CGUIPortWindow
class	CGUIScalarFeatureButton
class	CGUISelectKeyButton
class	CGUIThrottleButton
class	CGUIViewStateWindowGames
class	CGUIWheelButton
class	CGUIWindowGames
class	CInputSink
struct	ControllerColumn
	Column of controllers in the grid. More...
struct	ControllerVertex
	Vertex in the grid of controllers. More...
class	CPhysicalFeature
class	CPhysicalPort
class	CPhysicalTopology
	Represents the physical topology of controller add-ons. More...
class	CPortInput
class	CPortManager
class	CPortNode
	Collection of nodes that can be connected to this port. More...
struct	GameClientSubsystems
class	IActivePortList
	A list populated by input ports on a game console. More...
class	IAgentControllerList
	A list populated by the controllers of game-playing agents (CGameAgent) More...
class	IConfigurationWizard
	A wizard to direct user input. More...
class	IControllerList
	A list populated by installed controllers for the controller configuration window. More...
class	IFeatureButton
	A GUI button in a feature list (IFeatureList) More...
class	IFeatureList
	A list populated by the controller's features. More...
class	IGameClientStream
class	IGameInputCallback
	Input callbacks. More...
class	IHwFramebufferCallback
class	IPortList
	A list populated by controller ports for the port setup window. More...

Typedefs
using	ControllerPtr = std::shared_ptr<CController>
	Smart pointer to a game controller (CController)
using	ControllerVector = std::vector<ControllerPtr>
	Vector of smart pointers to a game controller (CController)
using	CGUIAnalogStickButton = CGUICardinalFeatureButton
using	CGUIRelativePointerButton = CGUICardinalFeatureButton
using	ControllerGrid = std::vector<ControllerColumn>
	Collection of controllers in a grid layout.
using	ControllerNodeVec = std::vector<CControllerNode>
using	CControllerTree = CControllerHub
	Collection of ports on a console.
using	GameClientPtr = std::shared_ptr<CGameClient>
	Smart pointer to a game client (CGameClient)
using	GameClientVector = std::vector<GameClientPtr>
	Vector of smart pointers to a game client (CGameClient)
using	GameClientPortPtr = std::unique_ptr<CGameClientPort>
	Smart pointer to an input port for a game client (CGameClientPort)
using	GameClientPortVec = std::vector<GameClientPortPtr>
	Vector of smart pointers to input ports for a game client (CGameClientPort)
using	GameClientDevicePtr = std::unique_ptr<CGameClientDevice>
	Smart pointer to an input device for a game client (CGameClientDevice)
using	GameClientDeviceVec = std::vector<GameClientDevicePtr>
	Vector of smart pointers to input devices for a game client (CGameClientDevice)
using	GameAgentPtr = std::shared_ptr<CGameAgent>
	Smart pointer to a game-playing agent (CGameAgent)
using	GameAgentVec = std::vector<GameAgentPtr>
	Vector of smart pointers to game-playing agents (CGameAgent)
using	PortVec = std::vector<CPortNode>
	Collection of port nodes.

Enumerations
enum class	PORT_TYPE { PORT_TYPE::UNKNOWN , PORT_TYPE::KEYBOARD , PORT_TYPE::MOUSE , PORT_TYPE::CONTROLLER }
	Type of input provided by a hardware or controller port. More...
enum class	BUTTON_TYPE {   BUTTON_TYPE::UNKNOWN , BUTTON_TYPE::BUTTON , BUTTON_TYPE::ANALOG_STICK , BUTTON_TYPE::RELATIVE_POINTER ,   BUTTON_TYPE::WHEEL , BUTTON_TYPE::THROTTLE , BUTTON_TYPE::SELECT_KEY }
	Types of button controls that can populate the feature list. More...
enum class	FEATURE_TYPE
	Types of features used in the joystick library. More...

Variables
constexpr const char *	DEFAULT_CONTROLLER_ID = "game.controller.default"
constexpr const char *	DEFAULT_KEYBOARD_ID = "game.controller.keyboard"
constexpr const char *	DEFAULT_MOUSE_ID = "game.controller.mouse"
constexpr const char *	DEFAULT_REMOTE_ID = "game.controller.remote"
constexpr const char *	CONTROLLER_ID_PLAYSTATION = "game.controller.ps.dualanalog"
constexpr auto	GAME_CLIENT_RESOURCES_DIRECTORY = "resources"
	Name of the resources directory for game clients.

Typedef Documentation

CGUIAnalogStickButton

using KODI::GAME::CGUIAnalogStickButton = CGUICardinalFeatureButton

CGUIRelativePointerButton

using KODI::GAME::CGUIRelativePointerButton = CGUICardinalFeatureButton

ControllerNodeVec

using KODI::GAME::ControllerNodeVec = std::vector<CControllerNode>

PortVec

using KODI::GAME::PortVec = std::vector<CPortNode>

Collection of port nodes.

Enumeration Type Documentation

FEATURE_TYPE

enum class KODI::JOYSTICK::FEATURE_TYPE

strong

Types of features used in the joystick library.

Available types:

1) scalar[*] 2) analog stick 3) accelerometer 4) rumble motor 5) relative pointer 6) absolute pointer 7) wheel 8) throttle 9) keyboard key

[*] All three driver primitives (buttons, hats and axes) have a state that can be represented using a single scalar value. For this reason, features that map to a single primitive are called "scalar features".

Variable Documentation

CONTROLLER_ID_PLAYSTATION

const char* KODI::GAME::CONTROLLER_ID_PLAYSTATION = "game.controller.ps.dualanalog"

constexpr

DEFAULT_CONTROLLER_ID

const char* KODI::GAME::DEFAULT_CONTROLLER_ID = "game.controller.default"

constexpr

DEFAULT_KEYBOARD_ID

const char* KODI::GAME::DEFAULT_KEYBOARD_ID = "game.controller.keyboard"

constexpr

DEFAULT_MOUSE_ID

const char* KODI::GAME::DEFAULT_MOUSE_ID = "game.controller.mouse"

constexpr

DEFAULT_REMOTE_ID

const char* KODI::GAME::DEFAULT_REMOTE_ID = "game.controller.remote"

constexpr