| 
 | Nestopia Core API | |||||||
| FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
Base
   |
   +--Nes::Api::Machine
Machine interface.
| Inner Classes, Typedefs, and Enums | |
| enum | Nes::Api::Machine::AskProfileImage profile questioning state. | 
| enum | Nes::Api::Machine::CompressionInternal compression on states. | 
| enum | Nes::Api::Machine::EventMachine events. | 
| typedef | Nes::Api::Machine::EventCallbackMachine event callback prototype. | 
| enum | Nes::Api::Machine::FavoredSystemFavored System. | 
| enum | Nes::Api::Machine::ModeNTSC/PAL mode. | 
| struct | Nes::Api::Machine::PatchSoft-patching context object. | 
| Field Summary | |
|  static Nes::Api::Machine::EventCaller | eventCallbackMachine event callback manager. | 
| Constructor Summary | |
| Machine( T& instance )Interface constructor. | |
| Method Summary | |
|  Nes::Api::Machine::Mode | GetDesiredMode() constReturns the mode most appropriate for the current image. | 
|  Nes::Api::Machine::Mode | GetMode() constReturns the current mode. | 
|  bool | Is( uint flags1, uint flags2 ) constReturns a machine state. | 
|  uint | Is( uint flags ) constReturns a machine state. | 
|  bool | IsLocked() constTells if the machine is in a locked state. | 
|  Result | Load( std::istream& stream, Nes::Api::Machine::FavoredSystem system, Nes::Api::Machine::Patch& patch, Nes::Api::Machine::AskProfile askProfile = DONT_ASK_PROFILE )Loads any image. | 
|  Result | Load( std::istream& stream, Nes::Api::Machine::FavoredSystem system, Nes::Api::Machine::AskProfile askProfile = DONT_ASK_PROFILE )Loads any image. | 
|  Result | LoadCartridge( std::istream& stream, Nes::Api::Machine::FavoredSystem system, Nes::Api::Machine::Patch& patch, Nes::Api::Machine::AskProfile askProfile = DONT_ASK_PROFILE )Loads a cartridge image. | 
|  Result | LoadCartridge( std::istream& stream, Nes::Api::Machine::FavoredSystem system, Nes::Api::Machine::AskProfile askProfile = DONT_ASK_PROFILE )Loads a cartridge image. | 
|  Result | LoadDisk( std::istream& stream, Nes::Api::Machine::FavoredSystem system )Loads a Famicom Disk System image. | 
|  Result | LoadSound( std::istream& stream, Nes::Api::Machine::FavoredSystem system )Loads a sound image. | 
|  Result | LoadState( std::istream& stream )Loads a state. | 
|  Result | Power( bool state )Powers ON or OFF the machine. | 
|  Result | Reset( bool state )Resets the machine. | 
|  Result | SaveState( std::ostream& stream, Nes::Api::Machine::Compression compression = USE_COMPRESSION ) constSaves a state. | 
|  Result | SetMode( Nes::Api::Machine::Mode mode )Sets the mode. | 
|  Result | Unload()Unloads the current image. | 
| Field Detail | 
public static Nes::Api::Machine::EventCaller eventCallback;
| Constructor Detail | 
public Machine( T& instance );
instance - emulator instance| Method Detail | 
public Nes::Api::Machine::Mode GetDesiredMode() const throw();
public Nes::Api::Machine::Mode GetMode() const throw();
public bool Is( uint flags1, uint flags2 ) const throw();
flags1 - OR:ed flags to check
flags2 - OR:ed flags to checkpublic uint Is( uint flags ) const throw();
flags - OR:ed flags to checkpublic bool IsLocked() const;
public Result Load( std::istream& stream, Nes::Api::Machine::FavoredSystem system, Nes::Api::Machine::Patch& patch, Nes::Api::Machine::AskProfile askProfile = DONT_ASK_PROFILE ) throw();
stream - input stream containing the image to load
system - console to emulate if the core can't do automatic detection
patch - object for performing soft-patching on the image
askProfile - to allow callback triggering if the image has multiple media profiles, default is falsepublic Result Load( std::istream& stream, Nes::Api::Machine::FavoredSystem system, Nes::Api::Machine::AskProfile askProfile = DONT_ASK_PROFILE ) throw();
stream - input stream containing the image to load
system - console to emulate if the core can't do automatic detection
askProfile - to allow callback triggering if the image has multiple media profiles, default is falsepublic Result LoadCartridge( std::istream& stream, Nes::Api::Machine::FavoredSystem system, Nes::Api::Machine::Patch& patch, Nes::Api::Machine::AskProfile askProfile = DONT_ASK_PROFILE ) throw();
stream - input stream containing the image to load
system - console to emulate if the core can't do automatic detection
patch - object for performing soft-patching on the image
askProfile - to allow callback triggering if the image has multiple media profiles, default is falsepublic Result LoadCartridge( std::istream& stream, Nes::Api::Machine::FavoredSystem system, Nes::Api::Machine::AskProfile askProfile = DONT_ASK_PROFILE ) throw();
stream - input stream containing the image to load
system - console to emulate if the core can't do automatic detection
askProfile - to allow callback triggering if the image has multiple media profiles, default is falsepublic Result LoadDisk( std::istream& stream, Nes::Api::Machine::FavoredSystem system ) throw();
stream - input stream containing the image to load
system - console to emulate if the core can't do automatic detectionpublic Result LoadSound( std::istream& stream, Nes::Api::Machine::FavoredSystem system ) throw();
stream - input stream containing the image to load
system - console to emulate if the core can't do automatic detectionpublic Result LoadState( std::istream& stream ) throw();
stream - input stream containing the statepublic Result Power( bool state ) throw();
state - ON if truepublic Result Reset( bool state ) throw();
state - hard-reset if true, soft-reset otherwisepublic Result SaveState( std::ostream& stream, Nes::Api::Machine::Compression compression = USE_COMPRESSION ) const throw();
stream - output stream which the state will be written to
compression - to allow internal compression in the state, default is USE_COMPRESSIONpublic Result SetMode( Nes::Api::Machine::Mode mode ) throw();
mode - new modepublic Result Unload() throw();
| 
 | Nestopia Core API | |||||||
| FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||