statistic.h

/* Copyright (c) 2009-2017, Stefan Eilemann <eile@equalizergraphics.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQ_FABRIC_STATISTIC_H
#define EQ_FABRIC_STATISTIC_H

#include <eq/fabric/api.h>
#include <eq/fabric/event.h> // base class
#include <eq/fabric/types.h>
#include <iostream>
#include <lunchbox/bitOperation.h> // inline template specialization

namespace eq
{
namespace fabric
{
struct Statistic : public Event
{
    enum Type // Also update string and color table in statistic.cpp
    {
        NONE = 0,
        CHANNEL_CLEAR,            
        CHANNEL_DRAW,             
        CHANNEL_DRAW_FINISH,      
        CHANNEL_ASSEMBLE,         
        CHANNEL_FRAME_WAIT_READY, 
        CHANNEL_READBACK,         
        CHANNEL_ASYNC_READBACK,   
        CHANNEL_VIEW_FINISH,      
        CHANNEL_FRAME_TRANSMIT,   
        CHANNEL_FRAME_COMPRESS,   

        CHANNEL_FRAME_WAIT_SENDTOKEN,
        WINDOW_FINISH, 

        WINDOW_THROTTLE_FRAMERATE,
        WINDOW_SWAP_BARRIER,   
        WINDOW_SWAP,           
        WINDOW_FPS,            
        PIPE_IDLE,             
        NODE_FRAME_DECOMPRESS, 
        CONFIG_START_FRAME,    
        CONFIG_FINISH_FRAME,   

        CONFIG_WAIT_FINISH_FRAME,
        ALL // must be last
    };

    Type type;            
    uint32_t frameNumber; 
    uint32_t task;        
    uint32_t plugins[2];  

    int64_t startTime; 
    int64_t endTime;   
    int64_t idleTime;  
    int64_t totalTime; 

    float ratio;      
    float currentFPS; 
    float averageFPS; 
    float pad;        

    char resourceName[32]; 

    EQFABRIC_API static const std::string& getName(const Type type);
    EQFABRIC_API static const Vector3f& getColor(const Type type);
};

EQFABRIC_API std::ostream& operator<<(std::ostream&, const Statistic::Type&);

EQFABRIC_API std::ostream& operator<<(std::ostream&, const Statistic&);
}
}

#endif // EQ_FABRIC_STATISTIC_H