SO3GBuffer.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OpenSpace3D
For the latest info, see http://www.openspace3d.com
 
Copyright (c) 2012 I-maginer
 
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 __SO3_DEFERRED_SHADING_GBUFFER_H__
#define __SO3_DEFERRED_SHADING_GBUFFER_H__
 
#include "SCOLBasic/SO3DataScol.h"
#include "OgreStringConverter.h"
 
namespace SO3
{
 
class _SO3_Export SGBuffer : public SData
{
public:
  enum GBufferChannels
  {
    SO3_GBUFFER_NONE           = 0x00,
    SO3_GBUFFER_DIFFUSE        = 0x01,  // Mandatory, diffuse color of the texel in view space
    SO3_GBUFFER_NORMALS        = 0x02,  // Mandatory, normal of the texel, relative to the camera, in view space
    SO3_GBUFFER_DEPTH          = 0x04,  // Mandatory, Z position (depth) of the texel, relative to the camera, in view space
    SO3_GBUFFER_SPECULAR       = 0x08,  // Specular colour of the (unlit) texel
    SO3_GBUFFER_SHININESS      = 0x0F,  // Shininess power of the specular component. If shininess is supported by the gbuffer, but not specular component, the 'lit' specular colour will be computed using an approximation of the specular light contribution.
    SO3_GBUFFER_EMISSIVE       = 0x10,  // Emissive power of the texel. This is not the standard emissive colour, diffuse colour will be used instead of it. A sum of the standard emissive colour components is done, and then divided by 3 (alpha is ignored) to compute the emissive power.
    SO3_GBUFFER_VELOCITY       = 0x20,  // Velocity vector from one frame to another, for motion blur
        SO3_GBUFFER_MATERIAL_ID    = 0x40,  // Material ID to switch light processing method in shaders
    SO3_GBUFFER_MANDATORY_MASK = 0x04   // Useful mask to extract ony mandatory components.
  };
protected:
  Ogre::uint32 channels;
private:
  const unsigned int numberMrt;
 
public:
  unsigned int GetNumberMrt() const;
 
  Ogre::String GetGBufferMaterialPixelOutputStructureTypeName();
 
  Ogre::String GenerateGBufferMaterialPixelOutputStructure();
 
  Ogre::String GetGBufferCompositorPixelInputStructureTypeName();
 
  Ogre::String GenerateGBufferCompositorPixelInputStructure();
 
  Ogre::uint32 GetChannels();
protected:
  SGBuffer(Ogre::String gbufferId, unsigned int gbufferMrtNumber);
 
  virtual Ogre::String GetGBufferMaterialPixelOutputStructureTypeNameImpl()=0;
 
  virtual Ogre::String GenerateGBufferMaterialPixelOutputStructureImpl()=0;
  
  virtual Ogre::String GetGBufferCompositorPixelInputStructureTypeNameImpl()=0;
 
  virtual Ogre::String GenerateGBufferCompositorPixelInputStructureImpl()=0;
private:
  SGBuffer();
 
  Ogre::String GenerateGBufferBaseMaterialPixelOutputStructure();
 
  Ogre::String GenerateGBufferBaseCompositorPixelInputStructure();
};
 
}
 
#endif