SDL.h File Reference

#include "SDL_main.h"
#include "SDL_stdinc.h"
#include "SDL_assert.h"
#include "SDL_atomic.h"
#include "SDL_audio.h"
#include "SDL_clipboard.h"
#include "SDL_cpuinfo.h"
#include "SDL_endian.h"
#include "SDL_error.h"
#include "SDL_events.h"
#include "SDL_filesystem.h"
#include "SDL_joystick.h"
#include "SDL_gamecontroller.h"
#include "SDL_haptic.h"
#include "SDL_hints.h"
#include "SDL_loadso.h"
#include "SDL_log.h"
#include "SDL_messagebox.h"
#include "SDL_mutex.h"
#include "SDL_power.h"
#include "SDL_render.h"
#include "SDL_rwops.h"
#include "SDL_system.h"
#include "SDL_thread.h"
#include "SDL_timer.h"
#include "SDL_version.h"
#include "SDL_video.h"
#include "begin_code.h"
#include "close_code.h"

Go to the source code of this file.

Macros
SDL_INIT_*
These are the flags which may be passed to SDL_Init(). You should specify the subsystems which you will be using in your application.
#define	SDL_INIT_TIMER   0x00000001
#define	SDL_INIT_AUDIO   0x00000010
#define	SDL_INIT_VIDEO   0x00000020
#define	SDL_INIT_JOYSTICK   0x00000200
#define	SDL_INIT_HAPTIC   0x00001000
#define	SDL_INIT_GAMECONTROLLER   0x00002000
#define	SDL_INIT_EVENTS   0x00004000
#define	SDL_INIT_NOPARACHUTE   0x00100000
#define	SDL_INIT_EVERYTHING

Functions
DECLSPEC int SDLCALL	SDL_Init (Uint32 flags)
DECLSPEC int SDLCALL	SDL_InitSubSystem (Uint32 flags)
DECLSPEC void SDLCALL	SDL_QuitSubSystem (Uint32 flags)
DECLSPEC Uint32 SDLCALL	SDL_WasInit (Uint32 flags)
DECLSPEC void SDLCALL	SDL_Quit (void)

Detailed Description

Main include header for the SDL library

Macro Definition Documentation

#define SDL_INIT_EVERYTHING

Value:

( \
                SDL_INIT_TIMER | SDL_INIT_AUDIO | SDL_INIT_VIDEO | SDL_INIT_EVENTS | \
                SDL_INIT_JOYSTICK | SDL_INIT_HAPTIC | SDL_INIT_GAMECONTROLLER \
            )

#define SDL_INIT_GAMECONTROLLER   0x00002000

SDL_INIT_GAMECONTROLLER implies SDL_INIT_JOYSTICK

#define SDL_INIT_JOYSTICK   0x00000200

SDL_INIT_JOYSTICK implies SDL_INIT_EVENTS

#define SDL_INIT_NOPARACHUTE   0x00100000

compatibility; this flag is ignored.

#define SDL_INIT_VIDEO   0x00000020

SDL_INIT_VIDEO implies SDL_INIT_EVENTS

Function Documentation

DECLSPEC int SDLCALL SDL_Init

(

Uint32

flags

)

This function initializes the subsystems specified by flags

DECLSPEC int SDLCALL SDL_InitSubSystem

(

Uint32

flags

)

This function initializes specific SDL subsystems

Subsystem initialization is ref-counted, you must call SDL_QuitSubSystem for each SDL_InitSubSystem to correctly shutdown a subsystem manually (or call SDL_Quit to force shutdown). If a subsystem is already loaded then this call will increase the ref-count and return.

DECLSPEC void SDLCALL SDL_Quit

(

void

)

This function cleans up all initialized subsystems. You should call it upon all exit conditions.

DECLSPEC void SDLCALL SDL_QuitSubSystem

(

Uint32

flags

)

This function cleans up specific SDL subsystems

DECLSPEC Uint32 SDLCALL SDL_WasInit

(

Uint32

flags

)

This function returns a mask of the specified subsystems which have previously been initialized.

If flags is 0, it returns a mask of all initialized subsystems.