FramePro

Choose your operating system:

Windows

macOS

Linux

Classes

Typedefs

Enums

Functions

Name Description

Public function

void

 

FramePro::AddCustomStat

(
    StringId name,
    float value,
    const char* p_graph,
    const char* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    StringId name,
    float value,
    StringId graph,
    StringId unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    StringId name,
    int64 value,
    StringId graph,
    StringId unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    StringId name,
    int value,
    StringId graph,
    StringId unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    StringId name,
    double value,
    const wchar_t* p_graph,
    const wchar_t* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    StringId name,
    float value,
    const wchar_t* p_graph,
    const wchar_t* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    StringId name,
    int64 value,
    const wchar_t* p_graph,
    const wchar_t* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    StringId name,
    int value,
    const wchar_t* p_graph,
    const wchar_t* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    StringId name,
    double value,
    const char* p_graph,
    const char* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    const char* p_name,
    int value,
    const char* p_graph,
    const char* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    const char* p_name,
    int64 value,
    const char* p_graph,
    const char* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    const char* p_name,
    float value,
    const char* p_graph,
    const char* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    const char* p_name,
    double value,
    const char* p_graph,
    const char* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    const wchar_t* p_name,
    int value,
    const wchar_t* p_graph,
    const wchar_t* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    const wchar_t* p_name,
    int64 value,
    const wchar_t* p_graph,
    const wchar_t* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    const wchar_t* p_name,
    float value,
    const wchar_t* p_graph,
    const wchar_t* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    const wchar_t* p_name,
    double value,
    const wchar_t* p_graph,
    const wchar_t* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    StringId name,
    int value,
    const char* p_graph,
    const char* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    StringId name,
    double value,
    StringId graph,
    StringId unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStat

(
    StringId name,
    int64 value,
    const char* p_graph,
    const char* p_unit,
    uint colour
)

Public function

void

 

FramePro::AddCustomStatTimer

(
    CustomStatTimer* p_timer
)

Public function

void

 

FramePro::AddEvent

(
    const char* p_name,
    uint colour
)

Public function

void

 

FramePro::AddTimeSpan

(
    const wchar_t* p_name_file_and...,
    int64 start_time,
    int64 end_time
)

Public function

void

 

FramePro::AddTimeSpan

(
    const char* p_name_file_and_li...,
    int64 start_time,
    int64 end_time
)

Public function

void

 

FramePro::AddTimeSpan

(
    const char* p_name,
    const char* p_file_and_line,
    int64 start_time,
    int64 end_time
)

Public function

void

 

FramePro::AddTimeSpan

(
    StringId name_id,
    const char* p_file_and_line,
    int64 start_time,
    int64 end_time
)

Public function

void

 

FramePro::AddTimeSpan

(
    StringId name_id,
    const char* p_file_and_line,
    int64 start_time,
    int64 end_time,
    int thread_id,
    int core
)

Public function

void

 

FramePro::AddWaitEvent

(
    int64 event_id,
    int64 start_time,
    int start_core,
    int64 end_time,
    int end_core
)

Public function

void

 

FramePro::BlockSockets()

Public function

bool

 

FramePro::CallConditionalParentScopeCallback

(
    ConditionalParentScopeCallback p_ca...,
    const char* p_name,
    int64 start_time,
    int64 end_time
)

Public function

void

 

FramePro::CleanupThread()

Public function

void

 

FramePro::DebugBreak()

Public function

void

 

FramePro::FrameStart()

Public function

unsigned int

 

FramePro::GetConditionalScopeMinTime()

Public function

int

 

FramePro::GetCore()

Public function

unsigned int

 

FramePro::GetHashAndStackSize

(
    void** p_stack,
    int& stack_size
)

Public function

bool

 

FramePro::IsConnected()

Public function

void

 

FramePro::Log

(
    const char* p_message
)

Public function

bool

 

FramePro::Platform::AcceptSocket

(
    void* p_source_os_socket_mem,
    void* p_target_os_socket_mem
)

Public function

uint

 

FramePro::Platform::AllocateTLSSlot()

Public function

bool

 

FramePro::Platform::BindSocket

(
    void* p_os_socket_mem,
    const char* p_port
)

Public function

void

 

FramePro::Platform::CloseFile

(
    void* p_os_file_mem
)

Public function

void *

 

FramePro::Platform::CreateContextSwitchRecorder

(
    Allocator* p_allocator
)

Public function

void

 

FramePro::Platform::CreateEventX

(
    void* p_os_event_mem,
    int os_event_mem_size,
    bool initial_state,
    bool auto_reset
)

Public function

void

 

FramePro::Platform::CreateLock

(
    void* p_os_lock_mem,
    int os_lock_mem_size
)

Public function

void

 

FramePro::Platform::CreateSocket

(
    void* p_os_socket_mem,
    int os_socket_mem_size
)

Public function

bool

 

FramePro::Platform::CreateThread

(
    void* p_os_thread_mem,
    int os_thread_mem_size,
    ThreadMain p_thread_main,
    void* p_context,
    Allocator* p_allocator
)

Public function

void

 

FramePro::Platform::DebugBreak()

Public function

void

 

FramePro::Platform::DebugWrite

(
    const char* p_string
)

Public function

void

 

FramePro::Platform::DestroyContextSwitchRecorder

(
    void* p_context_switch_recorde...,
    Allocator* p_allocator
)

Public function

void

 

FramePro::Platform::DestroyEvent

(
    void* p_os_event_mem
)

Public function

void

 

FramePro::Platform::DestroyLock

(
    void* p_os_lock_mem
)

Public function

void

 

FramePro::Platform::DestroySocket

(
    void* p_os_socket_mem
)

Public function

void

 

FramePro::Platform::DestroyThread

(
    void* p_os_thread_mem
)

Public function

void

 

FramePro::Platform::DisconnectSocket

(
    void* p_os_socket_mem,
    bool stop_listening
)

Public function

void

 

FramePro::Platform::EnumerateModules

(
    Array< ModulePacket* >& modul...,
    Allocator* p_allocator
)

Public function

void

 

FramePro::Platform::FlushContextSwitches

(
    void* p_context_switch_recorde...
)

Public function

int

 

FramePro::Platform::GetCore()

Public function

int

 

FramePro::Platform::GetCurrentProcessId()

Public function

int

 

FramePro::Platform::GetCurrentThreadId()

Public function

int

 

FramePro::Platform::GetFileSize

(
    const void* p_os_file_mem
)

Public function

void

 

FramePro::Platform::GetLocalTime

(
    tm* p_tm,
    const time_t* p_time
)

Public function

Platform::En...

 

FramePro::Platform::GetPlatformEnum()

Public function

bool

 

FramePro::Platform::GetProcessName

(
    int process_id,
    char* p_name,
    int max_name_length
)

Public function

void

 

FramePro::Platform::GetRecordingFolder

(
    char* p_path,
    int max_path_length
)

Public function

bool

 

FramePro::Platform::GetStackTrace

(
    void** stack,
    int& stack_size,
    unsigned int& hash
)

Public function

int64

 

FramePro::Platform::GetTimerFrequency()

Public function

void *

 

FramePro::Platform::GetTLSValue

(
    uint slot
)

Public function

void

 

FramePro::Platform::HandleSocketError()

Public function

bool

 

FramePro::Platform::InitialiseSocketSystem()

Public function

bool

 

FramePro::Platform::IsSocketValid

(
    const void* p_os_socket_mem
)

Public function

bool

 

FramePro::Platform::OpenFileForRead

(
    void* p_os_file_mem,
    int os_file_mem_size,
    const wchar_t* p_filename
)

Public function

bool

 

FramePro::Platform::OpenFileForRead

(
    void* p_os_file_mem,
    int os_file_mem_size,
    const char* p_filename
)

Public function

bool

 

FramePro::Platform::OpenFileForWrite

(
    void* p_os_file_mem,
    int os_file_mem_size,
    const wchar_t* p_filename
)

Public function

bool

 

FramePro::Platform::OpenFileForWrite

(
    void* p_os_file_mem,
    int os_file_mem_size,
    const char* p_filename
)

Public function

void

 

FramePro::Platform::ReadFromFile

(
    void* p_os_file_mem,
    void* p_data,
    size_t size
)

Public function

void

 

FramePro::Platform::ReleaseLock

(
    void* p_os_lock_mem
)

Public function

void

 

FramePro::Platform::ResetEvent

(
    void* p_os_event_mem
)

Public function

void

 

FramePro::Platform::SetEvent

(
    void* p_os_event_mem
)

Public function

void

 

FramePro::Platform::SetThreadAffinity

(
    void* p_os_thread_mem,
    int affinity
)

Public function

void

 

FramePro::Platform::SetThreadPriority

(
    void* p_os_thread_mem,
    int priority
)

Public function

void

 

FramePro::Platform::SetTLSValue

(
    uint slot,
    void* p_value
)

Public function

bool

 

FramePro::Platform::SocketReceive

(
    void* p_os_socket_mem,
    const void* p_buffer,
    int size,
    int& bytes_received
)

Public function

bool

 

FramePro::Platform::SocketSend

(
    void* p_os_socket_mem,
    const void* p_buffer,
    int size,
    int& bytes_sent
)

Public function

bool

 

FramePro::Platform::StartRecordingContextSitches

(
    void* p_context_switch_recorde...,
    ContextSwitchCallbackFunction p_cal...,
    void* p_context,
    DynamicString& error,
    Allocator* p_allocator
)

Public function

bool

 

FramePro::Platform::StartSocketListening

(
    void* p_os_socket_mem
)

Public function

void

 

FramePro::Platform::StopRecordingContextSitches

(
    void* p_context_switch_recorde...
)

Public function

void

 

FramePro::Platform::TakeLock

(
    void* p_os_lock_mem
)

Public function

void

 

FramePro::Platform::ToString

(
    int value,
    char* p_dest,
    int dest_size
)

Public function

void

 

FramePro::Platform::UninitialiseSocketSystem()

Public function

void

 

FramePro::Platform::VSPrintf

(
    char* p_buffer,
    size_t const buffer_size,
    const char* p_format,
    va_list arg_list
)

Public function

int

 

FramePro::Platform::WaitEvent

(
    void* p_os_event_mem,
    int timeout
)

Public function

void

 

FramePro::Platform::WriteToFile

(
    void* p_os_file_mem,
    const void* p_data,
    size_t size
)

Public function

void

 

FramePro::PopConditionalParentScope

(
    bool add_children
)

Public function

void

 

FramePro::PushConditionalParentScope

(
    const char* p_name,
    int64 pre_duration,
    int64 post_duration
)

Public function

void

 

FramePro::RegisterConnectionChangedCallback

(
    ConnectionChangedCallback p_callbac...,
    void* p_context
)

Public function

StringId

 

FramePro::RegisterString

(
    const char* p_str
)

Public function

StringId

 

FramePro::RegisterString

(
    const wchar_t* p_str
)

Public function

void

 

FramePro::SendScopeCallstack()

Public function

void

 

FramePro::SendSessionInfo

(
    const wchar_t* p_name,
    const wchar_t* p_value
)

Public function

void

 

FramePro::SendSessionInfo

(
    const char* p_name,
    const char* p_value
)

Public function

void

 

FramePro::SetAllocator

(
    Allocator* p_allocator
)

Public function

void

 

FramePro::SetConditionalScopeMinTimeInMicroseconds

(
    int64 value
)

Public function

void

 

FramePro::SetCustomStatColour

(
    StringId name,
    uint colour
)

Public function

void

 

FramePro::SetCustomStatGraph

(
    StringId name,
    StringId graph
)

Public function

void

 

FramePro::SetCustomStatUnit

(
    StringId name,
    StringId unit
)

Public function

void

 

FramePro::SetPort

(
    int port
)

Public function

void

 

FramePro::SetScopeColour

(
    StringId name,
    uint colour
)

Public function

void

 

FramePro::SetScopeCustomStat

(
    StringId name,
    int64 value,
    StringId graph,
    StringId unit,
    uint colour
)

Public function

void

 

FramePro::SetScopeCustomStat

(
    const wchar_t* p_name,
    int64 value,
    const wchar_t* p_graph,
    const wchar_t* p_unit,
    uint colour
)

Public function

void

 

FramePro::SetScopeCustomStat

(
    const char* p_name,
    int64 value,
    const char* p_graph,
    const char* p_unit,
    uint colour
)

Public function

void

 

FramePro::SetScopeCustomStat

(
    StringId name,
    int value,
    StringId graph,
    StringId unit,
    uint colour
)

Public function

void

 

FramePro::SetScopeCustomStat

(
    const wchar_t* p_name,
    int value,
    const wchar_t* p_graph,
    const wchar_t* p_unit,
    uint colour
)

Public function

void

 

FramePro::SetScopeCustomStat

(
    const char* p_name,
    int value,
    const char* p_graph,
    const char* p_unit,
    uint colour
)

Public function

void

 

FramePro::SetScopeCustomStat

(
    StringId name,
    float value,
    StringId graph,
    StringId unit,
    uint colour
)

Public function

void

 

FramePro::SetScopeCustomStat

(
    const wchar_t* p_name,
    float value,
    const wchar_t* p_graph,
    const wchar_t* p_unit,
    uint colour
)

Public function

void

 

FramePro::SetScopeCustomStat

(
    const char* p_name,
    double value,
    const char* p_graph,
    const char* p_unit,
    uint colour
)

Public function

void

 

FramePro::SetScopeCustomStat

(
    const wchar_t* p_name,
    double value,
    const wchar_t* p_graph,
    const wchar_t* p_unit,
    uint colour
)

Public function

void

 

FramePro::SetScopeCustomStat

(
    StringId name,
    double value,
    StringId graph,
    StringId unit,
    uint colour
)

Public function

void

 

FramePro::SetScopeCustomStat

(
    const char* p_name,
    float value,
    const char* p_graph,
    const char* p_unit,
    uint colour
)

Public function

void

 

FramePro::SetThreadAffinity

(
    int affinity
)

Public function

void

 

FramePro::SetThreadName

(
    const char* p_name
)

Public function

void

 

FramePro::SetThreadName

(
    int thread_id,
    const char* p_name
)

Public function

void

 

FramePro::SetThreadOrder

(
    StringId thread_name
)

Public function

void

 

FramePro::SetThreadPriority

(
    int priority
)

Public function

void

 

FramePro::Shutdown()

Shuts down core services.

Public function

void

 

FramePro::StartHiResTimer

(
    const char* p_name
)

Public function

void

 

FramePro::StartRecording

(
    const char* p_filename,
    bool context_switches,
    bool callstacks,
    int64 max_file_size
)

Public function

void

 

FramePro::StartRecording

(
    const wchar_t* p_filename,
    bool context_switches,
    bool callstacks,
    int64 max_file_size
)

Public function

void

 

FramePro::StartScope()

Public function

void

 

FramePro::StopHiResTimer()

Public function

void

 

FramePro::StopRecording()

Public function

void

 

FramePro::StopScope()

Public function

void

 

FramePro::TriggerWaitEvent

(
    int64 event_id
)

Public function

void

 

FramePro::UnblockSockets()

Public function

void

 

FramePro::UnregisterConnectionChangedcallback

(
    ConnectionChangedCallback p_callbac...
)

Variables