fbprofiler.h

Go to the documentation of this file.

#ifndef __FBPROFILER_H__
#define __FBPROFILER_H__
/**************************************************************************
 Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
 All Rights Reserved.
 
 The coded instructions, statements, computer programs, and/or related 
 material (collectively the "Data") in these files contain unpublished 
 information proprietary to Autodesk, Inc. and/or its licensors, which is 
 protected by Canada and United States of America federal copyright law 
 and by international treaties.
 
 The Data may not be disclosed or distributed to third parties, in whole 
 or in part, without the prior written consent of Autodesk, Inc. 
 ("Autodesk").
 
 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
 ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
 OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
 PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
 WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
 FREE.
 
 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
 EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
 DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
 OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
 DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
 LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
 LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
 DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
 BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
 
**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL 

    #define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbcore.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

#define FBProfiler_CreateTaskCycle( pClass, pR, pG, pB ) \
    int gProfilingIndex_##pClass = -1; \
    float gProfilingColor_##pClass[3] = { pR, pG, pB };

#define FBProfiling_SetupTaskCycle( pClass ) \
    if(gProfilingIndex_##pClass == -1) \
        gProfilingIndex_##pClass = FBProfiler::TheOne().RegisterTaskCycle(#pClass,gProfilingColor_##pClass);

#define FBProfiling_TaskCycleIndex( pClass ) \
    gProfilingIndex_##pClass

__FB_FORWARD(FBProfiler);
FB_FORWARD(FBProfileTaskCycle);
__FB_FORWARD(FBProfileTimeEvent);
FB_FORWARD(FBEvaluateInfo);
FB_FORWARD(FBProfilerHelper);

class FBSDK_DLL FBProfileTaskCycle 
{
public:
    int             GetIndex();     
    const char*     GetName();      
    const float*    GetColor();     

    void            GetAvgMinMaxUsage(double& pAvg, double& pMin, double& pMax);

    // Sampling.
    void            Start();        
    void            Stop();         
    bool            IsStarted();    
    
    int             GetChildCount();
    
    HFBProfileTaskCycle GetChild(int pIndex);
private:

    FBProfileTaskCycle();
    FBProfileTaskCycle(const FBProfileTaskCycle &);
    FBProfileTaskCycle & operator =(const FBProfileTaskCycle &);
};

// FBProfileTimeEvent

class FBSDK_DLL FBProfileTimeEvent
{
public:
    FBTime          GetTime();          
    const float*    GetColor();         
    
    const char*     GetComment();       
    int             GetThreadID();      

    bool            IsSingleEvent();    
private:

    FBProfileTimeEvent();
    FBProfileTimeEvent(const FBProfileTimeEvent &);
    FBProfileTimeEvent & operator =(const FBProfileTimeEvent &);
};

enum FBProfilingMode
{
    kFBProfilingModeDisabled = 0,   
    kFBProfilingModeEvaluation,     
    kFBProfilingModeRendering,      
    kFBProfilingModeDevices,        
    kFBProfilingModeSDK,            
    kFBProfilingModeAllLow,         
    kFBProfilingModeAllHi           
};

FB_DEFINE_ENUM(FBSDK_DLL, ProfilingMode);

// FBProfiler

class FBSDK_DLL FBProfiler : public FBComponent {
    __FBClassDeclare( FBProfiler,FBComponent );
public:
    FBProfiler(HIObject pObject=NULL);

    FBPropertyProfilingMode ProfilingMode;      
    FBPropertyInt           EvaluationDepth;    
    FBPropertyInt           BufferSize;         
    FBPropertyBool          FrameReference;     
    FBPropertyBool          ActiveSampling;     
    
    // Event samples.
    int                     GetEventSampleCount();
    HFBProfileTimeEvent     GetEventSample( int pIndex );
    HFBProfileTimeEvent     GetEndEventSample( int pIndex );

    // Stats (for now only IO)
    
    int                     GetStatCount();
    int                     GetStatIndex(const char* pName);
    const char*             GetStatName(int pIndex);
    const char*             GetStatComment(int pIndex);
    double                  GetStatDuration(int pIndex);

    double                  GetProfilingCost();

    static int              RegisterTaskCycle(const char* pUniqueName, float* pColor = NULL);

    static bool             IsTaskCycleNameRegistered(const char* pName);

    static FBProfiler&      TheOne();
};

// FBProfilerHelper

class FBSDK_DLL FBProfilerHelper
{
public:
    FBProfilerHelper(int pTC_RegisterationIndex, HFBEvaluateInfo pEvaluateInfo, HFBProfileTaskCycle pParentTaskCycle = NULL);
    ~FBProfilerHelper();
    
    void Stop();

    inline bool IsStarted() { return mCurrentTaskCycle != NULL; }
private:
    HFBEvaluateInfo     mEvaluateInfo;
    HFBProfileTaskCycle mBackupTaskCycle;
    HFBProfileTaskCycle mCurrentTaskCycle;
};


// GLOBALS, for querying of FBProfileTaskCycle hierarchy or to be used in FBProfilerHelper constructor.
FBSDK_DLL HFBProfileTaskCycle   FBGetMainThreadTaskCycle();     
FBSDK_DLL HFBProfileTaskCycle   FBGetRenderingTaskCycle();      
FBSDK_DLL HFBProfileTaskCycle   FBGetEvaluationTaskCycle();     

#ifdef FBSDKUseNamespace
    }
#endif

#endif /* __FBPROFILER_H__ */