mirror of
https://github.com/0ldsk00l/nestopia.git
synced 2025-04-02 10:31:51 -04:00
915 lines
27 KiB
HTML
915 lines
27 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::Video</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..Video.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top"><FONT SIZE="-2">
|
|
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | <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::Video</H2>
|
|
<PRE>
|
|
<code>Base</code>
|
|
|
|
|
+--<B>Nes::Api::Video</B>
|
|
|
|
</PRE>
|
|
<HR>
|
|
<DL>
|
|
<DT>class <B><a href="../api/Nes..Api.html">Nes::Api</a>::Video</B></DT><dt> extends Base
|
|
</DL>
|
|
|
|
<p>Video 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>struct</CODE></FONT></TD>
|
|
<TD><B><CODE><a href="../api/Nes..Api..Video..Decoder.html">Nes::Api::Video::Decoder</a></CODE></B>
|
|
|
|
<BR>
|
|
YUV decoder context.</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..Video..DecoderPreset.html">Nes::Api::Video::DecoderPreset</a></CODE></B>
|
|
|
|
<BR>
|
|
YUV decoder presets.</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..Video..Output.html">Nes::Api::Video::Output</a></CODE></B>
|
|
|
|
<BR>
|
|
Video output context.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>class</CODE></FONT></TD>
|
|
<TD><B><CODE><a href="../api/Nes..Api..Video..Palette.html">Nes::Api::Video::Palette</a></CODE></B>
|
|
|
|
<BR>
|
|
Palette interface.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>struct</CODE></FONT></TD>
|
|
<TD><B><CODE><a href="../api/Nes..Api..Video..RenderState.html">Nes::Api::Video::RenderState</a></CODE></B>
|
|
|
|
<BR>
|
|
Render state context.</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="#Video(T&)">Video</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> bool</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#AreUnlimSpritesEnabled()">AreUnlimSpritesEnabled</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Checks if the PPU sprite software extension is enabled.</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="#Blit(Output&)">Blit</a></B>( <a href="../api/Nes..Api..Video..Output.html">Nes::Api::Video::Output</a>& output )</CODE>
|
|
|
|
<BR>
|
|
Performs a manual blit to the video output object.</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="#EnableFieldMerging(bool)">EnableFieldMerging</a></B>( bool state )</CODE>
|
|
|
|
<BR>
|
|
Enables field merging for the NTSC filter.</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="#EnableUnlimSprites(bool)">EnableUnlimSprites</a></B>( bool state )</CODE>
|
|
|
|
<BR>
|
|
Allows the PPU to render more than eight sprites per line.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetBrightness()">GetBrightness</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current brightness.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetColorArtifacts()">GetColorArtifacts</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current color artifacts for the NTSC filter.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetColorBleed()">GetColorBleed</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current color bleed for the NTSC filter.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetColorFringing()">GetColorFringing</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current color fringing for the NTSC filter.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetColorResolution()">GetColorResolution</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current color resolution for the NTSC filter.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetContrast()">GetContrast</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current contrast.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> const <a href="../api/Nes..Api..Video..Decoder.html">Nes::Api::Video::Decoder</a>&</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetDecoder()">GetDecoder</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current YUV decoder.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetHue()">GetHue</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current hue.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> <a href="../api/Nes..Api..Video..Palette.html">Nes::Api::Video::Palette</a></CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetPalette()">GetPalette</a></B>()</CODE>
|
|
|
|
<BR>
|
|
Returns the palette interface.</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="#GetRenderState(RenderState&)">GetRenderState</a></B>( <a href="../api/Nes..Api..Video..RenderState.html">Nes::Api::Video::RenderState</a>& state ) const</CODE>
|
|
|
|
<BR>
|
|
Returns the current render state.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetSaturation()">GetSaturation</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current saturation.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetSharpness()">GetSharpness</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current sharpness for the NTSC filter.</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="#IsFieldMergingEnabled()">IsFieldMergingEnabled</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Checks if NTSC filter field merging is enabled.</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="#SetBrightness(int)">SetBrightness</a></B>( int value )</CODE>
|
|
|
|
<BR>
|
|
Sets the brightness.</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="#SetColorArtifacts(int)">SetColorArtifacts</a></B>( int value )</CODE>
|
|
|
|
<BR>
|
|
Sets the color artifacts for the NTSC filter.</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="#SetColorBleed(int)">SetColorBleed</a></B>( int value )</CODE>
|
|
|
|
<BR>
|
|
Sets the color bleed for the NTSC filter.</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="#SetColorFringing(int)">SetColorFringing</a></B>( int value )</CODE>
|
|
|
|
<BR>
|
|
Sets the color fringing for the NTSC filter.</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="#SetColorResolution(int)">SetColorResolution</a></B>( int value )</CODE>
|
|
|
|
<BR>
|
|
Sets the color resolution for the NTSC filter.</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="#SetContrast(int)">SetContrast</a></B>( int value )</CODE>
|
|
|
|
<BR>
|
|
Sets the contrast.</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="#SetDecoder(constDecoder&)">SetDecoder</a></B>( const <a href="../api/Nes..Api..Video..Decoder.html">Nes::Api::Video::Decoder</a>& decoder )</CODE>
|
|
|
|
<BR>
|
|
Sets the YUV decoder.</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="#SetHue(int)">SetHue</a></B>( int value )</CODE>
|
|
|
|
<BR>
|
|
Sets the hue.</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="#SetRenderState(constRenderState&)">SetRenderState</a></B>( const <a href="../api/Nes..Api..Video..RenderState.html">Nes::Api::Video::RenderState</a>& state )</CODE>
|
|
|
|
<BR>
|
|
Sets the render state.</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="#SetSaturation(int)">SetSaturation</a></B>( int value )</CODE>
|
|
|
|
<BR>
|
|
Sets the saturation.</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="#SetSharpness(int)">SetSharpness</a></B>( int value )</CODE>
|
|
|
|
<BR>
|
|
Sets the sharpness for the NTSC filter.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<BR>
|
|
<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="Video(T&)"><!-- --></A>
|
|
<A NAME="Video"><!-- --></A>
|
|
<H3>Video</H3>
|
|
<PRE>
|
|
public <B>Video</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="AreUnlimSpritesEnabled()"><!-- --></A>
|
|
<A NAME="AreUnlimSpritesEnabled"><!-- --></A>
|
|
<H3>AreUnlimSpritesEnabled</H3>
|
|
<PRE>
|
|
public bool <B>AreUnlimSpritesEnabled</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Checks if the PPU sprite software extension is enabled.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>true if enabled</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Blit(Output&)"><!-- --></A>
|
|
<A NAME="Blit"><!-- --></A>
|
|
<H3>Blit</H3>
|
|
<PRE>
|
|
public Result <B>Blit</B>( <a href="../api/Nes..Api..Video..Output.html">Nes::Api::Video::Output</a>& output ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Performs a manual blit to the video output object.
|
|
The core calls this method internally for each frame.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>output</code> - video output object to blit to</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="EnableFieldMerging(bool)"><!-- --></A>
|
|
<A NAME="EnableFieldMerging"><!-- --></A>
|
|
<H3>EnableFieldMerging</H3>
|
|
<PRE>
|
|
public void <B>EnableFieldMerging</B>( bool state ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Enables field merging for the NTSC filter.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>state</code> - true to enable</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="EnableUnlimSprites(bool)"><!-- --></A>
|
|
<A NAME="EnableUnlimSprites"><!-- --></A>
|
|
<H3>EnableUnlimSprites</H3>
|
|
<PRE>
|
|
public Result <B>EnableUnlimSprites</B>( bool state ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Allows the PPU to render more than eight sprites per line.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>state</code> - true to allow it, default is false</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetBrightness()"><!-- --></A>
|
|
<A NAME="GetBrightness"><!-- --></A>
|
|
<H3>GetBrightness</H3>
|
|
<PRE>
|
|
public int <B>GetBrightness</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current brightness.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>brightness value in the range -100 to 100</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetColorArtifacts()"><!-- --></A>
|
|
<A NAME="GetColorArtifacts"><!-- --></A>
|
|
<H3>GetColorArtifacts</H3>
|
|
<PRE>
|
|
public int <B>GetColorArtifacts</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current color artifacts for the NTSC filter.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>color artifacts value in the range -100 to 100</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetColorBleed()"><!-- --></A>
|
|
<A NAME="GetColorBleed"><!-- --></A>
|
|
<H3>GetColorBleed</H3>
|
|
<PRE>
|
|
public int <B>GetColorBleed</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current color bleed for the NTSC filter.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>color bleed value in the range -100 to 100</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetColorFringing()"><!-- --></A>
|
|
<A NAME="GetColorFringing"><!-- --></A>
|
|
<H3>GetColorFringing</H3>
|
|
<PRE>
|
|
public int <B>GetColorFringing</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current color fringing for the NTSC filter.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>color fringing value in the range -100 to 100</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetColorResolution()"><!-- --></A>
|
|
<A NAME="GetColorResolution"><!-- --></A>
|
|
<H3>GetColorResolution</H3>
|
|
<PRE>
|
|
public int <B>GetColorResolution</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current color resolution for the NTSC filter.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>color resolution value in the range -100 to 100</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetContrast()"><!-- --></A>
|
|
<A NAME="GetContrast"><!-- --></A>
|
|
<H3>GetContrast</H3>
|
|
<PRE>
|
|
public int <B>GetContrast</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current contrast.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>contrast value in the range -100 to 100</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetDecoder()"><!-- --></A>
|
|
<A NAME="GetDecoder"><!-- --></A>
|
|
<H3>GetDecoder</H3>
|
|
<PRE>
|
|
public const <a href="../api/Nes..Api..Video..Decoder.html">Nes::Api::Video::Decoder</a>& <B>GetDecoder</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current YUV decoder.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>current decoder</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetHue()"><!-- --></A>
|
|
<A NAME="GetHue"><!-- --></A>
|
|
<H3>GetHue</H3>
|
|
<PRE>
|
|
public int <B>GetHue</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current hue.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>hue value in the range -45 to 45</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetPalette()"><!-- --></A>
|
|
<A NAME="GetPalette"><!-- --></A>
|
|
<H3>GetPalette</H3>
|
|
<PRE>
|
|
public <a href="../api/Nes..Api..Video..Palette.html">Nes::Api::Video::Palette</a> <B>GetPalette</B>();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the palette interface.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>palette interface</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetRenderState(RenderState&)"><!-- --></A>
|
|
<A NAME="GetRenderState"><!-- --></A>
|
|
<H3>GetRenderState</H3>
|
|
<PRE>
|
|
public Result <B>GetRenderState</B>( <a href="../api/Nes..Api..Video..RenderState.html">Nes::Api::Video::RenderState</a>& state ) const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current render state.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>state</code> - object to be filled</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetSaturation()"><!-- --></A>
|
|
<A NAME="GetSaturation"><!-- --></A>
|
|
<H3>GetSaturation</H3>
|
|
<PRE>
|
|
public int <B>GetSaturation</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current saturation.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>saturation value in the range -100 to 100</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetSharpness()"><!-- --></A>
|
|
<A NAME="GetSharpness"><!-- --></A>
|
|
<H3>GetSharpness</H3>
|
|
<PRE>
|
|
public int <B>GetSharpness</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current sharpness for the NTSC filter.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>sharpness value in the range -100 to 100</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="IsFieldMergingEnabled()"><!-- --></A>
|
|
<A NAME="IsFieldMergingEnabled"><!-- --></A>
|
|
<H3>IsFieldMergingEnabled</H3>
|
|
<PRE>
|
|
public bool <B>IsFieldMergingEnabled</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Checks if NTSC filter field merging is enabled.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>true if enabled</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetBrightness(int)"><!-- --></A>
|
|
<A NAME="SetBrightness"><!-- --></A>
|
|
<H3>SetBrightness</H3>
|
|
<PRE>
|
|
public Result <B>SetBrightness</B>( int value ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the brightness.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>value</code> - brightness in the range -100 to 100, default is 0</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetColorArtifacts(int)"><!-- --></A>
|
|
<A NAME="SetColorArtifacts"><!-- --></A>
|
|
<H3>SetColorArtifacts</H3>
|
|
<PRE>
|
|
public Result <B>SetColorArtifacts</B>( int value ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the color artifacts for the NTSC filter.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>value</code> - color artifacts in the range -100 to 100, default is 0</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetColorBleed(int)"><!-- --></A>
|
|
<A NAME="SetColorBleed"><!-- --></A>
|
|
<H3>SetColorBleed</H3>
|
|
<PRE>
|
|
public Result <B>SetColorBleed</B>( int value ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the color bleed for the NTSC filter.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>value</code> - color bleed in the range -100 to 100, default is 0</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetColorFringing(int)"><!-- --></A>
|
|
<A NAME="SetColorFringing"><!-- --></A>
|
|
<H3>SetColorFringing</H3>
|
|
<PRE>
|
|
public Result <B>SetColorFringing</B>( int value ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the color fringing for the NTSC filter.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>value</code> - fringing in the range -100 to 100, default is 0</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetColorResolution(int)"><!-- --></A>
|
|
<A NAME="SetColorResolution"><!-- --></A>
|
|
<H3>SetColorResolution</H3>
|
|
<PRE>
|
|
public Result <B>SetColorResolution</B>( int value ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the color resolution for the NTSC filter.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>value</code> - color resolution in the range -100 to 100, default is 0</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetContrast(int)"><!-- --></A>
|
|
<A NAME="SetContrast"><!-- --></A>
|
|
<H3>SetContrast</H3>
|
|
<PRE>
|
|
public Result <B>SetContrast</B>( int value ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the contrast.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>value</code> - contrast in the range -100 to 100, default is 0</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetDecoder(constDecoder&)"><!-- --></A>
|
|
<A NAME="SetDecoder"><!-- --></A>
|
|
<H3>SetDecoder</H3>
|
|
<PRE>
|
|
public Result <B>SetDecoder</B>( const <a href="../api/Nes..Api..Video..Decoder.html">Nes::Api::Video::Decoder</a>& decoder ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the YUV decoder.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>decoder</code> - decoder</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetHue(int)"><!-- --></A>
|
|
<A NAME="SetHue"><!-- --></A>
|
|
<H3>SetHue</H3>
|
|
<PRE>
|
|
public Result <B>SetHue</B>( int value ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the hue.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>value</code> - hue in the range -45 to 45, default is 0</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetRenderState(constRenderState&)"><!-- --></A>
|
|
<A NAME="SetRenderState"><!-- --></A>
|
|
<H3>SetRenderState</H3>
|
|
<PRE>
|
|
public Result <B>SetRenderState</B>( const <a href="../api/Nes..Api..Video..RenderState.html">Nes::Api::Video::RenderState</a>& state ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the render state.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>state</code> - render state to be set</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetSaturation(int)"><!-- --></A>
|
|
<A NAME="SetSaturation"><!-- --></A>
|
|
<H3>SetSaturation</H3>
|
|
<PRE>
|
|
public Result <B>SetSaturation</B>( int value ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the saturation.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>value</code> - saturation in the range -100 to 100, default is 0</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetSharpness(int)"><!-- --></A>
|
|
<A NAME="SetSharpness"><!-- --></A>
|
|
<H3>SetSharpness</H3>
|
|
<PRE>
|
|
public Result <B>SetSharpness</B>( int value ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the sharpness for the NTSC filter.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>value</code> - sharpness in the range -100 to 100, default is 0</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..Video.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top"><FONT SIZE="-2">
|
|
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
|
|
|
|
</BODY>
|
|
|
|
</HTML>
|
|
|