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

Classes

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

Typedefs

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

Enumerations

enum class  KODI::RETRO::STRETCHMODE {
  KODI::RETRO::STRETCHMODE::Normal , KODI::RETRO::STRETCHMODE::Stretch4x3 , KODI::RETRO::STRETCHMODE::Fullscreen , KODI::RETRO::STRETCHMODE::Original ,
  KODI::RETRO::STRETCHMODE::Zoom
}
 Methods for stretching the game to the viewing area. More...
 
enum class  KODI::GAME::PORT_TYPE { KODI::GAME::PORT_TYPE::UNKNOWN , KODI::GAME::PORT_TYPE::KEYBOARD , KODI::GAME::PORT_TYPE::MOUSE , KODI::GAME::PORT_TYPE::CONTROLLER }
 Type of input provided by a hardware or controller port. More...
 
enum class  KODI::GAME::BUTTON_TYPE {
  KODI::GAME::BUTTON_TYPE::UNKNOWN , KODI::GAME::BUTTON_TYPE::BUTTON , KODI::GAME::BUTTON_TYPE::ANALOG_STICK , KODI::GAME::BUTTON_TYPE::RELATIVE_POINTER ,
  KODI::GAME::BUTTON_TYPE::WHEEL , KODI::GAME::BUTTON_TYPE::THROTTLE , KODI::GAME::BUTTON_TYPE::SELECT_KEY
}
 Types of button controls that can populate the feature list. More...
 

Variables

constexpr auto KODI::GAME::GAME_CLIENT_RESOURCES_DIRECTORY = "resources"
 Name of the resources directory for game clients.
 
constexpr unsigned int MAX_PORT_COUNT = 12
 The maximum port count, chosen to allow for two Saturn 6 Player Adapters.
 

Detailed Description

Everything about RetroPlayer.

Typedef Documentation

◆ CControllerTree

Collection of ports on a console.

◆ ControllerGrid

Collection of controllers in a grid layout.

◆ ControllerPtr

using KODI::GAME::ControllerPtr = std::shared_ptr<CController>

Smart pointer to a game controller (CController)

◆ ControllerVector

Vector of smart pointers to a game controller (CController)

◆ GameAgentPtr

using KODI::GAME::GameAgentPtr = std::shared_ptr<CGameAgent>

Smart pointer to a game-playing agent (CGameAgent)

◆ GameAgentVec

using KODI::GAME::GameAgentVec = std::vector<GameAgentPtr>

Vector of smart pointers to game-playing agents (CGameAgent)

◆ GameClientDevicePtr

Smart pointer to an input device for a game client (CGameClientDevice)

◆ GameClientDeviceVec

Vector of smart pointers to input devices for a game client (CGameClientDevice)

◆ GameClientPortPtr

Smart pointer to an input port for a game client (CGameClientPort)

◆ GameClientPortVec

Vector of smart pointers to input ports for a game client (CGameClientPort)

◆ GameClientPtr

using KODI::GAME::GameClientPtr = std::shared_ptr<CGameClient>

Smart pointer to a game client (CGameClient)

◆ GameClientVector

Vector of smart pointers to a game client (CGameClient)

Enumeration Type Documentation

◆ BUTTON_TYPE

enum class KODI::GAME::BUTTON_TYPE
strong

Types of button controls that can populate the feature list.

Enumerator
UNKNOWN 
BUTTON 
ANALOG_STICK 
RELATIVE_POINTER 
WHEEL 
THROTTLE 
SELECT_KEY 

◆ PORT_TYPE

enum class KODI::GAME::PORT_TYPE
strong

Type of input provided by a hardware or controller port.

Enumerator
UNKNOWN 
KEYBOARD 
MOUSE 
CONTROLLER 

◆ STRETCHMODE

enum class KODI::RETRO::STRETCHMODE
strong

Methods for stretching the game to the viewing area.

Enumerator
Normal 

Show the game at its normal aspect ratio.

Stretch4x3 

Stretch the game to maintain a 4:3 aspect ratio.

Fullscreen 

Stretch the game to fill the viewing area.

Original 

Show the game at its original size (humorous for old consoles on 4K TVs)

Zoom 

Show the game at its normal aspect ratio but zoom to fill the viewing area.

Variable Documentation

◆ GAME_CLIENT_RESOURCES_DIRECTORY

auto KODI::GAME::GAME_CLIENT_RESOURCES_DIRECTORY = "resources"
constexpr

Name of the resources directory for game clients.

◆ MAX_PORT_COUNT

unsigned int MAX_PORT_COUNT = 12
constexpr

The maximum port count, chosen to allow for two Saturn 6 Player Adapters.