Macros
ai_msg.h File Reference

API for logging messages of different severities - info, warnings, errors. More...

#include "ai_api.h"
#include <stdint.h>
#include <stddef.h>

Go to the source code of this file.

Macros

#define __AI_FILE__   __FILE__
 
#define __AI_LINE__   __LINE__
 
#define __AI_FUNCTION__   __FUNCTION__
 
Severity Codes
#define AI_SEVERITY_INFO   0x00
 regular information message
 
#define AI_SEVERITY_WARNING   0x01
 warning message

 
#define AI_SEVERITY_ERROR   0x02
 error message

 
#define AI_SEVERITY_FATAL   0x03
 fatal error message

 

Logging Flags

#define AI_LOG_NONE   0x0000
 don't show any messages

 
#define AI_LOG_INFO   0x0001
 show all regular information messages

 
#define AI_LOG_WARNINGS   0x0002
 show warning messages

 
#define AI_LOG_ERRORS   0x0004
 show error messages

 
#define AI_LOG_DEBUG   0x0008
 show debug messages

 
#define AI_LOG_STATS   0x0010
 show detailed render statistics

 
#define AI_LOG_ASS_PARSE   0x0020
 show .ass-file parsing details

 
#define AI_LOG_PLUGINS   0x0040
 show details about plugins loaded

 
#define AI_LOG_PROGRESS   0x0080
 show progress messages at 5% increments while rendering

 
#define AI_LOG_NAN   0x0100
 show warnings for pixels with NaN's

 
#define AI_LOG_TIMESTAMP   0x0200
 prefix messages with a timestamp (elapsed time)

 
#define AI_LOG_BACKTRACE   0x0400
 show stack contents after abnormal program termination (SIGSEGV, etc)
 
#define AI_LOG_MEMORY   0x0800
 prefix messages with current memory usage

 
#define AI_LOG_COLOR   0x1000
 add colors to log messages based on severity

 
#define AI_LOG_STATUS   0x2000
 flag associated with messages reporting overall status

 
#define AI_LOG_ALL
 set all flags at once (except AI_LOG_STATUS, since status messages use the logging callback mechanism but are not intended to appear in the log) More...
 
typedef void(* AtMsgCallBack) (int logmask, int severity, const char *msg_string, int tabs)
 Custom message callback, as passed to AiMsgSetCallback()
 
typedef void(* AtMsgExtendedCallBack) (int logmask, int severity, const char *msg_string, AtParamValueMap *metadata, void *user_ptr)
 Custom message callback, as passed to AiMsgRegisterCallback() More...
 
AI_API void AiMsgSetLogFileName (const char *filename)
 Enable writing messages to the specified log file. More...
 
AI_API void AiMsgSetLogFileFlags (const AtUniverse *universe, int flags)
 Set the mask for what types of messages from the specified universe can be written to the log file. More...
 
AI_API void AiMsgSetConsoleFlags (const AtUniverse *universe, int flags)
 Set the mask for what types of messages from the specified universe can be written to stdout. More...
 
AI_API int AiMsgGetLogFileFlags (const AtUniverse *universe)
 Get the type of messages that will be written to the log file for a given universe. More...
 
AI_API int AiMsgGetConsoleFlags (const AtUniverse *universe)
 Get the type of messages that will be written to the stdout for a given universe. More...
 
AI_API void AiMsgSetMaxWarnings (int max_warnings)
 Set the maximum number of reported warnings. More...
 
AI_API AI_DEPRECATED void AiMsgSetCallback (AtMsgCallBack func)
 Change the logging callback function. More...
 
AI_API AI_DEPRECATED void AiMsgAddCallback (AtMsgCallBack func)
 Add an additional logging callback function. More...
 
AI_API AI_DEPRECATED void AiMsgResetCallback ()
 Reset the logging callback function to its default value. More...
 
AI_API unsigned int AiMsgRegisterCallback (AtMsgExtendedCallBack func, int mask, void *user_ptr)
 Add an additional logging callback function. More...
 
AI_API void AiMsgDeregisterCallback (unsigned int callback_id)
 Remove a previously registered logging callback function. More...
 
AI_API void AiMsgSetCallbackMask (unsigned int callback_id, int mask)
 Sets the mask of a previously registered logging callback function. More...
 
AI_API int AiMsgGetCallbackMask (unsigned int callback_id)
 Returns the mask of a previously registered logging callback function. More...
 
AI_API void AiMsgInfo (const char *format,...)
 Send an information message to the log. More...
 
AI_API void AiMsgDebug (const char *format,...)
 Send a debug message to the log. More...
 
AI_API void AiMsgWarning (const char *format,...)
 Send a warning message to the log. More...
 
AI_API void AiMsgError (const char *format,...)
 Send an error message to the log. More...
 
AI_API void AiMsgFatal (const char *format,...)
 Send a fatal error message to the log. More...
 
AI_API void AiMsgTab (int tabinc)
 Change the indentation of subsequent log messages. More...
 
AI_API size_t AiMsgUtilGetUsedMemory ()
 Memory used by this process in bytes. More...
 
AI_API uint32_t AiMsgUtilGetElapsedTime ()
 Elapsed time since AiBegin() More...
 
AI_API void AiMsgSystemInfo (const AtUniverse *universe)
 Output system information to the log. More...
 

Detailed Description

API for logging messages of different severities - info, warnings, errors.


© 2022 Autodesk, Inc. · All rights reserved · www.arnoldrenderer.com