PxDefaultProfiler.h

Fully qualified name: include/extensions/PxDefaultProfiler.h

File members: include/extensions/PxDefaultProfiler.h

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2025 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.

#ifndef PX_DEFAULT_PROFILER_H
#define PX_DEFAULT_PROFILER_H

#include "foundation/PxProfiler.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

#define PX_PROFILER_VERSION_MAJOR               0
#define PX_PROFILER_VERSION_MINOR               1

struct PxDefaultProfilerDataType
{
    enum Enum : PxU64
    {
        eTHREAD_BLOCK = 0,

        eNAME_REGISTRATION,

        eZONE_START,
        eZONE_END,
        eZONE_START_CROSS_THREAD,
        eZONE_END_CROSS_THREAD,
        eVALUE_INT,
        eVALUE_FLOAT,
        eFRAME
    };
};

struct PxDefaultProfilerVersionInfo
{
    PxU32 major;
    PxU32 minor;
};

struct PxDefaultProfilerHeader
{
    PxDefaultProfilerDataType::Enum type;
};

struct PxDefaultProfilerThread
{
    PxU64 threadId;
};

struct PxDefaultProfilerName
{
    PxU64 key;
    PxU32 size;

    PxU32 padding;
};

struct PxDefaultProfilerEvent
{
    PxU64 time;
    PxU64 contextId;
    PxU64 nameKey;
};

struct PxDefaultProfilerValueEvent : public PxDefaultProfilerEvent
{
    union
    {
        PxI32 intValue;
        PxF32 floatValue;
    };

    PxU32 padding;
};

class PxOutputStream;

class PxDefaultProfiler : public PxProfilerCallback
{
public:

    virtual void release() = 0;

    virtual void flush() = 0;
};

PxDefaultProfiler* PxDefaultProfilerCreate(PxOutputStream& outputStream, PxU32 numberOfBuffers = 16, PxU32 bufferSize = 32767);

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif