X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fnes.sgml;h=3f8f74183c59b5285b88610b0bfab32e9270f58c;hb=df80d071e8eeb799bd1d8ec55acd1ee92714c752;hp=aab7aa519ce28141c20b591708e0a408deadac88;hpb=420d29a37e0b703a2201de286dfd94e7a485433c;p=cc65 diff --git a/doc/nes.sgml b/doc/nes.sgml index aab7aa519..3f8f74183 100644 --- a/doc/nes.sgml +++ b/doc/nes.sgml @@ -1,11 +1,10 @@
- Nintendo Entertainment System specific information for cc65 -<author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org"> -Stefan A. Haubenthal, <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org"> -<date>2005-07-17 +<author> +<url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz">,<newline> +<url url="mailto:polluks@sdf.lonestar.org" name="Stefan A. Haubenthal"> <abstract> An overview over the NES runtime system as it is implemented for the @@ -24,7 +23,7 @@ with the cc65 C compiler. It describes the memory layout, NES specific header files, available drivers, and any pitfalls specific to that platform. Please note that NES specific functions are just mentioned here, they are -described in detail in the separate <htmlurl url="funcref.html" name="function +described in detail in the separate <url url="funcref.html" name="function reference">. Even functions marked as "platform dependent" may be available on more than one platform. Please see the function reference for more information. @@ -68,8 +67,8 @@ Programs containing NES specific code may use the <tt/nes.h/ header file. <sect1>NES specific functions<p> <itemize> -<item>waitvblank -<item>get_tv +<item>waitvsync - wait until the start of the next frame</item> +<item>get_tv</item> </itemize> @@ -94,17 +93,20 @@ allow access to hardware located in the address space. <sect>Loadable drivers<p> All drivers must be statically linked because no file I/O is available. +The names in the parentheses denote the symbols to be used for static linking of the drivers. + <sect1>Graphics drivers<p> <descrip> - <tag><tt/nes-64-56-2.tgi/</tag> + <tag><tt/nes-64-56-2.tgi (nes_64_56_2)/</tag> This driver features a resolution of 64×56 with 2 colors using the CHR bank. </descrip><p> + <sect1>Extended memory drivers<p> No extended memory drivers are currently available for the NES. @@ -112,7 +114,21 @@ No extended memory drivers are currently available for the NES. <sect1>Joystick drivers<p> -A joystick driver for the standard four buttons joypad is available. +<descrip> + + <tag><tt/nes-stdjoy.joy (nes_stdjoy)/</tag> + A joystick driver for the standard four buttons joypad is available. + +</descrip><p> + +The generic interface doesn't export the start and select buttons. To +test for those, use the defines in nes.h instead of the generic masks. + +Example: +<tscreen><verb> +if (joy_read(0) & KEY_A) +</verb></tscreen> + <sect1>Mouse drivers<p> @@ -152,15 +168,6 @@ following functions (and a few others): -<sect>Bugs/Feedback<p> - -If you have problems using the library, if you find any bugs, or if you're -doing something interesting with it, I would be glad to hear from you. Feel -free to contact me by email (<htmlurl url="mailto:uz@cc65.org" -name="uz@cc65.org">). - - - <sect>License<p> This software is provided 'as-is', without any expressed or implied @@ -172,17 +179,14 @@ including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: <enum> -<item> The origin of this software must not be misrepresented; you must not - claim that you wrote the original software. If you use this software - in a product, an acknowledgment in the product documentation would be - appreciated but is not required. -<item> Altered source versions must be plainly marked as such, and must not - be misrepresented as being the original software. -<item> This notice may not be removed or altered from any source - distribution. +<item> The origin of this software must not be misrepresented; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. +<item> Altered source versions must be plainly marked as such, and must not + be misrepresented as being the original software. +<item> This notice may not be removed or altered from any source + distribution. </enum> </article> - - -