nestopia/doc/details/api/Nes..Api..Sound..Channel.html
2012-09-02 13:13:55 -04:00

388 lines
9.9 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::Sound::Channel</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"> &nbsp;<a href="../../index-overview-summary.html"><B>Overview</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="project-summary.html"><B>Project</B></a>&nbsp;</TD>
<TD BGCOLOR="navy"> <FONT COLOR="white">&nbsp;<B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="project-tree.html"><B>Tree</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-deprecated-list.html"><B>Deprecated</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-all.html"><B>Index</B></a>&nbsp;</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> &nbsp;
&nbsp;<a href="../api/Nes..Api..Sound..Channel.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
</TR>
<TR>
<TD VALIGN="top"><FONT SIZE="-2">
SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
api</FONT>
<BR>
Enum Nes::Api::Sound::Channel</H2>
<p>Sound channel types.
<p>
<HR>
<!-- =========== 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><CODE><B><a href="#ALL_CHANNELS">ALL_CHANNELS</a></B> = APU_CHANNELS | EXT_CHANNELS</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;All channels.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#APU_CHANNELS">APU_CHANNELS</a></B> = CHANNEL_SQUARE1 | CHANNEL_SQUARE2 | CHANNEL_TRIANGLE | CHANNEL_NOISE | CHANNEL_DPCM</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;All NES APU channels.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#CHANNEL_DPCM">CHANNEL_DPCM</a></B> = 0x010</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;DPCM channel.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#CHANNEL_FDS">CHANNEL_FDS</a></B> = 0x020</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;FDS sound chip channel.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#CHANNEL_MMC5">CHANNEL_MMC5</a></B> = 0x040</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;MMC5 sound chip channel.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#CHANNEL_N163">CHANNEL_N163</a></B> = 0x200</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Namcot 163 sound chip channel.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#CHANNEL_NOISE">CHANNEL_NOISE</a></B> = 0x008</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Noise channel.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#CHANNEL_S5B">CHANNEL_S5B</a></B> = 0x400</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sunsoft 5B sound chip channel.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#CHANNEL_SQUARE1">CHANNEL_SQUARE1</a></B> = 0x001</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;First square channel.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#CHANNEL_SQUARE2">CHANNEL_SQUARE2</a></B> = 0x002</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Second square channel.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#CHANNEL_TRIANGLE">CHANNEL_TRIANGLE</a></B> = 0x004</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Triangle channel.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#CHANNEL_VRC6">CHANNEL_VRC6</a></B> = 0x080</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Konami VRC6 sound chip channel.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#CHANNEL_VRC7">CHANNEL_VRC7</a></B> = 0x100</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Konami VRC7 sound chip channel.</TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#EXT_CHANNELS">EXT_CHANNELS</a></B> = CHANNEL_FDS | CHANNEL_MMC5 | CHANNEL_VRC6 | CHANNEL_VRC7 | CHANNEL_N163 | CHANNEL_S5B</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;All external sound chip channels.</TD>
</TR>
</TABLE>
&nbsp;
<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="ALL_CHANNELS"><!-- --></A>
<A NAME="ALL_CHANNELS"><!-- --></A>
<H3>ALL_CHANNELS</H3>
<PRE>
public <B>ALL_CHANNELS</B> = APU_CHANNELS | EXT_CHANNELS
</PRE>
<DL>
<DD>All channels.
</DD>
</DL>
<HR>
<A NAME="APU_CHANNELS"><!-- --></A>
<A NAME="APU_CHANNELS"><!-- --></A>
<H3>APU_CHANNELS</H3>
<PRE>
public <B>APU_CHANNELS</B> = CHANNEL_SQUARE1 | CHANNEL_SQUARE2 | CHANNEL_TRIANGLE | CHANNEL_NOISE | CHANNEL_DPCM
</PRE>
<DL>
<DD>All NES APU channels.
</DD>
</DL>
<HR>
<A NAME="CHANNEL_DPCM"><!-- --></A>
<A NAME="CHANNEL_DPCM"><!-- --></A>
<H3>CHANNEL_DPCM</H3>
<PRE>
public <B>CHANNEL_DPCM</B> = 0x010
</PRE>
<DL>
<DD>DPCM channel.
</DD>
</DL>
<HR>
<A NAME="CHANNEL_FDS"><!-- --></A>
<A NAME="CHANNEL_FDS"><!-- --></A>
<H3>CHANNEL_FDS</H3>
<PRE>
public <B>CHANNEL_FDS</B> = 0x020
</PRE>
<DL>
<DD>FDS sound chip channel.
</DD>
</DL>
<HR>
<A NAME="CHANNEL_MMC5"><!-- --></A>
<A NAME="CHANNEL_MMC5"><!-- --></A>
<H3>CHANNEL_MMC5</H3>
<PRE>
public <B>CHANNEL_MMC5</B> = 0x040
</PRE>
<DL>
<DD>MMC5 sound chip channel.
</DD>
</DL>
<HR>
<A NAME="CHANNEL_N163"><!-- --></A>
<A NAME="CHANNEL_N163"><!-- --></A>
<H3>CHANNEL_N163</H3>
<PRE>
public <B>CHANNEL_N163</B> = 0x200
</PRE>
<DL>
<DD>Namcot 163 sound chip channel.
</DD>
</DL>
<HR>
<A NAME="CHANNEL_NOISE"><!-- --></A>
<A NAME="CHANNEL_NOISE"><!-- --></A>
<H3>CHANNEL_NOISE</H3>
<PRE>
public <B>CHANNEL_NOISE</B> = 0x008
</PRE>
<DL>
<DD>Noise channel.
</DD>
</DL>
<HR>
<A NAME="CHANNEL_S5B"><!-- --></A>
<A NAME="CHANNEL_S5B"><!-- --></A>
<H3>CHANNEL_S5B</H3>
<PRE>
public <B>CHANNEL_S5B</B> = 0x400
</PRE>
<DL>
<DD>Sunsoft 5B sound chip channel.
</DD>
</DL>
<HR>
<A NAME="CHANNEL_SQUARE1"><!-- --></A>
<A NAME="CHANNEL_SQUARE1"><!-- --></A>
<H3>CHANNEL_SQUARE1</H3>
<PRE>
public <B>CHANNEL_SQUARE1</B> = 0x001
</PRE>
<DL>
<DD>First square channel.
</DD>
</DL>
<HR>
<A NAME="CHANNEL_SQUARE2"><!-- --></A>
<A NAME="CHANNEL_SQUARE2"><!-- --></A>
<H3>CHANNEL_SQUARE2</H3>
<PRE>
public <B>CHANNEL_SQUARE2</B> = 0x002
</PRE>
<DL>
<DD>Second square channel.
</DD>
</DL>
<HR>
<A NAME="CHANNEL_TRIANGLE"><!-- --></A>
<A NAME="CHANNEL_TRIANGLE"><!-- --></A>
<H3>CHANNEL_TRIANGLE</H3>
<PRE>
public <B>CHANNEL_TRIANGLE</B> = 0x004
</PRE>
<DL>
<DD>Triangle channel.
</DD>
</DL>
<HR>
<A NAME="CHANNEL_VRC6"><!-- --></A>
<A NAME="CHANNEL_VRC6"><!-- --></A>
<H3>CHANNEL_VRC6</H3>
<PRE>
public <B>CHANNEL_VRC6</B> = 0x080
</PRE>
<DL>
<DD>Konami VRC6 sound chip channel.
</DD>
</DL>
<HR>
<A NAME="CHANNEL_VRC7"><!-- --></A>
<A NAME="CHANNEL_VRC7"><!-- --></A>
<H3>CHANNEL_VRC7</H3>
<PRE>
public <B>CHANNEL_VRC7</B> = 0x100
</PRE>
<DL>
<DD>Konami VRC7 sound chip channel.
</DD>
</DL>
<HR>
<A NAME="EXT_CHANNELS"><!-- --></A>
<A NAME="EXT_CHANNELS"><!-- --></A>
<H3>EXT_CHANNELS</H3>
<PRE>
public <B>EXT_CHANNELS</B> = CHANNEL_FDS | CHANNEL_MMC5 | CHANNEL_VRC6 | CHANNEL_VRC7 | CHANNEL_N163 | CHANNEL_S5B
</PRE>
<DL>
<DD>All external sound chip channels.
</DD>
</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"> &nbsp;<a href="../../index-overview-summary.html"><B>Overview</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="project-summary.html"><B>Project</B></a>&nbsp;</TD>
<TD BGCOLOR="navy"> <FONT COLOR="white">&nbsp;<B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="project-tree.html"><B>Tree</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-deprecated-list.html"><B>Deprecated</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-all.html"><B>Index</B></a>&nbsp;</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> &nbsp;
&nbsp;<a href="../api/Nes..Api..Sound..Channel.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
</TR>
<TR>
<TD VALIGN="top"><FONT SIZE="-2">
SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>