Miguel Ruiz / SDL_lib

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   H261_encoder

Embed: (wiki syntax)

« Back to documentation index

SDL_log.h File Reference
Typedefs | Enumerations | Functions

SDL_log.h File Reference

Simple log messages with categories and priorities. More...

Go to the source code of this file.

Typedefs

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

Enumerations

enum  
 

The predefined log categories.

More...
enum  SDL_LogPriority
 

The predefined log priorities.

More...

Functions

DECLSPEC void SDLCALL SDL_LogSetAllPriority (SDL_LogPriority priority)
 Set the priority of all log categories.
DECLSPEC void SDLCALL SDL_LogSetPriority (int category, SDL_LogPriority priority)
 Set the priority of a particular log category.
DECLSPEC SDL_LogPriority SDLCALL SDL_LogGetPriority (int category)
 Get the priority of a particular log category.
DECLSPEC void SDLCALL SDL_LogResetPriorities (void)
 Reset all priorities to default.
DECLSPEC void SDLCALL SDL_Log (const char *fmt,...)
 Log a message with SDL_LOG_CATEGORY_APPLICATION and SDL_LOG_PRIORITY_INFO.
DECLSPEC void SDLCALL SDL_LogVerbose (int category, const char *fmt,...)
 Log a message with SDL_LOG_PRIORITY_VERBOSE.
DECLSPEC void SDLCALL SDL_LogDebug (int category, const char *fmt,...)
 Log a message with SDL_LOG_PRIORITY_DEBUG.
DECLSPEC void SDLCALL SDL_LogInfo (int category, const char *fmt,...)
 Log a message with SDL_LOG_PRIORITY_INFO.
DECLSPEC void SDLCALL SDL_LogWarn (int category, const char *fmt,...)
 Log a message with SDL_LOG_PRIORITY_WARN.
DECLSPEC void SDLCALL SDL_LogError (int category, const char *fmt,...)
 Log a message with SDL_LOG_PRIORITY_ERROR.
DECLSPEC void SDLCALL SDL_LogCritical (int category, const char *fmt,...)
 Log a message with SDL_LOG_PRIORITY_CRITICAL.
DECLSPEC void SDLCALL SDL_LogMessage (int category, SDL_LogPriority priority, const char *fmt,...)
 Log a message with the specified category and priority.
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.
DECLSPEC void SDLCALL SDL_LogGetOutputFunction (SDL_LogOutputFunction *callback, void **userdata)
 Get the current log output function.
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.

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.

Typedef Documentation

typedef void(* 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

anonymous enum

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.

Definition at line 64 of file SDL_log.h.

enum SDL_LogPriority

The predefined log priorities.

Definition at line 102 of file SDL_log.h.

Function Documentation

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

Log a message with SDL_LOG_CATEGORY_APPLICATION and SDL_LOG_PRIORITY_INFO.

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

Log a message with SDL_LOG_PRIORITY_CRITICAL.

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

Log a message with SDL_LOG_PRIORITY_DEBUG.

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

Log a message with SDL_LOG_PRIORITY_ERROR.

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

Get the current log output function.

DECLSPEC SDL_LogPriority SDLCALL SDL_LogGetPriority ( int  category )

Get the priority of a particular log category.

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

Log a message with SDL_LOG_PRIORITY_INFO.

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

Log a message with the specified category and priority.

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.

DECLSPEC void SDLCALL SDL_LogResetPriorities ( void   )

Reset all priorities to default.

Note:
This is called in SDL_Quit().
DECLSPEC void SDLCALL SDL_LogSetAllPriority ( SDL_LogPriority  priority )

Set the priority of all log categories.

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.

DECLSPEC void SDLCALL SDL_LogSetPriority ( int  category,
SDL_LogPriority  priority 
)

Set the priority of a particular log category.

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

Log a message with SDL_LOG_PRIORITY_VERBOSE.

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

Log a message with SDL_LOG_PRIORITY_WARN.

Generated on Tue Jul 12 2022 13:56:25 by  doxygen 1.7.2