Equalizer  1.12.0
Parallel Rendering Framework
eq::fabric::Statistic Struct Reference

A statistics event. More...

#include <statistic.h>

+ Collaboration diagram for eq::fabric::Statistic:

Public Types

enum  Type {
  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
}
 The type of the statistics event. More...
 

Static Public Member Functions

static EQFABRIC_API const std::string & getName (const Type type)
 Translate the Type to a string representation. More...
 
static EQFABRIC_API const Vector3f & getColor (const Type type)
 Translate the Type to a color value. More...
 

Public Attributes

Type type
 The type of statistic.
 
uint32_t frameNumber
 The frame during when the sampling happened.
 
uint32_t task
 
uint32_t plugins [2]
 color,depth plugins (readback, compression)
 
int64_t startTime
 Absolute start time of the operation.
 
int64_t endTime
 Absolute end time of the operation.
 
int64_t idleTime
 Absolute idle time of PIPE_IDLE.
 
int64_t totalTime
 Total time of a pipe frame (PIPE_IDLE)
 
float ratio
 compression ratio (transfer, compression)
 
float currentFPS
 FPS of last frame (WINDOW_FPS)
 
float averageFPS
 Weighted sum averaging of FPS (WINDOW_FPS)
 
float pad
 
char resourceName [32]
 A non-unique name of the originator.
 

Detailed Description

A statistics event.

Statistics are events generated by various Equalizer entities, typically using StatisticSampler. They are used by the server for load-balancing and to render the statistics overlay.

See also
Channel::drawStatistics

Definition at line 39 of file statistic.h.

Member Enumeration Documentation

The type of the statistics event.

Enumerator
CHANNEL_CLEAR 

Sampling of Channel::frameClear.

CHANNEL_DRAW 

Sampling of Channel::frameDraw.

CHANNEL_DRAW_FINISH 

Sampling of Channel::frameDrawFinish.

CHANNEL_ASSEMBLE 

Sampling of Channel::frameAssemble.

CHANNEL_FRAME_WAIT_READY 

Sampling of Frame::waitReady.

CHANNEL_READBACK 

Sampling of Channel::frameReadback.

CHANNEL_ASYNC_READBACK 

Sampling of async readback.

CHANNEL_VIEW_FINISH 

Sampling of Channel::frameViewFinish.

CHANNEL_FRAME_TRANSMIT 

Sampling of frame transmission.

CHANNEL_FRAME_COMPRESS 

Sampling of frame compression.

CHANNEL_FRAME_WAIT_SENDTOKEN 

Sampling of waiting for a send token from the receiver.

WINDOW_FINISH 

Sampling of Window::finish before a swap barrier.

WINDOW_THROTTLE_FRAMERATE 

Sampling of throttling of framerate_equalizer.

WINDOW_SWAP_BARRIER 

Sampling of swap barrier block.

WINDOW_SWAP 

Sampling of Window::swapBuffers.

WINDOW_FPS 

Framerate sampling.

PIPE_IDLE 

Pipe thread idle ratio.

NODE_FRAME_DECOMPRESS 

Sampling of frame decompression.

CONFIG_START_FRAME 

Sampling of Config::startFrame.

CONFIG_FINISH_FRAME 

Sampling of Config::finishFrame.

CONFIG_WAIT_FINISH_FRAME 

Sampling of synchronization time during Config::finishFrame.

Definition at line 42 of file statistic.h.

Member Function Documentation

static EQFABRIC_API const Vector3f& eq::fabric::Statistic::getColor ( const Type  type)
static

Translate the Type to a color value.

Version
1.0
static EQFABRIC_API const std::string& eq::fabric::Statistic::getName ( const Type  type)
static

Translate the Type to a string representation.

Version
1.0

The documentation for this struct was generated from the following file: