Differences between revisions 1 and 7 (spanning 6 versions)

DRAFT

SDL 1.3 API by Category

Contents

SDL 1.3 API by Category
1. Functions by Type
2. Introductory Information by Category

Functions by Type

Initialization

View a List of Functions Related to...	View the Header
Initialization & Shutdown	SDL.h

Video

Introduction to Video

View a List of Functions Related to...	View the Header
Display Management, Window Management and Rendering	SDL_video.h
Pixel Formats and Conversion Routines	SDL_pixels.h
Rectangle Functions	SDL_rect.h
Surface Creation and Simple Drawing	SDL_surface.h

Input

Introduction to Input

View a List of Functions Related to...	View the Header
Joystick Support	SDL_joystick.h
Keyboard Support	SDL_keyboard.h
Mouse Support	SDL_mouse.h

Force Feedback

Introduction to Force Feedback

View a List of Functions Related to...	View the Header
Force Feedback Support	SDL_haptic.h

Audio

Introduction to Audio

View a List of Functions Related to...	View the Header
Audio Device Management, Playing and Recording	SDL_audio.h

File I/O Abstraction

Introduction to File I/O Abstraction

View a List of Functions Related to...	View the Header
File I/O Abstraction	SDL_rwops.h

Shared Object Support

Introduction to Shared Object Support

View a List of Functions Related to...	View the Header
Shared Object Loading and Function Lookup	SDL_loadso.h

Threads

Introduction to Threads

View a List of Functions Related to...	View the Header
CategoryThread	[[]]

Timers

Introduction to Timers

View a List of Functions Related to...	View the Header
CategoryTimer	[[]]

CPU Feature Detection

Introduction to CPU Feature Detection

View a List of Functions Related to...	View the Header
CategoryCPU	[[]]

Power Management

Introduction to Power Management

View a List of Functions Related to...	View the Header
CategoryPower	[[]]

Endian Independence

Introduction to Endian

View a List of Functions Related to...	View the Header
CategoryEndian	[[]]

Introductory Information by Category

Introduction to Initialization

Introduction to Video

Introduction to Input

Introduction to Force Feedback

Introduction to Audio

Introduction to File I/O Abstraction

Introduction to Shared Object Support

Introduction to Threads

Introduction to Timers

Introduction to CPU Feature Detection

Introduction to Power Management

Introduction to Endian Independence

green

-OR -

In each section:

For more detailed information on each Category, including how to get started, answers to common questions and errors, and more, click the Introduction to... link in each section
For a list of functions found in each header click the link under Related Functions
- You will find links to detailed pages about each function on those pages
For the header file itself click the link under Header in each section

-OR-

Each section below includes

a link to introductory information about each function type including, where relevant:
- green
a link to one or more pages containing a complete list of functions belonging to each header in that category
- listed functions link to detailed information on each
a link to the header page

-  ⇤ ← Revision 1 as of 2010-04-15 05:19:02 → 
  Size: 30
  Editor: SheenaSmith
  Comment: create page, blank
+   ← Revision 7 as of 2010-04-27 22:22:30 → ⇥
  Size: 5673
  Editor: SheenaSmith
  Comment: change format
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
-Describe APIbyCategory here.
+##master-page:CategoryTemplate
##master-date:Unknown-Date
#format wiki
#language en
||<tablewidth="100%" style="color: #FF0000;" :> DRAFT||

= SDL 1.3 API by Category =

<<TableOfContents()>>

== Functions by Type ==

=== Initialization ===
[[#InitI|Introduction to Initialization]]

||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryInit|Initialization & Shutdown]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL.h|SDL.h]]||

=== Video ===
[[#VideoI|Introduction to Video]]

||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryVideo|Display Management, Window Management and Rendering]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_video.h|SDL_video.h]]||
||[[CategoryPixels|Pixel Formats and Conversion Routines]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_pixels.h|SDL_pixels.h]]||
||[[CategoryRect|Rectangle Functions]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_rect.h|SDL_rect.h]]||
||[[CategorySurface|Surface Creation and Simple Drawing]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_surface.h|SDL_surface.h]]||

=== Input ===
[[#InputI|Introduction to Input]]

||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryJoystick|Joystick Support]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_joystick.h|SDL_joystick.h]]||
||[[CategoryKeyboard|Keyboard Support]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_keyboard.h|SDL_keyboard.h]]||
||[[CategoryMouse|Mouse Support]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_mouse.h|SDL_mouse.h]]||

=== Force Feedback ===
[[#FFI|Introduction to Force Feedback]]

||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryForceFeedback|Force Feedback Support]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_haptic.h|SDL_haptic.h]]||

=== Audio ===
[[#AudioI|Introduction to Audio]]

||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryAudio|Audio Device Management, Playing and Recording]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_audio.h|SDL_audio.h]]||

=== File I/O Abstraction ===
[[#I/OI|Introduction to File I/O Abstraction]]

||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryIO|File I/O Abstraction]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_rwops.h|SDL_rwops.h]]||

=== Shared Object Support ===
[[#SOSI|Introduction to Shared Object Support]]

||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategorySharedObject|Shared Object Loading and Function Lookup]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_loadso.h|SDL_loadso.h]]||

=== Threads ===
[[#ThreadsI|Introduction to Threads]]

||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryThread|]]||[[]]||

=== Timers ===
[[#TimersI|Introduction to Timers]]

||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryTimer|]]||[[]]||

=== CPU Feature Detection ===
[[#CPUI|Introduction to CPU Feature Detection]]

||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryCPU|]]||[[]]||

=== Power Management ===
[[#PowerI|Introduction to Power Management]]

||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryPower|]]||[[]]||

=== Endian Independence ===
[[#EndianI|Introduction to Endian]]

||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryEndian|]]||[[]]||

----

== Introductory Information by Category ==

<<Anchor(InitI)>>'''Introduction to Initialization'''

<<Anchor(VideoI)>>'''Introduction to Video'''

<<Anchor(InputI)>>'''Introduction to Input'''

<<Anchor(FFI)>>'''Introduction to Force Feedback'''

<<Anchor(AudioI)>>'''Introduction to Audio'''

<<Anchor(I/OI)>>'''Introduction to File I/O Abstraction'''

<<Anchor(SOSI)>>'''Introduction to Shared Object Support'''

<<Anchor(ThreadsI)>>'''Introduction to Threads'''

<<Anchor(TimersI)>>'''Introduction to Timers'''

<<Anchor(CPUI)>>'''Introduction to CPU Feature Detection'''

<<Anchor(PowerI)>>'''Introduction to Power Management'''

<<Anchor(EndianI)>>'''Introduction to Endian Independence'''

----
<<Color2(green,This section is junk I don't want to lose yet but will most likely delete. Ignore it.)>>
-OR -

In each section:
 * For more detailed information on each Category, including how to get started, answers to common questions and errors, and more, click the '''Introduction to...''' link in each section
 * For a list of functions found in each header click the link under '''Related Functions'''
  * You will find links to detailed pages about each function on those pages
 * For the header file itself click the link under '''Header''' in each section

-OR-

Each section below includes 
 * a link to introductory information about each function type including, where relevant:
  * <<Color2(green,Add a list here of the common sections found on each introductory page as the list develops.)>>
 * a link to one or more pages containing a complete list of functions belonging to each header in that category
  * listed functions link to detailed information on each
 * a link to the header page

Wiki Navigation

Wiki Page Content