Safe Haskell	None
Language	GHC2021

SDL3.Sys.Bindgen.Log

Description

Simple log messages with priorities and categories. A message's SDL_LogPriority signifies how important the message is. A message's SDL_LogCategory signifies from what domain it belongs to. Every category has a minimum priority specified: when a message belongs to that category, it will only be sent out if it has that minimum priority or higher.

SDL's own logs are sent below the default priority threshold, so they are quiet by default.

You can change the log verbosity programmatically using SDL_SetLogPriority() or with SDL_SetHint(SDL_HINT_LOGGING, ...), or with the "SDL_LOGGING" environment variable. This variable is a comma separated set of category=level tokens that define the default logging levels for SDL applications.

The category can be a numeric category, one of "app", "error", "assert", "system", "audio", "video", "render", "input", "test", or * for any unspecified category.

The level can be a numeric level, one of "trace", "verbose", "debug", "info", "warn", "error", "critical", or "quiet" to disable that category.

You can omit the category if you want to set the logging level for all categories.

If this hint isn't set, the default log levels are equivalent to:

app=info,assert=warn,test=verbose,*=error

Here's where the messages go on different platforms:

Windows: debug output stream
Android: log output
Others: standard error output (stderr)

You don't need to have a newline (\n) on the end of messages, the functions will do that for you. For consistent behavior cross-platform, you shouldn't have any newlines in messages, such as to log multiple lines in one call; unusual platform-specific behavior can be observed in such usage. Do one log call per line instead, with no newlines in messages.

Each log call is atomic, so you won't see log messages cut off one another when logging from multiple threads. The predefined log categories

By default the application and gpu categories are enabled at the INFO level, the assert category is enabled at the WARN level, test is enabled at the VERBOSE level and all other categories are enabled at the ERROR level.

Since: 3.2.0

Synopsis

newtype SDL_LogCategory = SDL_LogCategory {
- unwrap :: CUInt
}
pattern SDL_LOG_CATEGORY_APPLICATION :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_ERROR :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_ASSERT :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_SYSTEM :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_AUDIO :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_VIDEO :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_RENDER :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_INPUT :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_TEST :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_GPU :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_RESERVED2 :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_RESERVED3 :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_RESERVED4 :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_RESERVED5 :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_RESERVED6 :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_RESERVED7 :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_RESERVED8 :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_RESERVED9 :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_RESERVED10 :: SDL_LogCategory
pattern SDL_LOG_CATEGORY_CUSTOM :: SDL_LogCategory
newtype SDL_LogPriority = SDL_LogPriority {
- unwrap :: CUInt
}
pattern SDL_LOG_PRIORITY_INVALID :: SDL_LogPriority
pattern SDL_LOG_PRIORITY_TRACE :: SDL_LogPriority
pattern SDL_LOG_PRIORITY_VERBOSE :: SDL_LogPriority
pattern SDL_LOG_PRIORITY_DEBUG :: SDL_LogPriority
pattern SDL_LOG_PRIORITY_INFO :: SDL_LogPriority
pattern SDL_LOG_PRIORITY_WARN :: SDL_LogPriority
pattern SDL_LOG_PRIORITY_ERROR :: SDL_LogPriority
pattern SDL_LOG_PRIORITY_CRITICAL :: SDL_LogPriority
pattern SDL_LOG_PRIORITY_COUNT :: SDL_LogPriority
newtype SDL_LogOutputFunction_Aux = SDL_LogOutputFunction_Aux {
- unwrap :: Ptr Void -> CInt -> SDL_LogPriority -> PtrConst CChar -> IO ()
}
newtype SDL_LogOutputFunction = SDL_LogOutputFunction {
- unwrap :: FunPtr SDL_LogOutputFunction_Aux
}

Documentation

newtype SDL_LogCategory Source #

C declaration: enum SDL_LogCategory, defined at SDL3/SDL_log.h 90:14

Constructors

SDL_LogCategory
Fields unwrap :: CUInt

Instances

Instances details

Storable SDL_LogCategory Source #

Instance details

SDL_LogOutputFunction_Aux
Fields unwrap :: Ptr Void -> CInt -> SDL_LogPriority -> PtrConst CChar -> IO ()

SDL_LogOutputFunction
Fields unwrap :: FunPtr SDL_LogOutputFunction_Aux