engine.profiler Functions

List of functions:

Profiler functions allow using counters in your code in the following manner:

Source code(UnigineScript)

begin("my_counter");
// ...code to profile...
end();

Counters can be nested.

Profiler Class

Members

void begin (const char * name, const Math::vec4 & color)

Starts a counter with a given name.

Arguments

const char * name - Name of the counter.
const Math::vec4 & color - Color of the graph.

float end ()

Stops the last activated counter and returns its value.

Return value

Value of the counter in milliseconds.

int isEnabled ()

Returns a value indicating if the profiler is enabled.

Return value

1 if the profiler is enabled; otherwise, 0.

void setValue (const char * name, const char * units, int value, int max_value, float * arg5)

Updates the counter settings.

Arguments

const char * name - Name of the counter.
const char * units - Counter units.
int value - Value of the counter (int or float).
int max_value - Counter maximum value.
float * arg5 - Color of the graph.

float getValue (const char * name)

Returns a value of the specified counter.

Arguments

const char * name - The name of the counter.

Return value

Value of the counter in milliseconds.

void begin (const char * name)

Starts a counter with a given name.

Arguments

const char * name - Name of the counter.

void setEnabled (int enabled)

Arguments

int enabled

void setValue (const char * name, const char * units, float value, float max_value, float * arg5)

Updates the counter settings.

Arguments

const char * name - Name of the counter.
const char * units - Counter units.
float value - Value of the counter (int or float).
float max_value - Counter maximum value.
float * arg5 - Color of the graph.

Last update: 2017-07-03

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)