SO3GBuffer.cpp

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
 
-----------------------------------------------------------------------------
*/
 
#include "SO3Renderer/DeferredShading/SO3GBuffer.h"
#include "SO3Utils/SO3Exception.h"
 
namespace SO3
{
 
SGBuffer::SGBuffer(Ogre::String gBufferId, unsigned int gbufferMrtNumber) : SData(gBufferId),
                                                                            numberMrt(gbufferMrtNumber)
{
  channels = SO3_GBUFFER_NONE;
}
 
SGBuffer::SGBuffer() : SData(""),
                       numberMrt(0)
{
  // Forbiden ctor
}
 
unsigned int SGBuffer::GetNumberMrt() const
{
  return numberMrt;
}
 
Ogre::String SGBuffer::GetGBufferMaterialPixelOutputStructureTypeName()
{
  return GetGBufferMaterialPixelOutputStructureTypeNameImpl();
}
 
Ogre::String SGBuffer::GenerateGBufferMaterialPixelOutputStructure()
{
  return GenerateGBufferBaseMaterialPixelOutputStructure() + GenerateGBufferMaterialPixelOutputStructureImpl();
}
 
Ogre::String SGBuffer::GetGBufferCompositorPixelInputStructureTypeName()
{
  return GetGBufferCompositorPixelInputStructureTypeNameImpl();
}
 
Ogre::String SGBuffer::GenerateGBufferCompositorPixelInputStructure()
{
  return GenerateGBufferBaseCompositorPixelInputStructure() + GenerateGBufferCompositorPixelInputStructureImpl();
}
 
Ogre::String SGBuffer::GenerateGBufferBaseMaterialPixelOutputStructure()
{
  Ogre::StringStream ss;
 
  ss << "/*" << std::endl;
  ss << "Base interface for GBuffer data ordering abstraction" << std::endl;
  ss << "*/" << std::endl;
  ss << "interface I_GBufferPixelShaderOutput" << std::endl;
  ss << "{" << std::endl;
  ss << "  /*!" << std::endl;
  ss << "  Initialize output to default values" << std::endl;
  ss << "  */" << std::endl;
  ss << "  void Reset();" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the diffuse term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float3 GetDiffuse();" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Set the diffuse term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  void SetDiffuse(in float3 diffuse);" << std::endl;
  
  ss << "  /*!" << std::endl;
  ss << "  Get the specular term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float3 GetSpecular();" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Set the specular term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  void SetSpecular(in float3 specular);" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the shininess term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float GetShininess();" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Set the shininess term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  void SetShininess(in float shininess);" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the normal" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float3 GetNormal();" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Set the normal" << std::endl;
  ss << "  */" << std::endl;
  ss << "  void SetNormal(in float3 normal);" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the depth" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float GetDepth();" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Set the depth" << std::endl;
  ss << "  */" << std::endl;
  ss << "  void SetDepth(in float depth);" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the emissive term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float GetEmissive();" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Set the emissive term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  void SetEmissive(in float emissive);" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the material id" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float GetMaterialID();" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Set the material id term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  void SetMaterialID(in float materialId);" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the velocity vector" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float2 GetVelocity();" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Set the velocity vector" << std::endl;
  ss << "  */" << std::endl;
  ss << "  void SetVelocity(in float2 velocity);" << std::endl;
  ss << "};" << std::endl;
  ss << std::endl;
 
  return ss.str();
}
 
Ogre::String SGBuffer::GenerateGBufferBaseCompositorPixelInputStructure()
{
  Ogre::StringStream ss;
 
  ss << "/*" << std::endl;
  ss << "Base interface for GBuffer data ordering abstraction" << std::endl;
  ss << "*/" << std::endl;
  ss << "interface I_GBufferPixelShaderInput" << std::endl;
  ss << "{" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the diffuse term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float3 GetDiffuse(in float2 coordinate);" << std::endl;
  
  ss << "  /*!" << std::endl;
  ss << "  Get the specular term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float3 GetSpecular(in float2 coordinate);" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the shininess term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float GetShininess(in float2 coordinate);" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the normal" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float3 GetNormal(in float2 coordinate);" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the depth" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float GetDepth(in float2 coordinate);" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the emissive term" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float GetEmissive(in float2 coordinate);" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the material id" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float GetMaterialID(in float2 coordinate);" << std::endl;
 
  ss << "  /*!" << std::endl;
  ss << "  Get the velocity vector" << std::endl;
  ss << "  */" << std::endl;
  ss << "  float2 GetVelocity(in float2 coordinate);" << std::endl;
 
  ss << "};" << std::endl;
  ss << std::endl;
 
  return ss.str();
}
 
Ogre::uint32 SGBuffer::GetChannels()
{
  assert(channels != SO3_GBUFFER_NONE);
  assert(channels & SO3_GBUFFER_MANDATORY_MASK);
  return channels;
}
 
}