KeosRenderSystem.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_RENDERSYSTEM_H
#define KEOS_RENDERSYSTEM_H

#include "KeosPrerequisites.h"
#include "KeosRenderTarget.h"
#include "KeosRenderWindow.h"
#include "KeosRenderApp.h"
#include "KeosDeclaration.h"
#include "KeosBuffer.h"
#include "KeosRenderSystemCapabilities.h"
#include "KeosConfigOption.h"
#include "KeosColor.h"
#include "Cg/cg.h"

#define Renderer CRoot::Instance().GetRenderSystem()

namespace Keos
{
  typedef std::map< String, IRenderTarget * > RenderTargetMap;

  //-----------------------------------------------------------------------
  class KEOS_EXPORT IRenderSystem
  {
  public :

    IRenderSystem();

    virtual ~IRenderSystem();

    virtual const String& GetName(void) const = 0;

    virtual IRenderWindow* Initialise(bool bAutoCreateWindow, const String& strWindowTitle = "KEOS Render Window");

    virtual IRenderWindow* CreateRenderWindow(const String &strName, uint nWidth, uint nHeight, uint nColourDepth, bool bFullScreen) = 0;

    virtual void Reinitialise(void) = 0;

    virtual void Shutdown(void);

    void AttachRenderTarget( IRenderTarget& target , bool bIsWindow = true);

    bool SetRenderApp(IRenderApp* pRenderApp)
    {
      if (m_pRenderWindow == NULL) return false;
      m_pRenderWindow->SetRenderApp(pRenderApp);
      return true;
    }

    bool SetRenderApp(IRenderApp* pRenderApp, String& strTargetName);

    const CRenderSystemCapabilities* GetCapabilities(void) const
    {
      return m_pCapabilities;
    }

    virtual void BeginScene(void) const = 0;

    virtual void EndScene(void) const = 0;

    virtual void PrintInfo(void) const = 0;

    void InitAllRenderTargets(void);

    void UpdateAllRenderTargets(void);

    void DestroyRenderTarget(const String& strName);

    IRenderTarget* DetachRenderTarget( const String &strName );

    IRenderTarget* GetRenderTarget( const String &strName );

    virtual IBufferBase* _CreateVB(ulong nSize, ulong nStride, ulong nFlags) const = 0;

    virtual IBufferBase* _CreateIB(ulong nSize, ulong nStride, ulong nFlags) const = 0;

    virtual IDeclaration* CreateDeclaration(const TDeclarationElement* pElements, size_t nCount) const = 0;

    virtual void _SetVB(uint nStream, const IBufferBase* pBuffer, ulong nStride, ulong nMinVertex, ulong nMaxVertex) = 0;

    virtual void _SetIB(const IBufferBase* pBuffer, ulong nStride) = 0;

    virtual void SetDeclaration(const IDeclaration* pDeclaration) = 0;

    virtual void DrawPrimitives(TPrimitiveType Type, ulong nFirstVertex, ulong nCount) const = 0;

    virtual void DrawIndexedPrimitives(TPrimitiveType Type, ulong nFirstIndex, ulong nCount) const = 0;

    virtual void PushMatrix(TMatrixType Type) = 0;

    virtual void PopMatrix(TMatrixType Type) = 0;

    virtual void LoadMatrix(TMatrixType Type, const CMatrix4& Matrix) = 0;

    virtual void LoadMatrixMult(TMatrixType Type, const CMatrix4& Matrix) = 0;

    virtual void GetMatrix(TMatrixType Type, CMatrix4& Matrix) const = 0;

    virtual ulong ConvertColor(const CColor& Color) const = 0;

    template <class T> CBuffer<T> CreateVertexBuffer(ulong nSize, ulong nFlags, const T* pData = NULL) const;

    template <class T> CBuffer<T> CreateIndexBuffer(ulong nSize, ulong nFlags, const T* pData = NULL) const;

    template <class T> void SetVertexBuffer(uint nStream, const CBuffer<T>& Buffer, ulong nMinVertex = 0, ulong nMaxVertex = 0);

    template <class T> void SetIndexBuffer(const CBuffer<T>& Buffer);

    template <size_t N> IDeclaration* CreateVertexDeclaration(const TDeclarationElement (&Elements)[N]) const;

    virtual ITextureBase* CreateTexture(const TVector2I& Size, TPixelFormat Format, ulong nFlags = 0) const = 0;

    virtual void SetTexture(uint nUnit, const ITextureBase* pTexture) const = 0;

    virtual void InitConfigOptions(void);

    virtual void SetConfigOption(const String& strName, const String& strValue);

    virtual ConfigOptionMap GetConfigOptions()
    {
      return m_Options;
    }

    virtual void SetupAlphaBlending(TBlend Src, TBlend Dest) const = 0;

    virtual void SetupTextureUnit(uint nUnit, TTextureOp Op, TTextureArg Arg1, TTextureArg Arg2 = TXA_DIFFUSE, const CColor& Constant = 0x00) const = 0;

    virtual void Enable(TRenderParameter Param, bool bValue) const = 0;

    CGprofile GetShaderProfile(TShaderType Type) const;

    const char* const* GetShaderOptions(TShaderType Type) const;

    virtual IShaderBase* CreateShader(CGprogram Program, TShaderType Type) const = 0;

    virtual void SetVertexShader(const IShaderBase* pShader) = 0;

    virtual void SetPixelShader(const IShaderBase* pShader) = 0;

    virtual void SetClearColor(const CColor& Color) = 0;

    virtual void SetLight(uint nIndex, CLight* pLight) = 0;

    virtual void SetFillMode(TFillMode Mode) = 0;

  protected :

    IRenderWindow* m_pRenderWindow;

    RenderTargetMap m_RenderTargets;

    CRenderSystemCapabilities* m_pCapabilities;

    ConfigOptionMap m_Options;

    CGprofile   m_VSProfile;
    CGprofile   m_PSProfile;
    const char* m_VSOptions[2];
    const char* m_PSOptions[2];

    CColor m_ClearColor;
  };


  //=======================================================================
  // IRenderSystem inline functions
  //=======================================================================

  //-----------------------------------------------------------------------
  template <class T>
  inline CBuffer<T> IRenderSystem::CreateVertexBuffer(ulong nSize, ulong nFlags, const T* pData) const
  {
    CBuffer<T> Buffer(_CreateVB(nSize, sizeof(T), nFlags));
    if (pData)
      Buffer.Fill(pData, nSize);

    return Buffer;
  }

  //-----------------------------------------------------------------------
  template <class T>
  inline CBuffer<T> IRenderSystem::CreateIndexBuffer(ulong nSize, ulong nFlags, const T* pData) const
  {
    CBuffer<T> Buffer(_CreateIB(nSize, sizeof(T), nFlags));
    if (pData)
      Buffer.Fill(pData, nSize);

    return Buffer;
  }

  //-----------------------------------------------------------------------
  template <class T>
  inline void IRenderSystem::SetVertexBuffer(uint nStream, const CBuffer<T>& Buffer, ulong nMinVertex, ulong nMaxVertex)
  {
    _SetVB(nStream, Buffer.GetBuffer(), sizeof(T), nMinVertex, nMaxVertex ? nMaxVertex : Buffer.GetCount() - 1);
  }

  //-----------------------------------------------------------------------
  template <class T>
  inline void IRenderSystem::SetIndexBuffer(const CBuffer<T>& Buffer)
  {
    _SetIB(Buffer.GetBuffer(), sizeof(T));
  }

  //-----------------------------------------------------------------------
  template <size_t N>
  IDeclaration* IRenderSystem::CreateVertexDeclaration(const TDeclarationElement (&Elements)[N]) const
  {
    return CreateDeclaration(Elements, N);
  }

} // namespace Keos

#endif // KEOS_RENDERSYSTEM_H

---