Wiki Page Content

Revision 10 as of 2010-04-27 23:32:05

Clear message

DRAFT

SDL 1.3 API 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

General
Functions in this category are used to set up SDL 1.3 for use and generally have global effects in your program.

Version
These functions are used to collect or display information about the version of SDL that is currently being used by the program. There are four (4) macros green

that apply to this header.

  • SDL_VERSION

    • This macro gathers information from SDL_MAJOR_VERSION, SDL_MINOR_VERSION, AND SDL_PATCHLEVEL (#defines) and fills the structure SDL_version with that information.

  • SDL_VERSIONNUM

    • A minor macro that converts version numbers into a numeric value.
  • SDL_COMPILEDVERSION

    • A minor macro that produces the current SDL version number (major.minor.patchlevel)
  • SDL_VERSION_ATLEAST

    • A minor macro that confirms whether a program was compiled with a version no older than the specified version.

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
(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit