xbmc
Public Member Functions | List of all members
KODI::RETRO::ISavestate Class Referenceabstract
Inheritance diagram for KODI::RETRO::ISavestate:
Inheritance graph
[legend]

Public Member Functions

virtual void Reset ()=0
 Reset to the initial state.
 
virtual bool Serialize (const uint8_t *&data, size_t &size) const =0
 
Savestate properties

{

virtual SAVE_TYPE Type () const =0
 The type of save action that created this savestate, either manual or automatic.
 
virtual uint8_t Slot () const =0
 The slot this savestate was saved into, or 0 for no slot. More...
 
virtual std::string Label () const =0
 The label shown in the GUI for this savestate.
 
virtual std::string Caption () const =0
 A caption that describes the state of the game for this savestate.
 
virtual CDateTime Created () const =0
 The timestamp of this savestate's creation.
 
Game properties

}

{

virtual std::string GameFileName () const =0
 The name of the file belonging to this savestate's game.
 
Environment properties

}

{

virtual uint64_t TimestampFrames () const =0
 The number of frames in the entire gameplay history.
 
virtual double TimestampWallClock () const =0
 The duration of the entire gameplay history as seen by a wall clock.
 
Game client properties

}

{

virtual std::string GameClientID () const =0
 The game client add-on ID that created this savestate.
 
virtual std::string GameClientVersion () const =0
 The semantic version of the game client.
 
Video stream properties

}

{

virtual AVPixelFormat GetPixelFormat () const =0
 The pixel format of the video stream.
 
virtual unsigned int GetNominalWidth () const =0
 The nominal width of the video stream, a good guess for subsequent frames.
 
virtual unsigned int GetNominalHeight () const =0
 The nominal height of the video stream, a good guess for subsequent frames.
 
virtual unsigned int GetMaxWidth () const =0
 The maximum width of the video stream, in pixels.
 
virtual unsigned int GetMaxHeight () const =0
 The maximum height of the video stream, in pixels.
 
virtual float GetPixelAspectRatio () const =0
 The pixel aspect ratio of the video stream.
 
Video frame properties

}

{

virtual const uint8_t * GetVideoData () const =0
 A pointer to the frame's video data (pixels)
 
virtual size_t GetVideoSize () const =0
 The size of the frame's video data, in bytes.
 
virtual unsigned int GetVideoWidth () const =0
 The width of the video frame, in pixels.
 
virtual unsigned int GetVideoHeight () const =0
 The height of the video frame, in pixels.
 
virtual unsigned int GetRotationDegCCW () const =0
 The rotation of the video frame, in degrees counter-clockwise.
 
Memory properties

}

{

virtual const uint8_t * GetMemoryData () const =0
 A pointer to the internal memory (SRAM) of the frame.
 
virtual size_t GetMemorySize () const =0
 The size of the memory region returned by GetMemoryData()
 
Builders for setting individual fields

}

{

virtual void SetType (SAVE_TYPE type)=0
 
virtual void SetSlot (uint8_t slot)=0
 
virtual void SetLabel (const std::string &label)=0
 
virtual void SetCaption (const std::string &caption)=0
 
virtual void SetCreated (const CDateTime &createdUTC)=0
 
virtual void SetGameFileName (const std::string &gameFileName)=0
 
virtual void SetTimestampFrames (uint64_t timestampFrames)=0
 
virtual void SetTimestampWallClock (double timestampWallClock)=0
 
virtual void SetGameClientID (const std::string &gameClient)=0
 
virtual void SetGameClientVersion (const std::string &gameClient)=0
 
virtual void SetPixelFormat (AVPixelFormat pixelFormat)=0
 
virtual void SetNominalWidth (unsigned int nominalWidth)=0
 
virtual void SetNominalHeight (unsigned int nominalHeight)=0
 
virtual void SetMaxWidth (unsigned int maxWidth)=0
 
virtual void SetMaxHeight (unsigned int maxHeight)=0
 
virtual void SetPixelAspectRatio (float pixelAspectRatio)=0
 
virtual uint8_t * GetVideoBuffer (size_t size)=0
 
virtual void SetVideoWidth (unsigned int videoWidth)=0
 
virtual void SetVideoHeight (unsigned int videoHeight)=0
 
virtual void SetRotationDegCCW (unsigned int rotationCCW)=0
 
virtual uint8_t * GetMemoryBuffer (size_t size)=0
 
virtual void Finalize ()=0
 
virtual bool Deserialize (std::vector< uint8_t > data)=0
 } More...
 

Member Function Documentation

◆ Deserialize()

virtual bool KODI::RETRO::ISavestate::Deserialize ( std::vector< uint8_t >  data)
pure virtual

}

Take ownership and initialize the flatbuffer with the given vector

Implemented in KODI::RETRO::CSavestateFlatBuffer.

◆ Serialize()

virtual bool KODI::RETRO::ISavestate::Serialize ( const uint8_t *&  data,
size_t &  size 
) const
pure virtual

Access the data representation of this savestate

Implemented in KODI::RETRO::CSavestateFlatBuffer.

◆ Slot()

virtual uint8_t KODI::RETRO::ISavestate::Slot ( ) const
pure virtual

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.

Implemented in KODI::RETRO::CSavestateFlatBuffer.


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