mirror of
https://github.com/0ldsk00l/nestopia.git
synced 2025-04-02 10:31:51 -04:00
423 lines
12 KiB
HTML
423 lines
12 KiB
HTML
<HTML>
|
|
|
|
<HEAD>
|
|
<!-- Generated by CppDoc v2.4.1 on June 07, 2008 at 22:48-->
|
|
|
|
<META NAME="GENERATOR" Content="CppDoc">
|
|
<TITLE>Nestopia Core API: Nes::Api::Rewinder</TITLE>
|
|
|
|
</HEAD>
|
|
|
|
<BODY>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#eeeeff">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-overview-summary.html"><B>Overview</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-summary.html"><B>Project</B></a> </TD>
|
|
<TD BGCOLOR="navy"> <FONT COLOR="white"> <B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-tree.html"><B>Tree</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-deprecated-list.html"><B>Deprecated</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-all.html"><B>Index</B></a> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B>Nestopia Core API</B></EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><FONT SIZE="-2">
|
|
<a href="../../index.html" target="_top"><B>FRAMES</B></a>
|
|
<a href="../api/Nes..Api..Rewinder.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top"><FONT SIZE="-2">
|
|
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
api</FONT>
|
|
<BR>
|
|
Class Nes::Api::Rewinder</H2>
|
|
<PRE>
|
|
<code>Base</code>
|
|
|
|
|
+--<B>Nes::Api::Rewinder</B>
|
|
|
|
</PRE>
|
|
<HR>
|
|
<DL>
|
|
<DT>class <B><a href="../api/Nes..Api.html">Nes::Api</a>::Rewinder</B></DT><dt> extends Base
|
|
</DL>
|
|
|
|
<p>Game rewinder interface.
|
|
<p>
|
|
|
|
|
|
<HR>
|
|
|
|
|
|
<!-- =========== INNER CLASSES, TYPEDEFS, ENUMS =========== -->
|
|
|
|
<A NAME="inner_defs_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Inner Classes, Typedefs, and Enums</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>enum</CODE></FONT></TD>
|
|
<TD><B><CODE><a href="../api/Nes..Api..Rewinder..Direction.html">Nes::Api::Rewinder::Direction</a></CODE></B>
|
|
|
|
<BR>
|
|
Direction.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>enum</CODE></FONT></TD>
|
|
<TD><B><CODE><a href="../api/Nes..Api..Rewinder..State.html">Nes::Api::Rewinder::State</a></CODE></B>
|
|
|
|
<BR>
|
|
Rewinder state.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>typedef</CODE></FONT></TD>
|
|
<TD><B><CODE><a href="../api/Nes..Api..Rewinder..StateCallback.html">Nes::Api::Rewinder::StateCallback</a></CODE></B>
|
|
|
|
<BR>
|
|
Rewinder state callback prototype.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Field Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> static <a href="../api/Nes..Api..Rewinder..StateCaller.html">Nes::Api::Rewinder::StateCaller</a></CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#stateCallback">stateCallback</a></B></CODE>
|
|
|
|
<BR>
|
|
Rewinder state callback manager.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<!-- =========== CONSTRUCTOR SUMMARY =========== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#Rewinder(T&)">Rewinder</a></B>( T& instance )</CODE>
|
|
|
|
<BR>
|
|
Interface constructor.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<!-- =========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> Result</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#Enable(bool)">Enable</a></B>( bool state = true )</CODE>
|
|
|
|
<BR>
|
|
Enables rewinder.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#EnableSound(bool)">EnableSound</a></B>( bool state = true )</CODE>
|
|
|
|
<BR>
|
|
Enables backward sound.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> <a href="../api/Nes..Api..Rewinder..Direction.html">Nes::Api::Rewinder::Direction</a></CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetDirection()">GetDirection</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current direction.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> bool</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#IsEnabled()">IsEnabled</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Checks if rewinder is enabled.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> bool</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#IsSoundEnabled()">IsSoundEnabled</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Checks if backward sound is enabled.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#Reset()">Reset</a></B>()</CODE>
|
|
|
|
<BR>
|
|
Resets rewinder.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> Result</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#SetDirection(Direction)">SetDirection</a></B>( <a href="../api/Nes..Api..Rewinder..Direction.html">Nes::Api::Rewinder::Direction</a> direction )</CODE>
|
|
|
|
<BR>
|
|
Sets direction.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<BR>
|
|
<BR>
|
|
<!-- ============ Field Detail ========== -->
|
|
|
|
<A NAME="field_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Field Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="stateCallback"><!-- --></A>
|
|
<A NAME="stateCallback"><!-- --></A>
|
|
<H3>stateCallback</H3>
|
|
<PRE>
|
|
public static <a href="../api/Nes..Api..Rewinder..StateCaller.html">Nes::Api::Rewinder::StateCaller</a> <B>stateCallback</B>;
|
|
</PRE>
|
|
<DL>
|
|
<DD>Rewinder state callback manager.
|
|
Static object used for adding the user defined callback.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<BR>
|
|
<!-- ============ Constructor Detail ========== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Constructor Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="Rewinder(T&)"><!-- --></A>
|
|
<A NAME="Rewinder"><!-- --></A>
|
|
<H3>Rewinder</H3>
|
|
<PRE>
|
|
public <B>Rewinder</B>( T& instance );
|
|
</PRE>
|
|
<DL>
|
|
<DD>Interface constructor.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>instance</code> - emulator instance</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<BR>
|
|
<!-- ============ Method Detail ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="Enable(bool)"><!-- --></A>
|
|
<A NAME="Enable"><!-- --></A>
|
|
<H3>Enable</H3>
|
|
<PRE>
|
|
public Result <B>Enable</B>( bool state = true ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Enables rewinder.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>state</code> - true to enable</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="EnableSound(bool)"><!-- --></A>
|
|
<A NAME="EnableSound"><!-- --></A>
|
|
<H3>EnableSound</H3>
|
|
<PRE>
|
|
public void <B>EnableSound</B>( bool state = true ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Enables backward sound.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>state</code> - true to enable</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetDirection()"><!-- --></A>
|
|
<A NAME="GetDirection"><!-- --></A>
|
|
<H3>GetDirection</H3>
|
|
<PRE>
|
|
public <a href="../api/Nes..Api..Rewinder..Direction.html">Nes::Api::Rewinder::Direction</a> <B>GetDirection</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current direction.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>current direction</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="IsEnabled()"><!-- --></A>
|
|
<A NAME="IsEnabled"><!-- --></A>
|
|
<H3>IsEnabled</H3>
|
|
<PRE>
|
|
public bool <B>IsEnabled</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Checks if rewinder is enabled.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>true if enabled</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="IsSoundEnabled()"><!-- --></A>
|
|
<A NAME="IsSoundEnabled"><!-- --></A>
|
|
<H3>IsSoundEnabled</H3>
|
|
<PRE>
|
|
public bool <B>IsSoundEnabled</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Checks if backward sound is enabled.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>true if enabled</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Reset()"><!-- --></A>
|
|
<A NAME="Reset"><!-- --></A>
|
|
<H3>Reset</H3>
|
|
<PRE>
|
|
public void <B>Reset</B>() throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Resets rewinder.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetDirection(Direction)"><!-- --></A>
|
|
<A NAME="SetDirection"><!-- --></A>
|
|
<H3>SetDirection</H3>
|
|
<PRE>
|
|
public Result <B>SetDirection</B>( <a href="../api/Nes..Api..Rewinder..Direction.html">Nes::Api::Rewinder::Direction</a> direction ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets direction.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>direction</code> - direction, FORWARD or BACKWARD</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#eeeeff">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-overview-summary.html"><B>Overview</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-summary.html"><B>Project</B></a> </TD>
|
|
<TD BGCOLOR="navy"> <FONT COLOR="white"> <B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-tree.html"><B>Tree</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-deprecated-list.html"><B>Deprecated</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-all.html"><B>Index</B></a> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B>Nestopia Core API</B></EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><FONT SIZE="-2">
|
|
<a href="../../index.html" target="_top"><B>FRAMES</B></a>
|
|
<a href="../api/Nes..Api..Rewinder.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top"><FONT SIZE="-2">
|
|
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
|
|
|
|
</BODY>
|
|
|
|
</HTML>
|
|
|