My Project
Loading...
Searching...
No Matches
SDL_log.h File Reference
#include "SDL_stdinc.h"
#include "begin_code.h"
#include "close_code.h"

Go to the source code of this file.

Macros

#define SDL_MAX_LOG_MESSAGE   4096
 The maximum size of a log message prior to SDL 2.0.24.
 

Typedefs

typedef void(SDLCALL * SDL_LogOutputFunction) (void *userdata, int category, SDL_LogPriority priority, const char *message)
 

Enumerations

enum  SDL_LogCategory {
  SDL_LOG_CATEGORY_APPLICATION , SDL_LOG_CATEGORY_ERROR , SDL_LOG_CATEGORY_ASSERT , SDL_LOG_CATEGORY_SYSTEM ,
  SDL_LOG_CATEGORY_AUDIO , SDL_LOG_CATEGORY_VIDEO , SDL_LOG_CATEGORY_RENDER , SDL_LOG_CATEGORY_INPUT ,
  SDL_LOG_CATEGORY_TEST , SDL_LOG_CATEGORY_RESERVED1 , SDL_LOG_CATEGORY_RESERVED2 , SDL_LOG_CATEGORY_RESERVED3 ,
  SDL_LOG_CATEGORY_RESERVED4 , SDL_LOG_CATEGORY_RESERVED5 , SDL_LOG_CATEGORY_RESERVED6 , SDL_LOG_CATEGORY_RESERVED7 ,
  SDL_LOG_CATEGORY_RESERVED8 , SDL_LOG_CATEGORY_RESERVED9 , SDL_LOG_CATEGORY_RESERVED10 , SDL_LOG_CATEGORY_CUSTOM
}
 The predefined log categories. More...
 
enum  SDL_LogPriority {
  SDL_LOG_PRIORITY_VERBOSE = 1 , SDL_LOG_PRIORITY_DEBUG , SDL_LOG_PRIORITY_INFO , SDL_LOG_PRIORITY_WARN ,
  SDL_LOG_PRIORITY_ERROR , SDL_LOG_PRIORITY_CRITICAL , SDL_NUM_LOG_PRIORITIES
}
 The predefined log priorities.
 

Functions

DECLSPEC void SDLCALL SDL_LogSetAllPriority (SDL_LogPriority priority)
 
DECLSPEC void SDLCALL SDL_LogSetPriority (int category, SDL_LogPriority priority)
 
DECLSPEC SDL_LogPriority SDLCALL SDL_LogGetPriority (int category)
 
DECLSPEC void SDLCALL SDL_LogResetPriorities (void)
 
DECLSPEC void SDLCALL SDL_Log (SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(1)
 
DECLSPEC void SDLCALL SDL_LogVerbose (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
 
DECLSPEC void SDLCALL SDL_LogDebug (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
 
DECLSPEC void SDLCALL SDL_LogInfo (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
 
DECLSPEC void SDLCALL SDL_LogWarn (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
 
DECLSPEC void SDLCALL SDL_LogError (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
 
DECLSPEC void SDLCALL SDL_LogCritical (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
 
DECLSPEC void SDLCALL SDL_LogMessage (int category, SDL_LogPriority priority, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(3)
 
DECLSPEC void SDLCALL SDL_LogMessageV (int category, SDL_LogPriority priority, const char *fmt, va_list ap)
 
DECLSPEC void SDLCALL SDL_LogGetOutputFunction (SDL_LogOutputFunction *callback, void **userdata)
 
DECLSPEC void SDLCALL SDL_LogSetOutputFunction (SDL_LogOutputFunction callback, void *userdata)
 

Detailed Description

Simple log messages with categories and priorities.

By default logs are quiet, but if you're debugging SDL you might want:

SDL_LogSetAllPriority(SDL_LOG_PRIORITY_WARN);

Here's where the messages go on different platforms: Windows: debug output stream Android: log output Others: standard error output (stderr)

Macro Definition Documentation

◆ SDL_MAX_LOG_MESSAGE

#define SDL_MAX_LOG_MESSAGE   4096

The maximum size of a log message prior to SDL 2.0.24.

As of 2.0.24 there is no limit to the length of SDL log messages.

Typedef Documentation

◆ SDL_LogOutputFunction

typedef void(SDLCALL * SDL_LogOutputFunction) (void *userdata, int category, SDL_LogPriority priority, const char *message)

The prototype for the log output callback function.

This function is called by SDL when there is new text to be logged.

Parameters
userdatawhat was passed as userdata to SDL_LogSetOutputFunction()
categorythe category of the message
prioritythe priority of the message
messagethe message being output

Enumeration Type Documentation

◆ SDL_LogCategory

The predefined log categories.

By default the application category is 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 CRITICAL level.

Function Documentation

◆ SDL_Log()

DECLSPEC void SDLCALL SDL_Log ( SDL_PRINTF_FORMAT_STRING const char *  fmt,
  ... 
)

Log a message with SDL_LOG_CATEGORY_APPLICATION and SDL_LOG_PRIORITY_INFO.

= *

Parameters
fmta printf() style message format string
...additional parameters matching % tokens in the fmt string, if any
Since
This function is available since SDL 2.0.0.
See also
SDL_LogCritical
SDL_LogDebug
SDL_LogError
SDL_LogInfo
SDL_LogMessage
SDL_LogMessageV
SDL_LogVerbose
SDL_LogWarn

◆ SDL_LogCritical()

DECLSPEC void SDLCALL SDL_LogCritical ( int  category,
SDL_PRINTF_FORMAT_STRING const char *  fmt,
  ... 
)

Log a message with SDL_LOG_PRIORITY_CRITICAL.

Parameters
categorythe category of the message
fmta printf() style message format string
...additional parameters matching % tokens in the fmt string, if any
Since
This function is available since SDL 2.0.0.
See also
SDL_Log
SDL_LogDebug
SDL_LogError
SDL_LogInfo
SDL_LogMessage
SDL_LogMessageV
SDL_LogVerbose
SDL_LogWarn

◆ SDL_LogDebug()

DECLSPEC void SDLCALL SDL_LogDebug ( int  category,
SDL_PRINTF_FORMAT_STRING const char *  fmt,
  ... 
)

Log a message with SDL_LOG_PRIORITY_DEBUG.

Parameters
categorythe category of the message
fmta printf() style message format string
...additional parameters matching % tokens in the fmt string, if any
Since
This function is available since SDL 2.0.0.
See also
SDL_Log
SDL_LogCritical
SDL_LogError
SDL_LogInfo
SDL_LogMessage
SDL_LogMessageV
SDL_LogVerbose
SDL_LogWarn

◆ SDL_LogError()

DECLSPEC void SDLCALL SDL_LogError ( int  category,
SDL_PRINTF_FORMAT_STRING const char *  fmt,
  ... 
)

Log a message with SDL_LOG_PRIORITY_ERROR.

Parameters
categorythe category of the message
fmta printf() style message format string
...additional parameters matching % tokens in the fmt string, if any
Since
This function is available since SDL 2.0.0.
See also
SDL_Log
SDL_LogCritical
SDL_LogDebug
SDL_LogInfo
SDL_LogMessage
SDL_LogMessageV
SDL_LogVerbose
SDL_LogWarn

◆ SDL_LogGetOutputFunction()

DECLSPEC void SDLCALL SDL_LogGetOutputFunction ( SDL_LogOutputFunction callback,
void **  userdata 
)

Get the current log output function.

Parameters
callbackan SDL_LogOutputFunction filled in with the current log callback
userdataa pointer filled in with the pointer that is passed to callback
Since
This function is available since SDL 2.0.0.
See also
SDL_LogSetOutputFunction

◆ SDL_LogGetPriority()

DECLSPEC SDL_LogPriority SDLCALL SDL_LogGetPriority ( int  category)

Get the priority of a particular log category.

Parameters
categorythe category to query
Returns
the SDL_LogPriority for the requested category
Since
This function is available since SDL 2.0.0.
See also
SDL_LogSetPriority

◆ SDL_LogInfo()

DECLSPEC void SDLCALL SDL_LogInfo ( int  category,
SDL_PRINTF_FORMAT_STRING const char *  fmt,
  ... 
)

Log a message with SDL_LOG_PRIORITY_INFO.

Parameters
categorythe category of the message
fmta printf() style message format string
...additional parameters matching % tokens in the fmt string, if any
Since
This function is available since SDL 2.0.0.
See also
SDL_Log
SDL_LogCritical
SDL_LogDebug
SDL_LogError
SDL_LogMessage
SDL_LogMessageV
SDL_LogVerbose
SDL_LogWarn

◆ SDL_LogMessage()

DECLSPEC void SDLCALL SDL_LogMessage ( int  category,
SDL_LogPriority  priority,
SDL_PRINTF_FORMAT_STRING const char *  fmt,
  ... 
)

Log a message with the specified category and priority.

Parameters
categorythe category of the message
prioritythe priority of the message
fmta printf() style message format string
...additional parameters matching % tokens in the fmt string, if any
Since
This function is available since SDL 2.0.0.
See also
SDL_Log
SDL_LogCritical
SDL_LogDebug
SDL_LogError
SDL_LogInfo
SDL_LogMessageV
SDL_LogVerbose
SDL_LogWarn

◆ SDL_LogMessageV()

DECLSPEC void SDLCALL SDL_LogMessageV ( int  category,
SDL_LogPriority  priority,
const char *  fmt,
va_list  ap 
)

Log a message with the specified category and priority.

Parameters
categorythe category of the message
prioritythe priority of the message
fmta printf() style message format string
apa variable argument list
Since
This function is available since SDL 2.0.0.
See also
SDL_Log
SDL_LogCritical
SDL_LogDebug
SDL_LogError
SDL_LogInfo
SDL_LogMessage
SDL_LogVerbose
SDL_LogWarn

◆ SDL_LogResetPriorities()

DECLSPEC void SDLCALL SDL_LogResetPriorities ( void  )

Reset all priorities to default.

This is called by SDL_Quit().

Since
This function is available since SDL 2.0.0.
See also
SDL_LogSetAllPriority
SDL_LogSetPriority

◆ SDL_LogSetAllPriority()

DECLSPEC void SDLCALL SDL_LogSetAllPriority ( SDL_LogPriority  priority)

Set the priority of all log categories.

Parameters
prioritythe SDL_LogPriority to assign
Since
This function is available since SDL 2.0.0.
See also
SDL_LogSetPriority

◆ SDL_LogSetOutputFunction()

DECLSPEC void SDLCALL SDL_LogSetOutputFunction ( SDL_LogOutputFunction  callback,
void *  userdata 
)

Replace the default log output function with one of your own.

Parameters
callbackan SDL_LogOutputFunction to call instead of the default
userdataa pointer that is passed to callback
Since
This function is available since SDL 2.0.0.
See also
SDL_LogGetOutputFunction

◆ SDL_LogSetPriority()

DECLSPEC void SDLCALL SDL_LogSetPriority ( int  category,
SDL_LogPriority  priority 
)

Set the priority of a particular log category.

Parameters
categorythe category to assign a priority to
prioritythe SDL_LogPriority to assign
Since
This function is available since SDL 2.0.0.
See also
SDL_LogGetPriority
SDL_LogSetAllPriority

◆ SDL_LogVerbose()

DECLSPEC void SDLCALL SDL_LogVerbose ( int  category,
SDL_PRINTF_FORMAT_STRING const char *  fmt,
  ... 
)

Log a message with SDL_LOG_PRIORITY_VERBOSE.

Parameters
categorythe category of the message
fmta printf() style message format string
...additional parameters matching % tokens in the fmt string, if any
Since
This function is available since SDL 2.0.0.
See also
SDL_Log
SDL_LogCritical
SDL_LogDebug
SDL_LogError
SDL_LogInfo
SDL_LogMessage
SDL_LogMessageV
SDL_LogWarn

◆ SDL_LogWarn()

DECLSPEC void SDLCALL SDL_LogWarn ( int  category,
SDL_PRINTF_FORMAT_STRING const char *  fmt,
  ... 
)

Log a message with SDL_LOG_PRIORITY_WARN.

Parameters
categorythe category of the message
fmta printf() style message format string
...additional parameters matching % tokens in the fmt string, if any
Since
This function is available since SDL 2.0.0.
See also
SDL_Log
SDL_LogCritical
SDL_LogDebug
SDL_LogError
SDL_LogInfo
SDL_LogMessage
SDL_LogMessageV
SDL_LogVerbose