GUI FPS Counter

I have added a FPS counter in the GUI object tree.
Here you can find the code
Create a new CC file in the directory engine\game\fps called guiFPSCounterHud.cc and copy this code in it:

//-----------------------------------------------------------------------------
// 
//-----------------------------------------------------------------------------

#include "dgl/dgl.h"
#include "gui/guiControl.h"
#include "console/consoleTypes.h"
#include "game/gameConnection.h"
#include "game/shapeBase.h"

extern F32 fpsReal;

//-----------------------------------------------------------------------------
/**
   basic FPS Counter.
*/
class GuiFPSCounterHud : public GuiControl
{
   typedef GuiControl Parent;

   bool     mShowFrame;
   bool     mShowFill;

   ColorF   mFillColor;
   ColorF   mFrameColor;
   ColorF   mTextColor;

public:
   GuiFPSCounterHud();

   void onRender( Point2I, const RectI &);
   static void initPersistFields();
   DECLARE_CONOBJECT( GuiFPSCounterHud );
};


//-----------------------------------------------------------------------------

IMPLEMENT_CONOBJECT( GuiFPSCounterHud );

GuiFPSCounterHud::GuiFPSCounterHud()
{
   mShowFrame = mShowFill = true;
   mFillColor.set(0, 0, 0, 0.5);
   mFrameColor.set(0, 1, 0, 1);
   mTextColor.set( 0, 1, 0, 1 );
}

void GuiFPSCounterHud::initPersistFields()
{
   Parent::initPersistFields();

   addField( "showFill", TypeBool, Offset( mShowFill, GuiFPSCounterHud ) );
   addField( "showFrame", TypeBool, Offset( mShowFrame, GuiFPSCounterHud ) );
   addField( "fillColor", TypeColorF, Offset( mFillColor, GuiFPSCounterHud ) );
   addField( "frameColor", TypeColorF, Offset( mFrameColor, GuiFPSCounterHud ) );
   addField( "textColor", TypeColorF, Offset( mTextColor, GuiFPSCounterHud ) );
}


//-----------------------------------------------------------------------------

void GuiFPSCounterHud::onRender(Point2I offset, const RectI &updateRect)
{
   // Background first
   if (mShowFill)
      dglDrawRectFill(updateRect, mFillColor);
   
   char buf[256];
   dSprintf(buf,sizeof(buf), "FPS : %4.1f", 1.0f/fpsReal);

   // Center the text
   offset.x += (mBounds.extent.x - mProfile->mFont->getStrWidth(buf)) / 2;
   offset.y += (mBounds.extent.y - mProfile->mFont->getHeight()) / 2;
   dglSetBitmapModulation(mTextColor);
   dglDrawText(mProfile->mFont, offset, buf);
   dglClearBitmapModulation();

   // Border last
   if (mShowFrame)
      dglDrawRect(updateRect, mFrameColor);
}

Add this file to your project off course

and change in main.cc the line :

static F32 fpsReal;

to

F32 fpsReal;

you have now in the GUI editor a new object called :

GuiFPSCounterHud

this object can be placed in the playGUI with the GUI editor and you have a permanent framecounter visible.

Before the flames start, I'm aware that the value of the fpsReal variable can be given to the object by script code, by adding some code to this object and adding a script. I have choosen myself not to do this because I don't want to hit the scripting engine when updating the counter. I'll leave this as an exercise to someone else.
;-)


Jan