Differences between revisions 6 and 8 (spanning 2 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
Thread Management	SDL_thread.h

Timers

Introduction to Timers

View a List of Functions Related to...	View the Header
Timer Support	SDL_timer.h

CPU Feature Detection

Introduction to CPU Feature Detection

View a List of Functions Related to...	View the Header
CPU Feature Detection	SDL_cpuinfo.h

Power Management

Introduction to Power Management

View a List of Functions Related to...	View the Header
Power Management Status	SDL_power.h

Endian Independence

Introduction to Endian Independence (Byte Order and Byte Swapping)

View a List of Functions Related to...	View the Header
Byte Order and Byte Swapping	SDL_endian.h

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 (Byte Order and Byte Swapping)

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 6 as of 2010-04-24 06:14:06 → 
  Size: 5437
  Editor: SheenaSmith
  Comment: add content (basic format ver 1)
+   ← Revision 8 as of 2010-04-27 22:32:56 → ⇥
  Size: 6228
  Editor: SheenaSmith
  Comment: add content (basic format ver 2)
-Deletions are marked like this.
+Additions are marked like this.
 Line 12:
-''In each section below you will find:''

Introduction to [Category]
 Clicking this link will take you to a detailed description of that category in SDL 1.3.  
  
||<tablewidth="100%">'''Related Functions'''||'''Header'''||
||This column contains 1 or more links to pages with complete function lists.  You can jump directly from these lists to detailed pages about each function.||This column contains a link to the actual header file.||

-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
-Line 40:
+Line 16:
-||<tablewidth="100%">'''Related Functions'''||'''Header'''||
+||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
-Line 46:
+Line 22:
-||<tablewidth="100%">'''Related Functions'''||'''Header'''||
+||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
-Line 55:
+Line 31:
-||<tablewidth="100%">'''Related Functions'''||'''Header'''||
+||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
-Line 63:
+Line 39:
-||<tablewidth="100%">'''Related Functions'''||'''Header'''||
+||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
-Line 69:
+Line 45:
-||<tablewidth="100%">'''Related Functions'''||'''Header'''||
+||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
-Line 75:
+Line 51:
-||<tablewidth="100%">'''Related Functions'''||'''Header'''||
||[[CategoryIO|]]||[[]]||
+||<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]]||
-Line 81:
+Line 57:
-||<tablewidth="100%">'''Related Functions'''||'''Header'''||
||[[CategorySharedObject|]]||[[]]||
+||<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]]||
-Line 87:
+Line 63:
-||<tablewidth="100%">'''Related Functions'''||'''Header'''||
||[[CategoryThread|]]||[[]]||
+||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryThread|Thread Management]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_thread.h|SDL_thread.h]]||
-Line 93:
+Line 69:
-||<tablewidth="100%">'''Related Functions'''||'''Header'''||
||[[CategoryTimer|]]||[[]]||
+||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryTimer|Timer Support]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_timer.h|SDL_timer.h]]||
-Line 99:
+Line 75:
-||<tablewidth="100%">'''Related Functions'''||'''Header'''||
||[[CategoryCPU|]]||[[]]||
+||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryCPU|CPU Feature Detection]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_cpuinfo.h|SDL_cpuinfo.h]]||
-Line 105:
+Line 81:
-||<tablewidth="100%">'''Related Functions'''||'''Header'''||
||[[CategoryPower|]]||[[]]||
+||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryPower|Power Management Status]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_power.h|SDL_power.h]]||
-Line 109:
+Line 85:
-[[#EndianI|Introduction to Endian]]
+[[#EndianI|Introduction to Endian Independence (Byte Order and Byte Swapping)]]
-Line 111:
+Line 87:
-||<tablewidth="100%">'''Related Functions'''||'''Header'''||
||[[CategoryEndian|]]||[[]]||
+||<tablewidth="100%">'''View a List of Functions Related to...'''||'''View the Header'''||
||[[CategoryEndian|Byte Order and Byte Swapping]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_endian.h|SDL_endian.h]]||
-Line 140:
+Line 116:
-<<Anchor(EndianI)>>'''Introduction to Endian Independence'''
+<<Anchor(EndianI)>>'''Introduction to Endian Independence (Byte Order and Byte Swapping)'''

----
<<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