#include "SDL_stdinc.h"
#include "begin_code.h"
#include "close_code.h"

Macros
#define	SDL_MAX_LOG_MESSAGE 4096
	The maximum size of a log message. More...

Typedefs
typedef void(SDLCALL *	SDL_LogOutputFunction) (void userdata, int category, SDL_LogPriority priority, const char message)
	The prototype for the log output function. More...

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. More...

Functions
DECLSPEC void SDLCALL	SDL_LogSetAllPriority (SDL_LogPriority priority)
	Set the priority of all log categories. More...

DECLSPEC void SDLCALL	SDL_LogSetPriority (int category, SDL_LogPriority priority)
	Set the priority of a particular log category. More...

DECLSPEC SDL_LogPriority SDLCALL	SDL_LogGetPriority (int category)
	Get the priority of a particular log category. More...

DECLSPEC void SDLCALL	SDL_LogResetPriorities (void)
	Reset all priorities to default. More...

DECLSPEC void SDLCALL	SDL_Log (SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(1)
	Log a message with SDL_LOG_CATEGORY_APPLICATION and SDL_LOG_PRIORITY_INFO. More...

DECLSPEC void SDLCALL	SDL_LogVerbose (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
	Log a message with SDL_LOG_PRIORITY_VERBOSE. More...

DECLSPEC void SDLCALL	SDL_LogDebug (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
	Log a message with SDL_LOG_PRIORITY_DEBUG. More...

DECLSPEC void SDLCALL	SDL_LogInfo (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
	Log a message with SDL_LOG_PRIORITY_INFO. More...

DECLSPEC void SDLCALL	SDL_LogWarn (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
	Log a message with SDL_LOG_PRIORITY_WARN. More...

DECLSPEC void SDLCALL	SDL_LogError (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
	Log a message with SDL_LOG_PRIORITY_ERROR. More...

DECLSPEC void SDLCALL	SDL_LogCritical (int category, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
	Log a message with SDL_LOG_PRIORITY_CRITICAL. More...

DECLSPEC void SDLCALL	SDL_LogMessage (int category, SDL_LogPriority priority, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(3)
	Log a message with the specified category and priority. More...

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. More...

DECLSPEC void SDLCALL	SDL_LogGetOutputFunction (SDL_LogOutputFunction callback, void *userdata)
	Get the current log output function. More...

DECLSPEC void SDLCALL	SDL_LogSetOutputFunction (SDL_LogOutputFunction callback, void *userdata)
	This function allows you to replace the default log output function with one of your own. More...

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)

Definition in file SDL_log.h.

Macro Definition Documentation

◆ SDL_MAX_LOG_MESSAGE

#define SDL_MAX_LOG_MESSAGE 4096

The maximum size of a log message.

Messages longer than the maximum size will be truncated

Definition at line 54 of file SDL_log.h.

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 function.

Definition at line 189 of file SDL_log.h.

Enumeration Type Documentation

◆ SDL_LogCategory

enum 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.

Enumerator
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

Definition at line 64 of file SDL_log.h.

 {
     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,
 
     /* Reserved for future SDL library use */
     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,
 
     /* Beyond this point is reserved for application use, e.g.
        enum {
            MYAPP_CATEGORY_AWESOME1 = SDL_LOG_CATEGORY_CUSTOM,
            MYAPP_CATEGORY_AWESOME2,
            MYAPP_CATEGORY_AWESOME3,
            ...
        };
      */
     SDL_LOG_CATEGORY_CUSTOM
 } SDL_LogCategory;

◆ SDL_LogPriority

enum SDL_LogPriority

The predefined log priorities.

Enumerator
SDL_LOG_PRIORITY_VERBOSE
SDL_LOG_PRIORITY_DEBUG
SDL_LOG_PRIORITY_INFO
SDL_LOG_PRIORITY_WARN
SDL_LOG_PRIORITY_ERROR
SDL_LOG_PRIORITY_CRITICAL
SDL_NUM_LOG_PRIORITIES

Definition at line 102 of file SDL_log.h.

 {
     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
 } SDL_LogPriority;

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.

◆ SDL_LogCritical()

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

Log a message with SDL_LOG_PRIORITY_CRITICAL.

◆ SDL_LogDebug()

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

Log a message with SDL_LOG_PRIORITY_DEBUG.

◆ SDL_LogError()

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

Log a message with SDL_LOG_PRIORITY_ERROR.

◆ SDL_LogGetOutputFunction()

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

Get the current log output function.

◆ SDL_LogGetPriority()

DECLSPEC SDL_LogPriority SDLCALL SDL_LogGetPriority ( int category )

Get the priority of a particular log category.

◆ SDL_LogInfo()

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

Log a message with SDL_LOG_PRIORITY_INFO.

◆ 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.

◆ 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.

◆ SDL_LogResetPriorities()

DECLSPEC void SDLCALL SDL_LogResetPriorities ( void )

Reset all priorities to default.

Note: This is called in SDL_Quit().

◆ SDL_LogSetAllPriority()

DECLSPEC void SDLCALL SDL_LogSetAllPriority ( SDL_LogPriority priority )

Set the priority of all log categories.

◆ SDL_LogSetOutputFunction()

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

This function allows you to replace the default log output function with one of your own.

◆ SDL_LogSetPriority()

DECLSPEC void SDLCALL SDL_LogSetPriority	(	int	category,
		SDL_LogPriority	priority
	)

Set the priority of a particular log category.

◆ SDL_LogVerbose()

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

Log a message with SDL_LOG_PRIORITY_VERBOSE.

◆ SDL_LogWarn()

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

Log a message with SDL_LOG_PRIORITY_WARN.

Macros

Typedefs

Enumerations

Functions