KODI::RETRO::CGUIGameSettingsHandle Class Reference

#include <GUIGameSettingsHandle.h>

Public Member Functions
	CGUIGameSettingsHandle (CGUIGameRenderManager &renderManager)
virtual	~CGUIGameSettingsHandle ()
std::string	GameClientID ()
	Get the ID of the active game client.
std::string	GetPlayingGame ()
	Get the full path of the game being played.
std::string	CreateSavestate (bool autosave)
	Create a savestate of the current game being played.
bool	UpdateSavestate (const std::string &savestatePath)
	Update a savestate for the current game being played.
bool	LoadSavestate (const std::string &savestatePath)
	Load a savestate for the current game being played.
void	FreeSavestateResources (const std::string &savestatePath)
	Clear the video frame stored for the given statestate.
void	CloseOSD ()
	Close the in-game OSD.

Constructor & Destructor Documentation

CGUIGameSettingsHandle()

CGUIGameSettingsHandle::CGUIGameSettingsHandle

(

CGUIGameRenderManager &

renderManager

)

~CGUIGameSettingsHandle()

CGUIGameSettingsHandle::~CGUIGameSettingsHandle ( )

virtual

Member Function Documentation

CloseOSD()

void CGUIGameSettingsHandle::CloseOSD

(

)

Close the in-game OSD.

CreateSavestate()

std::string CGUIGameSettingsHandle::CreateSavestate

(

bool

autosave

)

Create a savestate of the current game being played.

Parameters

autosave

True if the save was invoked automatically, or false if the save was invoked by a player

Returns

The path to the created savestate file, or empty string on failure or if a game is not playing

FreeSavestateResources()

void CGUIGameSettingsHandle::FreeSavestateResources

(

const std::string &

savestatePath

)

Clear the video frame stored for the given statestate.

Useful to reclaim memory if a savestate has been deleted.

Parameters

savestatePath

The path to the savestate file

GameClientID()

std::string CGUIGameSettingsHandle::GameClientID

(

)

Get the ID of the active game client.

Returns

The ID of the active game client, or empty string if a game is not playing

GetPlayingGame()

std::string CGUIGameSettingsHandle::GetPlayingGame

(

)

Get the full path of the game being played.

Returns

The game's path, or empty string if a game is not playing

LoadSavestate()

bool CGUIGameSettingsHandle::LoadSavestate

(

const std::string &

savestatePath

)

Load a savestate for the current game being played.

Parameters

savestatePath

The path to the created savestate file returned by CreateSavestate()

Returns

True if the savestate was loaded successfully, false otherwise

UpdateSavestate()

bool CGUIGameSettingsHandle::UpdateSavestate

(

const std::string &

savestatePath

)

Update a savestate for the current game being played.

Parameters

savestatePath

The path to the created savestate file returned by CreateSavestate()

Returns

True if the savestate was updated successfully, false otherwise

---

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

• GUIGameSettingsHandle.h
• GUIGameSettingsHandle.cpp