include/foundation/PxProfiler.h

File members: include/foundation/PxProfiler.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-2023 NVIDIA Corporation. All rights reserved.

#ifndef PX_PROFILER_H
#define PX_PROFILER_H

#include "foundation/Px.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

class PxProfilerCallback
{
protected:
    virtual ~PxProfilerCallback()   {}

public:
    /**************************************************************************************************************************
    Instrumented profiling events
    ***************************************************************************************************************************/

    virtual void* zoneStart(const char* eventName, bool detached, uint64_t contextId) = 0;

    virtual void zoneEnd(void* profilerData, const char* eventName, bool detached, uint64_t contextId) = 0;
};

class PxProfileScoped
{
  public:
    PX_FORCE_INLINE PxProfileScoped(PxProfilerCallback* callback, const char* eventName, bool detached, uint64_t contextId) : mCallback(callback), mProfilerData(NULL)
    {
        if(mCallback)
        {
            mEventName      = eventName;
            mContextId      = contextId;
            mDetached       = detached;
            mProfilerData   = mCallback->zoneStart(eventName, detached, contextId);
        }
    }

    PX_FORCE_INLINE ~PxProfileScoped()
    {
        if(mCallback)
            mCallback->zoneEnd(mProfilerData, mEventName, mDetached, mContextId);
    }
    PxProfilerCallback*         mCallback;
    const char*                 mEventName;
    void*                       mProfilerData;
    uint64_t                    mContextId;
    bool                        mDetached;
};

#if !PX_DOXYGEN
} // namespace physx
#endif

#endif