SO3Engine
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SO3::SGBuffer Class Referenceabstract

#include <SO3GBuffer.h>

Inheritance diagram for SO3::SGBuffer:
SO3::SData SO3::SGBufferHigh SO3::SGBufferLow

Public Types

enum  GBufferChannels {
  SO3_GBUFFER_NONE = 0x00 , SO3_GBUFFER_DIFFUSE = 0x01 , SO3_GBUFFER_NORMALS = 0x02 , SO3_GBUFFER_DEPTH = 0x04 ,
  SO3_GBUFFER_SPECULAR = 0x08 , SO3_GBUFFER_SHININESS = 0x0F , SO3_GBUFFER_EMISSIVE = 0x10 , SO3_GBUFFER_VELOCITY = 0x20 ,
  SO3_GBUFFER_MATERIAL_ID = 0x40 , SO3_GBUFFER_MANDATORY_MASK = 0x04
}
 

Public Member Functions

unsigned int GetNumberMrt () const
 
Ogre::String GetGBufferMaterialPixelOutputStructureTypeName ()
 
Ogre::String GenerateGBufferMaterialPixelOutputStructure ()
 
Ogre::String GetGBufferCompositorPixelInputStructureTypeName ()
 
Ogre::String GenerateGBufferCompositorPixelInputStructure ()
 
Ogre::uint32 GetChannels ()
 
- Public Member Functions inherited from SO3::SData
 SData (const std::string &dataName)
 
virtual ~SData ()
 
std::string GetName () const
 
SUserObjectBindingsGetUserObjectBindings ()
 
const SUserObjectBindingsGetUserObjectBindings () const
 

Protected Member Functions

 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
 

Protected Attributes

Ogre::uint32 channels
 
- Protected Attributes inherited from SO3::SData
std::string name
 

Detailed Description

Definition at line 36 of file SO3GBuffer.h.

Member Enumeration Documentation

◆ GBufferChannels

Enumerator
SO3_GBUFFER_NONE 
SO3_GBUFFER_DIFFUSE 
SO3_GBUFFER_NORMALS 
SO3_GBUFFER_DEPTH 
SO3_GBUFFER_SPECULAR 
SO3_GBUFFER_SHININESS 
SO3_GBUFFER_EMISSIVE 
SO3_GBUFFER_VELOCITY 
SO3_GBUFFER_MATERIAL_ID 
SO3_GBUFFER_MANDATORY_MASK 

Definition at line 39 of file SO3GBuffer.h.

Constructor & Destructor Documentation

◆ SGBuffer()

SO3::SGBuffer::SGBuffer ( Ogre::String  gbufferId,
unsigned int  gbufferMrtNumber 
)
protected

Must be inherited

Parameters
gbufferIdGBuffer data layout identifier name
gbufferMrtNumbernumber of MRT used by this GBuffer layout

Definition at line 31 of file SO3GBuffer.cpp.

Member Function Documentation

◆ GenerateGBufferCompositorPixelInputStructure()

Ogre::String SO3::SGBuffer::GenerateGBufferCompositorPixelInputStructure ( )

Definition at line 63 of file SO3GBuffer.cpp.

◆ GenerateGBufferCompositorPixelInputStructureImpl()

virtual Ogre::String SO3::SGBuffer::GenerateGBufferCompositorPixelInputStructureImpl ( )
protectedpure virtual

To implement in inherited classes

◆ GenerateGBufferMaterialPixelOutputStructure()

Ogre::String SO3::SGBuffer::GenerateGBufferMaterialPixelOutputStructure ( )

Definition at line 53 of file SO3GBuffer.cpp.

◆ GenerateGBufferMaterialPixelOutputStructureImpl()

virtual Ogre::String SO3::SGBuffer::GenerateGBufferMaterialPixelOutputStructureImpl ( )
protectedpure virtual

To implement in inherited classes

◆ GetChannels()

Ogre::uint32 SO3::SGBuffer::GetChannels ( )

Retrieve the channels (components) that are supported by this GBuffer

Definition at line 223 of file SO3GBuffer.cpp.

◆ GetGBufferCompositorPixelInputStructureTypeName()

Ogre::String SO3::SGBuffer::GetGBufferCompositorPixelInputStructureTypeName ( )

Definition at line 58 of file SO3GBuffer.cpp.

◆ GetGBufferCompositorPixelInputStructureTypeNameImpl()

virtual Ogre::String SO3::SGBuffer::GetGBufferCompositorPixelInputStructureTypeNameImpl ( )
protectedpure virtual

To implement in inherited classes

◆ GetGBufferMaterialPixelOutputStructureTypeName()

Ogre::String SO3::SGBuffer::GetGBufferMaterialPixelOutputStructureTypeName ( )

Definition at line 48 of file SO3GBuffer.cpp.

◆ GetGBufferMaterialPixelOutputStructureTypeNameImpl()

virtual Ogre::String SO3::SGBuffer::GetGBufferMaterialPixelOutputStructureTypeNameImpl ( )
protectedpure virtual

To implement in inherited classes

◆ GetNumberMrt()

unsigned int SO3::SGBuffer::GetNumberMrt ( ) const

Definition at line 43 of file SO3GBuffer.cpp.

Member Data Documentation

◆ channels

Ogre::uint32 SO3::SGBuffer::channels
protected

Definition at line 53 of file SO3GBuffer.h.


The documentation for this class was generated from the following files: