KeosRenderTarget.h

Go to the documentation of this file.

/*
 * This source file is part of KEOS (Free 3D Engine)
 * For the latest info, see http://www.keosengine.org/
 * E-mails : thierry.vouriot@keosengine.org, yeri@keosengine.org
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 *
 * This program 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 program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place - Suite 330, Boston, MA 02111-1307, USA, or go to
 * http://www.gnu.org/copyleft/lesser.txt.
 *
 */

#ifndef KEOS_RENDERTARGET_H
#define KEOS_RENDERTARGET_H

#include "KeosPrerequisites.h"
#include "KeosRenderApp.h"

namespace Keos
{
  //-----------------------------------------------------------------------
  class KEOS_EXPORT IRenderTarget
  {
  public:
    enum StatFlags
    {
      SF_NONE           = 0,
      SF_FPS            = 1,
      SF_AVG_FPS        = 2,
      SF_BEST_FPS       = 4,
      SF_WORST_FPS      = 8,
      SF_TRIANGLE_COUNT = 16,
      SF_ALL            = 0xFFFF
    };

    struct FrameStats
    {
      float lastFPS;
      float avgFPS;
      float bestFPS;
      float worstFPS;
      unsigned long bestFrameTime;
      unsigned long worstFrameTime;
      unsigned long lastFrameTime;
      size_t triangleCount;
    };

    IRenderTarget();

    virtual ~IRenderTarget();

    virtual const String& GetName(void) const;

    virtual void GetMetrics(uint& nWidth, uint& nHeight, uint& nColourDepth);

    virtual unsigned int GetWidth(void) const;
    virtual unsigned int GetHeight(void) const;
    virtual unsigned int GetColourDepth(void) const;

    virtual void Init(void);

    virtual void Update(void);

    virtual void GetStatistics(float& lastFPS, float& avgFPS,
                               float& bestFPS, float& worstFPS) const;

    virtual float GetLastFPS() const;

    virtual float GetAverageFPS() const;

    virtual float GetBestFPS() const;

    virtual float GetWorstFPS() const;

    virtual float GetBestFrameTime() const;

    virtual float GetWorstFrameTime() const;

    virtual float GetLastFrameTime() const;

    virtual void ResetStatistics(void);

    virtual bool IsActive() const;

    virtual void SetActive( bool bState );

    virtual void SetAutoUpdated(bool bAutoUpdate);

    virtual bool IsAutoUpdated(void) const;

    virtual size_t GetTriangleCount(void) const;

    void SetRenderApp(IRenderApp* pRenderApp)
    {
      m_pRenderApp = pRenderApp;
      pRenderApp->m_pRenderTarget = this;
    }

  protected:

    void UpdateStats(void);

    String m_strName;

    IRenderApp* m_pRenderApp;

    unsigned int m_nWidth;

    unsigned int m_nHeight;

    unsigned int m_nColourDepth;

    FrameStats m_Stats;

    CTimer* m_pTimer ;

    // Variables for stats claculation
    unsigned long m_nLastSecond;
    unsigned long m_nLastTime;
    size_t m_nFrameCount;

    bool m_bActive;
    bool m_bAutoUpdate;

    bool m_bIsDepthBuffered;
  };

  //=======================================================================
  // IRenderTarget inline functions
  //=======================================================================

  //-----------------------------------------------------------------------
  inline const String& IRenderTarget::GetName(void) const
  {
    return m_strName;
  }

  //-----------------------------------------------------------------------
  inline uint IRenderTarget::GetWidth(void) const
  {
    return m_nWidth;
  }

  //-----------------------------------------------------------------------
  inline uint IRenderTarget::GetHeight(void) const
  {
    return m_nHeight;
  }

  //-----------------------------------------------------------------------
  inline uint IRenderTarget::GetColourDepth(void) const
  {
    return m_nColourDepth;
  }

  //-----------------------------------------------------------------------
  inline bool IRenderTarget::IsActive() const
  {
    return m_bActive;
  }

  //-----------------------------------------------------------------------
  inline void IRenderTarget::SetActive( bool bState )
  {
    m_bActive = bState;
  }

  //-----------------------------------------------------------------------
  inline void IRenderTarget::SetAutoUpdated(bool bAutoUpdate)
  {
    m_bAutoUpdate = bAutoUpdate;
  }

  //-----------------------------------------------------------------------
  inline bool IRenderTarget::IsAutoUpdated(void) const
  {
    return m_bAutoUpdate;
  }

  //-----------------------------------------------------------------------
  inline void IRenderTarget::GetStatistics(float& lastFPS, float& avgFPS,
      float& bestFPS, float& worstFPS) const
  {
    // Note - the will have been updated by the last render
    lastFPS = m_Stats.lastFPS;
    avgFPS = m_Stats.avgFPS;
    bestFPS = m_Stats.bestFPS;
    worstFPS = m_Stats.worstFPS;
  }

  //-----------------------------------------------------------------------
  inline float IRenderTarget::GetLastFPS() const
  {
    return m_Stats.lastFPS;
  }

  //-----------------------------------------------------------------------
  inline float IRenderTarget::GetAverageFPS() const
  {
    return m_Stats.avgFPS;
  }

  //-----------------------------------------------------------------------
  inline float IRenderTarget::GetBestFPS() const
  {
    return m_Stats.bestFPS;
  }

  //-----------------------------------------------------------------------
  inline float IRenderTarget::GetWorstFPS() const
  {
    return m_Stats.worstFPS;
  }

  //-----------------------------------------------------------------------
  inline size_t IRenderTarget::GetTriangleCount(void) const
  {
    return m_Stats.triangleCount;
  }

  //-----------------------------------------------------------------------
  inline float IRenderTarget::GetBestFrameTime() const
  {
    return m_Stats.bestFrameTime;
  }

  //-----------------------------------------------------------------------
  inline float IRenderTarget::GetWorstFrameTime() const
  {
    return m_Stats.worstFrameTime;
  }

  //-----------------------------------------------------------------------
  inline float IRenderTarget::GetLastFrameTime() const
  {
    return m_Stats.lastFrameTime;
  }

} // Namespace Keos

#endif // KEOS_RENDERTARGET_H

---