Class ProfilerCPU

Provides CPU performance measuring methods.

ProfilerCPU
Assembly: FlaxEngine.dll
File: Engine/Profiler/ProfilerCPU.h
Syntax
public class ProfilerCPU

Fields

Enabled

The profiling tools usage flag. Can be used to disable profiler. Engine turns it down before the exit and before platform startup.

Declaration
public static bool Enabled
Field Value
bool

Threads

The registered threads.

Declaration
public static Array<Thread* , InlinedAllocation<64>> Threads
Field Value
Array<Thread , InlinedAllocation<64>>

Methods

BeginEvent()

Begins the event. Call EndEvent with index parameter equal to the returned value by BeginEvent function.

Declaration
public static int32 BeginEvent()
Returns
int32

The event token.

BeginEvent(const Char* name)

Begins the event. Call EndEvent with index parameter equal to the returned value by BeginEvent function.

Declaration
public static int32 BeginEvent(const Char* name)
Parameters
Char name

The event name.
Returns
int32

The event token.

BeginEvent(const char* name)

Begins the event. Call EndEvent with index parameter equal to the returned value by BeginEvent function.

Declaration
public static int32 BeginEvent(const char* name)
Parameters
char name

The event name.
Returns
int32

The event token.

Dispose()

Releases resources. Calls to the profiling API after Dispose are not valid.

Declaration
public static void Dispose()

EndEvent()

Ends the last event.

Declaration
public static void EndEvent()

EndEvent(int32 index)

Ends the event.

Declaration
public static void EndEvent(int32 index)
Parameters
int32 index

The event index returned by the BeginEvent method.

GetCurrentThread()

Gets the current thread (profiler service shadow object).

Declaration
public static Thread* GetCurrentThread()
Returns
Thread

IsProfilingCurrentThread()

Determines whether the current (calling) thread is being profiled by the service (it may has no active profile block but is registered).

Declaration
public static bool IsProfilingCurrentThread()
Returns
bool