Wiki Page Content

Differences between revisions 1 and 9 (spanning 8 versions)
⇤ ← Revision 1 as of 2010-04-15 05:19:02 →
Size: 30
Editor: SheenaSmith
Comment: create page, blank
← Revision 9 as of 2010-04-27 23:12:28 → ⇥
Size: 7215
Editor: SheenaSmith
Comment: add content (basic format ver 2)
Deletions are marked like this. Additions are marked like this.
Line 1: 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]]||
||[[CategoryAtomic|Atomic Operations for 32 and 64 Bit Values]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_atomic.h|SDL_atomic.h]]||
||[[CategoryVersion|Querying SDL Version]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_version.h|SDL_version.h]]||

<<Color2(green,Does SDL_error.h belong in this section?)>>

||[[CategoryError|Error Handling]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_error.h|SDL_error.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]]||
||[[CategorySWM|Platform-specific Window Management]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_syswm.h|SDL_syswm.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|Thread Management]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_thread.h|SDL_thread.h]]||
||[[CategoryMutex|Thread Synchronization Primitives]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_mutex.h|SDL_mutex.h]]||

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

||<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]]||
||[[CategoryEvents|Event Handling]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_events.h|SDL_events.h]]||

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

||<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]]||
||[[CategoryPlatform|Platform Detection]]||[[http://hg.libsdl.org/SDL/file/68dfd6df47da/include/SDL_platform.h|SDL_platform.h]]||

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

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

=== Endian Independence ===
[[#EndianI|Introduction to Endian Independence (Byte Order and Byte Swapping)]]

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

----

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

DRAFT

SDL 1.3 API by Category

Contents

  1. SDL 1.3 API by Category
    1. Functions by Type
      1. Initialization
      2. Video
      3. Input
      4. Force Feedback
      5. Audio
      6. File I/O Abstraction
      7. Shared Object Support
      8. Threads
      9. Timers
      10. CPU Feature Detection
      11. Power Management
      12. Endian Independence
    2. Introductory Information by Category

Functions by Type

Initialization

Introduction to Initialization

View a List of Functions Related to...

View the Header

Initialization & Shutdown

SDL.h

Atomic Operations for 32 and 64 Bit Values

SDL_atomic.h

Querying SDL Version

SDL_version.h

green

Error Handling

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

Platform-specific Window Management

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

Thread Synchronization Primitives

SDL_mutex.h

Timers

Introduction to Timers

View a List of Functions Related to...

View the Header

Timer Support

SDL_timer.h

Event Handling

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

Platform Detection

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

None: APIByCategory (last edited 2020-01-13 13:44:18 by markand)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit