zenilib  0.5.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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. More...
 

Typedefs

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

Enumerations

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

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

Referenced by SDL_LogMessageV(), SDL_LogOutput(), and SDL_PromptAssertion().

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.

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.

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.

Function Documentation

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

Log a message with SDL_LOG_CATEGORY_APPLICATION and SDL_LOG_PRIORITY_INFO.

Definition at line 173 of file SDL_log.c.

References SDL_LOG_CATEGORY_APPLICATION, SDL_LOG_PRIORITY_INFO, and SDL_LogMessageV().

Referenced by main().

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

Log a message with SDL_LOG_PRIORITY_CRITICAL.

Definition at line 233 of file SDL_log.c.

References SDL_LOG_PRIORITY_CRITICAL, and SDL_LogMessageV().

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

Log a message with SDL_LOG_PRIORITY_DEBUG.

Definition at line 193 of file SDL_log.c.

References SDL_LOG_PRIORITY_DEBUG, and SDL_LogMessageV().

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

Log a message with SDL_LOG_PRIORITY_ERROR.

Definition at line 223 of file SDL_log.c.

References SDL_LOG_PRIORITY_ERROR, and SDL_LogMessageV().

Referenced by SDL_SetError().

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

Get the current log output function.

Definition at line 415 of file SDL_log.c.

References SDL_log_function, and SDL_log_userdata.

DECLSPEC SDL_LogPriority SDLCALL SDL_LogGetPriority ( int  category)

Get the priority of a particular log category.

Definition at line 134 of file SDL_log.c.

References SDL_application_priority, SDL_assert_priority, SDL_default_priority, SDL_LOG_CATEGORY_APPLICATION, SDL_LOG_CATEGORY_ASSERT, SDL_LOG_CATEGORY_TEST, and SDL_test_priority.

Referenced by SDL_LogMessageV().

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

Log a message with SDL_LOG_PRIORITY_INFO.

Definition at line 203 of file SDL_log.c.

References SDL_LOG_PRIORITY_INFO, and SDL_LogMessageV().

Referenced by SDL_CreateRenderer().

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

Log a message with the specified category and priority.

Definition at line 243 of file SDL_log.c.

References SDL_LogMessageV().

Referenced by SDLTest_Log(), and SDLTest_LogError().

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

Set the priority of all log categories.

Definition at line 99 of file SDL_log.c.

References SDL_application_priority, SDL_assert_priority, and SDL_default_priority.

Referenced by SDLTest_CommonArg().

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.

Definition at line 426 of file SDL_log.c.

References SDL_log_function, and SDL_log_userdata.

DECLSPEC void SDLCALL SDL_LogSetPriority ( int  category,
SDL_LogPriority  priority 
)

Set the priority of a particular log category.

Definition at line 112 of file SDL_log.c.

References SDL_loglevels, and SDL_malloc().

Referenced by SDLTest_CommonArg().

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

Log a message with SDL_LOG_PRIORITY_VERBOSE.

Definition at line 183 of file SDL_log.c.

References SDL_LOG_PRIORITY_VERBOSE, and SDL_LogMessageV().

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

Log a message with SDL_LOG_PRIORITY_WARN.

Definition at line 213 of file SDL_log.c.

References SDL_LOG_PRIORITY_WARN, and SDL_LogMessageV().