PxDefaultBufferedProfiler.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */


#ifndef PX_DEFAULT_BUFFERED_PROFILER_H
#define PX_DEFAULT_BUFFERED_PROFILER_H

#include "common/PxPhysXCommonConfig.h"

#ifndef PX_DOXYGEN
namespace physx
{
#endif
    class PxProfileZoneManager; 

    struct PxBufferedProfilerEvent
    {
        PxU64           startTimeNs;        
        PxU64           stopTimeNs;         
        const char*     name;               
        const char*     profileZoneName;    
        PxU16           id;                 
        PxU64           contextId;          


        PxU32           threadId;           
        PxU8            threadPriority;     
        PxU8            cpuId;              
    };

    class PxBufferedProfilerCallback
    {
    public:
        static const PxU32 CROSS_THREAD_ID = 99999789;

        virtual void onEvent(const PxBufferedProfilerEvent &event) = 0;

    protected:
        virtual ~PxBufferedProfilerCallback(void) {}
    };


    class PxDefaultBufferedProfiler
    {
    public:
        virtual void flushEvents() = 0;

        virtual PxProfileZoneManager& getProfileZoneManager() = 0;

        virtual void addBufferedProfilerCallback(PxBufferedProfilerCallback& cb) = 0;

        virtual void removeBufferedProfilerCallback(PxBufferedProfilerCallback& cb) = 0;

        virtual void release() = 0;

    protected:
        virtual ~PxDefaultBufferedProfiler(void) {}
    };


    PxDefaultBufferedProfiler* PxDefaultBufferedProfilerCreate(PxFoundation & foundation, const char * profileZoneNames );


#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif // PX_DEFAULT_BUFFERED_PROFILER_H