Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
KODI::GAME::CPhysicalTopology Class Reference

Represents the physical topology of controller add-ons. More...

#include <PhysicalTopology.h>

Public Member Functions

 CPhysicalTopology ()=default
 
 CPhysicalTopology (bool bProvidesInput, std::vector< CPhysicalPort > ports)
 
void Reset ()
 
bool ProvidesInput () const
 Check if the controller can provide player input.
 
const std::vector< CPhysicalPort > & Ports () const
 Get a list of ports provided by this controller.
 
bool Deserialize (const tinyxml2::XMLElement *pElement)
 

Detailed Description

Represents the physical topology of controller add-ons.

The physical topology of a controller defines how many ports it has and whether it can provide player input (hubs like the Super Multitap don't provide input).

Constructor & Destructor Documentation

◆ CPhysicalTopology() [1/2]

KODI::GAME::CPhysicalTopology::CPhysicalTopology ( )
default

◆ CPhysicalTopology() [2/2]

CPhysicalTopology::CPhysicalTopology ( bool bProvidesInput,
std::vector< CPhysicalPort > ports )

Member Function Documentation

◆ Deserialize()

bool CPhysicalTopology::Deserialize ( const tinyxml2::XMLElement * pElement)

◆ Ports()

const std::vector< CPhysicalPort > & KODI::GAME::CPhysicalTopology::Ports ( ) const
inline

Get a list of ports provided by this controller.

Returns
The ports

◆ ProvidesInput()

bool KODI::GAME::CPhysicalTopology::ProvidesInput ( ) const
inline

Check if the controller can provide player input.

This allows hubs to specify that they provide no input

Returns
True if the controller can provide player input, false otherwise

◆ Reset()

void CPhysicalTopology::Reset ( )

The documentation for this class was generated from the following files: