Unigine::Log Class

Header:

#include <UnigineLog.h>

This class represents an interface for printing various types of messages to the console and to the Engine's log file. It can be useful to monitor overall progress of application execution and report errors which can be helpful in the process of debugging.

Notice

To enable displaying system messages in the Console use the following command: console_onscreen 1

There are two custom color schemes highlighting log syntax for Notepad++ included in the SDK:

<SDK>/utils/log_styles/notepad_light.xml
<SDK>/utils/log_styles/notepad_dark.xml

Notice

By default all logged messages are saved to the Engine's log file, and printed to stdout, the latter may significantly affect peformance in case of much logging. If logging causes performance issues, you can control the two logging targets via the following console commands:

Example#

The following code demonstrates how to print various types of messages.

Source code (C++)

using namespace Unigine;

// auxiliary variables for messages
const char* file_name = "file.txt";
int ID = 10;

	// reporting an error message
	Log::error("Loading mesh: can't open \"%s\" file\n", file_name);

	// reporting a message
	Log::message("-> Added %d UI elements.\n", ID);

	// reporting a warning message
	Log::warning("ID of the \"%s\" file: %d.\n", file_name, ID);

	// reporting a fatal error message to the log file and closing the application
	Log::fatal("FATAL ERROR reading \"%s\" file!\n", file_name);

Methods:

Name	Description View: Sort by:
error	Prints an error message to the console and the log file.
errorLine	Prints an error message followed by the line terminator to the console and the log file.
fatal	Prints a fatal error message to the log file and quits the engine.
fatalLine	Prints a fatal error message followed by the line terminator to the log file and quits the engine.
message	Prints a message to the console and the log file.
messageLine	Prints a message followed by the line terminator to the console and the log file.
warning	Prints a warning to the console and the log file.
warningLine	Prints a warning followed by the line terminator to the console and the log file.

Log Class

Members

void error ( const char * format, ... ) #

Prints an error message to the console and the log file.

Arguments

const char * format - Error message to print.
... - Arguments, multiple allowed.

void errorLine ( const char * format, ... ) #

Prints an error message followed by the line terminator to the console and the log file.

Arguments

const char * format - Error message to print.
... - Arguments, multiple allowed.

void fatal ( const char * format, ... ) #

Prints a fatal error message to the log file and quits the engine.

Arguments

const char * format - Fatal error message to print.
... - Arguments, multiple allowed.

void fatalLine ( const char * format, ... ) #

Prints a fatal error message followed by the line terminator to the log file and quits the engine.

Arguments

const char * format - Fatal error message to print.
... - Arguments, multiple allowed.

void message ( const char * format, ... ) #

Prints a message to the console and the log file.

Arguments

const char * format - Message to print.
... - Arguments, multiple allowed.

void messageLine ( const char * format, ... ) #

Prints a message followed by the line terminator to the console and the log file.

Arguments

const char * format - Message to print.
... - Arguments, multiple allowed.

void warning ( const char * format, ... ) #

Prints a warning to the console and the log file.

Arguments

const char * format - Warning to print.
... - Arguments, multiple allowed.

void warningLine ( const char * format, ... ) #

Prints a warning followed by the line terminator to the console and the log file.

Arguments

const char * format - Warning to print.
... - Arguments, multiple allowed.

Last update: 10.10.2022

Помогите сделать статью лучше

Была ли эта статья полезной?

Сообщить о проблеме в этой статье

(или выберите слово/фразу и нажмите Ctrl+Enter