Safe Haskell	None
Language	GHC2021

SDL3.Sys.Bindgen.Init

Description

All SDL programs need to initialize the library before starting to work with it.

Almost everything can simply call SDL_Init() near startup, with a handful of flags to specify subsystems to touch. These are here to make sure SDL does not even attempt to touch low-level pieces of the operating system that you don't intend to use. For example, you might be using SDL for video and input but chose an external library for audio, and in this case you would just need to leave off the sDL_INIT_AUDIO flag to make sure that external library has complete control.

Most apps, when terminating, should call SDL_Quit(). This will clean up (nearly) everything that SDL might have allocated, and crucially, it'll make sure that the display's resolution is back to what the user expects if you had previously changed it for your game.

SDL3 apps are strongly encouraged to call SDL_SetAppMetadata() at startup to fill in details about the program. This is completely optional, but it helps in small ways (we can provide an About dialog box for the macOS menu, we can name the app in the system's audio mixer, etc). Those that want to provide a lot of information should look at the more-detailed SDL_SetAppMetadataProperty(). Initialization flags for SDL_Init and/or SDL_InitSubSystem

These are the flags which may be passed to SDL_Init(). You should specify the subsystems which you will be using in your application.

See also: sDL_Init, sDL_Quit, sDL_InitSubSystem, sDL_QuitSubSystem, sDL_WasInit

Since: 3.2.0

Synopsis

newtype SDL_InitFlags = SDL_InitFlags {
- unwrap :: Uint32
}
sDL_INIT_AUDIO :: CUInt
sDL_INIT_VIDEO :: CUInt
sDL_INIT_JOYSTICK :: CUInt
sDL_INIT_HAPTIC :: CUInt
sDL_INIT_GAMEPAD :: CUInt
sDL_INIT_EVENTS :: CUInt
sDL_INIT_SENSOR :: CUInt
sDL_INIT_CAMERA :: CUInt
newtype SDL_AppResult = SDL_AppResult {
- unwrap :: CUInt
}
pattern SDL_APP_CONTINUE :: SDL_AppResult
pattern SDL_APP_SUCCESS :: SDL_AppResult
pattern SDL_APP_FAILURE :: SDL_AppResult
newtype SDL_AppInit_func_Aux = SDL_AppInit_func_Aux {
- unwrap :: Ptr (Ptr Void) -> CInt -> Ptr (Elem (IncompleteArray (Ptr CChar))) -> IO SDL_AppResult
}
newtype SDL_AppInit_func = SDL_AppInit_func {
- unwrap :: FunPtr SDL_AppInit_func_Aux
}
newtype SDL_AppIterate_func_Aux = SDL_AppIterate_func_Aux {
- unwrap :: Ptr Void -> IO SDL_AppResult
}
newtype SDL_AppIterate_func = SDL_AppIterate_func {
- unwrap :: FunPtr SDL_AppIterate_func_Aux
}
newtype SDL_AppEvent_func_Aux = SDL_AppEvent_func_Aux {
- unwrap :: Ptr Void -> Ptr SDL_Event -> IO SDL_AppResult
}
newtype SDL_AppEvent_func = SDL_AppEvent_func {
- unwrap :: FunPtr SDL_AppEvent_func_Aux
}
newtype SDL_AppQuit_func_Aux = SDL_AppQuit_func_Aux {
- unwrap :: Ptr Void -> SDL_AppResult -> IO ()
}
newtype SDL_AppQuit_func = SDL_AppQuit_func {
- unwrap :: FunPtr SDL_AppQuit_func_Aux
}
newtype SDL_MainThreadCallback_Aux = SDL_MainThreadCallback_Aux {
- unwrap :: Ptr Void -> IO ()
}
newtype SDL_MainThreadCallback = SDL_MainThreadCallback {
- unwrap :: FunPtr SDL_MainThreadCallback_Aux
}
sDL_PROP_APP_METADATA_NAME_STRING :: ByteString
sDL_PROP_APP_METADATA_VERSION_STRING :: ByteString
sDL_PROP_APP_METADATA_IDENTIFIER_STRING :: ByteString
sDL_PROP_APP_METADATA_CREATOR_STRING :: ByteString
sDL_PROP_APP_METADATA_COPYRIGHT_STRING :: ByteString
sDL_PROP_APP_METADATA_URL_STRING :: ByteString
sDL_PROP_APP_METADATA_TYPE_STRING :: ByteString

Documentation

newtype SDL_InitFlags Source #

C declaration: SDL_InitFlags, defined at SDL3/SDL_init.h 78:16

Constructors

SDL_InitFlags
Fields unwrap :: Uint32

Instances

Instances details

Bits SDL_InitFlags Source #

Instance details

SDL_AppInit_func_Aux
Fields unwrap :: Ptr (Ptr Void) -> CInt -> Ptr (Elem (IncompleteArray (Ptr CChar))) -> IO SDL_AppResult

SDL_AppInit_func
Fields unwrap :: FunPtr SDL_AppInit_func_Aux

SDL_AppIterate_func_Aux
Fields unwrap :: Ptr Void -> IO SDL_AppResult

SDL_AppIterate_func
Fields unwrap :: FunPtr SDL_AppIterate_func_Aux

SDL_AppEvent_func_Aux
Fields unwrap :: Ptr Void -> Ptr SDL_Event -> IO SDL_AppResult

SDL_AppEvent_func
Fields unwrap :: FunPtr SDL_AppEvent_func_Aux

SDL_AppQuit_func_Aux
Fields unwrap :: Ptr Void -> SDL_AppResult -> IO ()

SDL_AppQuit_func
Fields unwrap :: FunPtr SDL_AppQuit_func_Aux

SDL_MainThreadCallback_Aux
Fields unwrap :: Ptr Void -> IO ()

SDL_MainThreadCallback
Fields unwrap :: FunPtr SDL_MainThreadCallback_Aux