Added new docs for SDL 1.2.1

libsdl-org · Jun 10, 2001 · 013f3b5 · 013f3b5
1 parent 775b695
commit 013f3b5
Show file tree

Hide file tree

Showing 371 changed files with 3,244 additions and 2,259 deletions.
diff --git a/docs/html/Makefile.am b/docs/html/Makefile.am
@@ -20,6 +20,7 @@ EXTRA_DIST = \
     guidetimeexamples.html \
     guidevideo.html \
     guidevideoexamples.html \
+    guidevideoopengl.html \
     index.html \
     joystick.html \
     reference.html \

diff --git a/docs/html/audio.html b/docs/html/audio.html
@@ -4,7 +4,7 @@
 >Audio</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"

diff --git a/docs/html/cdrom.html b/docs/html/cdrom.html
@@ -4,7 +4,7 @@
 >CD-ROM</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"

diff --git a/docs/html/event.html b/docs/html/event.html
@@ -4,7 +4,7 @@
 >Events</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"
@@ -85,7 +85,7 @@
 ></DT
 ><DT
 ><A
-HREF="event.html#AEN3194"
+HREF="event.html#AEN3269"
 >Introduction</A
 ></DT
 ><DT
@@ -105,7 +105,7 @@
 ><H1
 CLASS="SECT1"
 ><A
-NAME="AEN3194"
+NAME="AEN3269"
 >Introduction</A
 ></H1
 ><P

diff --git a/docs/html/eventfunctions.html b/docs/html/eventfunctions.html
@@ -4,7 +4,7 @@
 >Event Functions.</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"

diff --git a/docs/html/eventstructures.html b/docs/html/eventstructures.html
@@ -4,7 +4,7 @@
 >SDL Event Structures.</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"

diff --git a/docs/html/general.html b/docs/html/general.html
@@ -4,7 +4,7 @@
 >General</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"

diff --git a/docs/html/guide.html b/docs/html/guide.html
@@ -4,7 +4,7 @@
 >SDL Guide</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"

diff --git a/docs/html/guideaboutsdldoc.html b/docs/html/guideaboutsdldoc.html
@@ -4,7 +4,7 @@
 >About SDLdoc</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"
@@ -74,9 +74,9 @@
 >About SDLdoc</A
 ></H1
 ><P
->SDLdoc (The SDL Documentation Project) was formed to completely rewrite the SDL documentation and to keep it continually up to date. The team consists completely of volunteers ranging from proplr working with SDL in their spare time to people who use SDL in their everyday working lives.</P
+>SDLdoc (The SDL Documentation Project) was formed to completely rewrite the SDL documentation and to keep it continually up to date. The team consists completely of volunteers ranging from people working with SDL in their spare time to people who use SDL in their everyday working lives.</P
 ><P
->The latest version of this documentation can always be found at the project homepage: http://sdldoc.sourceforge.net.</P
+>The latest version of this documentation can always be found here: http://sdldoc.csn.ul.ie  Downloadable PS, man pages and html tarballs are available at http://sdldoc.csn.ul.ie/pub/</P
 ></DIV
 ><DIV
 CLASS="NAVFOOTER"

diff --git a/docs/html/guideaudioexamples.html b/docs/html/guideaudioexamples.html
@@ -4,7 +4,7 @@
 >Audio Examples</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"
@@ -80,7 +80,7 @@
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN343"
+NAME="AEN382"
 >Opening the audio device</A
 ></H2
 ><P
@@ -110,7 +110,7 @@
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN347"
+NAME="AEN386"
 >Playing audio</A
 ></H2
 ><P

diff --git a/docs/html/guidebasicsinit.html b/docs/html/guidebasicsinit.html
@@ -4,7 +4,7 @@
 >Initializing SDL</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"
@@ -133,7 +133,15 @@
 CLASS="FUNCTION"
 >SDL_GetError</TT
 >. Use this often, you can never know too much about an error.</P
+><DIV
+CLASS="EXAMPLE"
+><A
+NAME="AEN60"
+></A
 ><P
+><B
+>Example 1-1. Initializing SDL</B
+></P
 ><PRE
 CLASS="PROGRAMLISTING"
 >#include "SDL.h"   /* All SDL App's need this */
@@ -160,7 +168,7 @@
 
     exit(0);
 }&#13;</PRE
-></P
+></DIV
 ></DIV
 ><DIV
 CLASS="NAVFOOTER"

diff --git a/docs/html/guidecdromexamples.html b/docs/html/guidecdromexamples.html
@@ -4,7 +4,7 @@
 >CDROM Examples</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"
@@ -80,7 +80,7 @@
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN354"
+NAME="AEN393"
 >Listing CD-ROM drives</A
 ></H2
 ><P
@@ -107,7 +107,7 @@
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN358"
+NAME="AEN397"
 >Opening the default drive</A
 ></H2
 ><P
@@ -156,7 +156,7 @@
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN362"
+NAME="AEN401"
 >Listing the tracks on a CD</A
 ></H2
 ><P
@@ -182,7 +182,7 @@
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN366"
+NAME="AEN405"
 >Play an entire CD</A
 ></H2
 ><P

diff --git a/docs/html/guidecredits.html b/docs/html/guidecredits.html
@@ -4,7 +4,7 @@
 >Credits</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"
@@ -81,10 +81,18 @@
 ><TBODY
 ><TR
 ><TD
+>Sam Lantinga, slouken@libsdl.org</TD
+></TR
+><TR
+><TD
 >Martin Donlon, akawaka@skynet.ie</TD
 ></TR
 ><TR
 ><TD
+>Mattias Engdegård</TD
+></TR
+><TR
+><TD
 >Julian Peterson</TD
 ></TR
 ><TR

diff --git a/docs/html/guideeventexamples.html b/docs/html/guideeventexamples.html
@@ -4,7 +4,7 @@
 >Event Examples</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"
@@ -13,8 +13,8 @@
 TITLE="Examples"
 HREF="guideexamples.html"><LINK
 REL="PREVIOUS"
-TITLE="Video Examples"
-HREF="guidevideoexamples.html"><LINK
+TITLE="Examples"
+HREF="guideexamples.html"><LINK
 REL="NEXT"
 TITLE="Audio Examples"
 HREF="guideaudioexamples.html"></HEAD
@@ -44,7 +44,7 @@
 ALIGN="left"
 VALIGN="bottom"
 ><A
-HREF="guidevideoexamples.html"
+HREF="guideexamples.html"
 >Prev</A
 ></TD
 ><TD
@@ -80,7 +80,7 @@
 ><H2
 CLASS="SECT2"
 ><A
-NAME="AEN336"
+NAME="AEN375"
 >Filtering and Handling Events</A
 ></H2
 ><P
@@ -192,7 +192,7 @@
 ALIGN="left"
 VALIGN="top"
 ><A
-HREF="guidevideoexamples.html"
+HREF="guideexamples.html"
 >Prev</A
 ></TD
 ><TD
@@ -217,7 +217,7 @@
 WIDTH="33%"
 ALIGN="left"
 VALIGN="top"
->Video Examples</TD
+>Examples</TD
 ><TD
 WIDTH="34%"
 ALIGN="center"

diff --git a/docs/html/guideexamples.html b/docs/html/guideexamples.html
@@ -4,7 +4,7 @@
 >Examples</TITLE
 ><META
 NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+CONTENT="Modular DocBook HTML Stylesheet Version 1.64
 "><LINK
 REL="HOME"
 TITLE="SDL Library Documentation"
@@ -16,8 +16,8 @@
 TITLE="Handling the Keyboard"
 HREF="guideinputkeyboard.html"><LINK
 REL="NEXT"
-TITLE="Video Examples"
-HREF="guidevideoexamples.html"></HEAD
+TITLE="Event Examples"
+HREF="guideeventexamples.html"></HEAD
 ><BODY
 CLASS="CHAPTER"
 BGCOLOR="#FFF8DC"
@@ -57,7 +57,7 @@
 ALIGN="right"
 VALIGN="bottom"
 ><A
-HREF="guidevideoexamples.html"
+HREF="guideeventexamples.html"
 >Next</A
 ></TD
 ></TR
@@ -81,16 +81,11 @@
 ></DT
 ><DT
 ><A
-HREF="guideexamples.html#AEN297"
+HREF="guideexamples.html#AEN369"
 >Introduction</A
 ></DT
 ><DT
 ><A
-HREF="guidevideoexamples.html"
->Video Examples</A
-></DT
-><DT
-><A
 HREF="guideeventexamples.html"
 >Event Examples</A
 ></DT
@@ -116,11 +111,11 @@
 ><H1
 CLASS="SECT1"
 ><A
-NAME="AEN297"
+NAME="AEN369"
 >Introduction</A
 ></H1
 ><P
->For the moment these examples are taken directly from the old SDL documentation.</P
+>For the moment these examples are taken directly from the old SDL documentation. By the 1.2 release these examples should hopefully deal with most common SDL programming problems.</P
 ></DIV
 ></DIV
 ><DIV
@@ -154,7 +149,7 @@
 ALIGN="right"
 VALIGN="top"
 ><A
-HREF="guidevideoexamples.html"
+HREF="guideeventexamples.html"
 >Next</A
 ></TD
 ></TR
@@ -176,10 +171,10 @@
 WIDTH="33%"
 ALIGN="right"
 VALIGN="top"
->Video Examples</TD
+>Event Examples</TD
 ></TR
 ></TABLE
 ></DIV
 ></BODY
 ></HTML
->
+>