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

#include <SavestateFlatBuffer.h>

Inheritance diagram for KODI::RETRO::CSavestateFlatBuffer:
KODI::RETRO::ISavestate

Public Member Functions

 CSavestateFlatBuffer ()
 
 ~CSavestateFlatBuffer () override
 
void Reset () override
 Reset to the initial state.
 
bool Serialize (const uint8_t *&data, size_t &size) const override
 
SAVE_TYPE Type () const override
 The type of save action that created this savestate, either manual or automatic.
 
uint8_t Slot () const override
 The slot this savestate was saved into, or 0 for no slot.
 
std::string Label () const override
 The label shown in the GUI for this savestate.
 
std::string Caption () const override
 A caption that describes the state of the game for this savestate.
 
CDateTime Created () const override
 The timestamp of this savestate's creation.
 
std::string GameFileName () const override
 The name of the file belonging to this savestate's game.
 
uint64_t TimestampFrames () const override
 The number of frames in the entire gameplay history.
 
double TimestampWallClock () const override
 The duration of the entire gameplay history as seen by a wall clock.
 
std::string GameClientID () const override
 The game client add-on ID that created this savestate.
 
std::string GameClientVersion () const override
 The semantic version of the game client.
 
AVPixelFormat GetPixelFormat () const override
 The pixel format of the video stream.
 
unsigned int GetNominalWidth () const override
 The nominal width of the video stream, a good guess for subsequent frames.
 
unsigned int GetNominalHeight () const override
 The nominal height of the video stream, a good guess for subsequent frames.
 
unsigned int GetMaxWidth () const override
 The maximum width of the video stream, in pixels.
 
unsigned int GetMaxHeight () const override
 The maximum height of the video stream, in pixels.
 
float GetPixelAspectRatio () const override
 The pixel aspect ratio of the video stream.
 
const uint8_tGetVideoData () const override
 A pointer to the frame's video data (pixels)
 
size_t GetVideoSize () const override
 The size of the frame's video data, in bytes.
 
unsigned int GetVideoWidth () const override
 The width of the video frame, in pixels.
 
unsigned int GetVideoHeight () const override
 The height of the video frame, in pixels.
 
unsigned int GetRotationDegCCW () const override
 The rotation of the video frame, in degrees counter-clockwise.
 
const uint8_tGetMemoryData () const override
 A pointer to the internal memory (SRAM) of the frame.
 
size_t GetMemorySize () const override
 The size of the memory region returned by GetMemoryData()
 
void SetType (SAVE_TYPE type) override
 
void SetSlot (uint8_t slot) override
 
void SetLabel (const std::string &label) override
 
void SetCaption (const std::string &caption) override
 
void SetCreated (const CDateTime &createdUTC) override
 
void SetGameFileName (const std::string &gameFileName) override
 
void SetTimestampFrames (uint64_t timestampFrames) override
 
void SetTimestampWallClock (double timestampWallClock) override
 
void SetGameClientID (const std::string &gameClient) override
 
void SetGameClientVersion (const std::string &gameClient) override
 
void SetPixelFormat (AVPixelFormat pixelFormat) override
 
void SetNominalWidth (unsigned int nominalWidth) override
 
void SetNominalHeight (unsigned int nominalHeight) override
 
void SetMaxWidth (unsigned int maxWidth) override
 
void SetMaxHeight (unsigned int maxHeight) override
 
void SetPixelAspectRatio (float pixelAspectRatio) override
 
uint8_tGetVideoBuffer (size_t size) override
 
void SetVideoWidth (unsigned int videoWidth) override
 
void SetVideoHeight (unsigned int videoHeight) override
 
void SetRotationDegCCW (unsigned int rotationCCW) override
 
uint8_tGetMemoryBuffer (size_t size) override
 
void Finalize () override
 
bool Deserialize (std::vector< uint8_t > data) override
 }
 
- Public Member Functions inherited from KODI::RETRO::ISavestate
virtual ~ISavestate ()=default
 

Constructor & Destructor Documentation

◆ CSavestateFlatBuffer()

CSavestateFlatBuffer::CSavestateFlatBuffer ( )

◆ ~CSavestateFlatBuffer()

CSavestateFlatBuffer::~CSavestateFlatBuffer ( )
overridedefault

Member Function Documentation

◆ Caption()

std::string CSavestateFlatBuffer::Caption ( ) const
overridevirtual

A caption that describes the state of the game for this savestate.

Implements KODI::RETRO::ISavestate.

◆ Created()

CDateTime CSavestateFlatBuffer::Created ( ) const
overridevirtual

The timestamp of this savestate's creation.

Implements KODI::RETRO::ISavestate.

◆ Deserialize()

bool CSavestateFlatBuffer::Deserialize ( std::vector< uint8_t > data)
overridevirtual

}

Take ownership and initialize the flatbuffer with the given vector

Implements KODI::RETRO::ISavestate.

◆ Finalize()

void CSavestateFlatBuffer::Finalize ( )
overridevirtual

◆ GameClientID()

std::string CSavestateFlatBuffer::GameClientID ( ) const
overridevirtual

The game client add-on ID that created this savestate.

Implements KODI::RETRO::ISavestate.

◆ GameClientVersion()

std::string CSavestateFlatBuffer::GameClientVersion ( ) const
overridevirtual

The semantic version of the game client.

Implements KODI::RETRO::ISavestate.

◆ GameFileName()

std::string CSavestateFlatBuffer::GameFileName ( ) const
overridevirtual

The name of the file belonging to this savestate's game.

Implements KODI::RETRO::ISavestate.

◆ GetMaxHeight()

unsigned int CSavestateFlatBuffer::GetMaxHeight ( ) const
overridevirtual

The maximum height of the video stream, in pixels.

Implements KODI::RETRO::ISavestate.

◆ GetMaxWidth()

unsigned int CSavestateFlatBuffer::GetMaxWidth ( ) const
overridevirtual

The maximum width of the video stream, in pixels.

Implements KODI::RETRO::ISavestate.

◆ GetMemoryBuffer()

uint8_t * CSavestateFlatBuffer::GetMemoryBuffer ( size_t size)
overridevirtual

◆ GetMemoryData()

const uint8_t * CSavestateFlatBuffer::GetMemoryData ( ) const
overridevirtual

A pointer to the internal memory (SRAM) of the frame.

Implements KODI::RETRO::ISavestate.

◆ GetMemorySize()

size_t CSavestateFlatBuffer::GetMemorySize ( ) const
overridevirtual

The size of the memory region returned by GetMemoryData()

Implements KODI::RETRO::ISavestate.

◆ GetNominalHeight()

unsigned int CSavestateFlatBuffer::GetNominalHeight ( ) const
overridevirtual

The nominal height of the video stream, a good guess for subsequent frames.

Implements KODI::RETRO::ISavestate.

◆ GetNominalWidth()

unsigned int CSavestateFlatBuffer::GetNominalWidth ( ) const
overridevirtual

The nominal width of the video stream, a good guess for subsequent frames.

Implements KODI::RETRO::ISavestate.

◆ GetPixelAspectRatio()

float CSavestateFlatBuffer::GetPixelAspectRatio ( ) const
overridevirtual

The pixel aspect ratio of the video stream.

Implements KODI::RETRO::ISavestate.

◆ GetPixelFormat()

AVPixelFormat CSavestateFlatBuffer::GetPixelFormat ( ) const
overridevirtual

The pixel format of the video stream.

Implements KODI::RETRO::ISavestate.

◆ GetRotationDegCCW()

unsigned int CSavestateFlatBuffer::GetRotationDegCCW ( ) const
overridevirtual

The rotation of the video frame, in degrees counter-clockwise.

Implements KODI::RETRO::ISavestate.

◆ GetVideoBuffer()

uint8_t * CSavestateFlatBuffer::GetVideoBuffer ( size_t size)
overridevirtual

◆ GetVideoData()

const uint8_t * CSavestateFlatBuffer::GetVideoData ( ) const
overridevirtual

A pointer to the frame's video data (pixels)

Implements KODI::RETRO::ISavestate.

◆ GetVideoHeight()

unsigned int CSavestateFlatBuffer::GetVideoHeight ( ) const
overridevirtual

The height of the video frame, in pixels.

Implements KODI::RETRO::ISavestate.

◆ GetVideoSize()

size_t CSavestateFlatBuffer::GetVideoSize ( ) const
overridevirtual

The size of the frame's video data, in bytes.

Implements KODI::RETRO::ISavestate.

◆ GetVideoWidth()

unsigned int CSavestateFlatBuffer::GetVideoWidth ( ) const
overridevirtual

The width of the video frame, in pixels.

Implements KODI::RETRO::ISavestate.

◆ Label()

std::string CSavestateFlatBuffer::Label ( ) const
overridevirtual

The label shown in the GUI for this savestate.

Implements KODI::RETRO::ISavestate.

◆ Reset()

void CSavestateFlatBuffer::Reset ( )
overridevirtual

Reset to the initial state.

Implements KODI::RETRO::ISavestate.

◆ Serialize()

bool CSavestateFlatBuffer::Serialize ( const uint8_t *& data,
size_t & size ) const
overridevirtual

Access the data representation of this savestate

Implements KODI::RETRO::ISavestate.

◆ SetCaption()

void CSavestateFlatBuffer::SetCaption ( const std::string & caption)
overridevirtual

◆ SetCreated()

void CSavestateFlatBuffer::SetCreated ( const CDateTime & createdUTC)
overridevirtual

◆ SetGameClientID()

void CSavestateFlatBuffer::SetGameClientID ( const std::string & gameClient)
overridevirtual

◆ SetGameClientVersion()

void CSavestateFlatBuffer::SetGameClientVersion ( const std::string & gameClient)
overridevirtual

◆ SetGameFileName()

void CSavestateFlatBuffer::SetGameFileName ( const std::string & gameFileName)
overridevirtual

◆ SetLabel()

void CSavestateFlatBuffer::SetLabel ( const std::string & label)
overridevirtual

◆ SetMaxHeight()

void CSavestateFlatBuffer::SetMaxHeight ( unsigned int maxHeight)
overridevirtual

◆ SetMaxWidth()

void CSavestateFlatBuffer::SetMaxWidth ( unsigned int maxWidth)
overridevirtual

◆ SetNominalHeight()

void CSavestateFlatBuffer::SetNominalHeight ( unsigned int nominalHeight)
overridevirtual

◆ SetNominalWidth()

void CSavestateFlatBuffer::SetNominalWidth ( unsigned int nominalWidth)
overridevirtual

◆ SetPixelAspectRatio()

void CSavestateFlatBuffer::SetPixelAspectRatio ( float pixelAspectRatio)
overridevirtual

◆ SetPixelFormat()

void CSavestateFlatBuffer::SetPixelFormat ( AVPixelFormat pixelFormat)
overridevirtual

◆ SetRotationDegCCW()

void CSavestateFlatBuffer::SetRotationDegCCW ( unsigned int rotationCCW)
overridevirtual

◆ SetSlot()

void CSavestateFlatBuffer::SetSlot ( uint8_t slot)
overridevirtual

◆ SetTimestampFrames()

void CSavestateFlatBuffer::SetTimestampFrames ( uint64_t timestampFrames)
overridevirtual

◆ SetTimestampWallClock()

void CSavestateFlatBuffer::SetTimestampWallClock ( double timestampWallClock)
overridevirtual

◆ SetType()

void CSavestateFlatBuffer::SetType ( SAVE_TYPE type)
overridevirtual

◆ SetVideoHeight()

void CSavestateFlatBuffer::SetVideoHeight ( unsigned int videoHeight)
overridevirtual

◆ SetVideoWidth()

void CSavestateFlatBuffer::SetVideoWidth ( unsigned int videoWidth)
overridevirtual

◆ Slot()

uint8_t CSavestateFlatBuffer::Slot ( ) const
overridevirtual

The slot this savestate was saved into, or 0 for no slot.

This allows for keyboard access of saved games using the number keys 1-9.

Implements KODI::RETRO::ISavestate.

◆ TimestampFrames()

uint64_t CSavestateFlatBuffer::TimestampFrames ( ) const
overridevirtual

The number of frames in the entire gameplay history.

Implements KODI::RETRO::ISavestate.

◆ TimestampWallClock()

double CSavestateFlatBuffer::TimestampWallClock ( ) const
overridevirtual

The duration of the entire gameplay history as seen by a wall clock.

Implements KODI::RETRO::ISavestate.

◆ Type()

SAVE_TYPE CSavestateFlatBuffer::Type ( ) const
overridevirtual

The type of save action that created this savestate, either manual or automatic.

Implements KODI::RETRO::ISavestate.


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