RenderSystem
[Core]

Collaboration diagram for RenderSystem:

Classes

class  Ogre::DefaultHardwareVertexBuffer
 Specialisation of HardwareVertexBuffer for emulation. More...
class  Ogre::DefaultHardwareIndexBuffer
 Specialisation of HardwareIndexBuffer for emulation. More...
class  Ogre::DefaultHardwareBufferManagerBase
 Specialisation of HardwareBufferManagerBase to emulate hardware buffers. More...
class  Ogre::DefaultHardwareBufferManager
 DefaultHardwareBufferManager as a Singleton. More...
class  Ogre::HardwareBuffer
 Abstract class defining common features of hardware buffers. More...
class  Ogre::HardwareBufferLicensee
 Abstract interface representing a 'licensee' of a hardware buffer copy. More...
class  Ogre::TempBlendedBufferInfo
 Structure for recording the use of temporary blend buffers. More...
class  Ogre::HardwareBufferManagerBase
 Base definition of a hardware buffer manager. More...
class  Ogre::HardwareBufferManager
 Singleton wrapper for hardware buffer manager. More...
class  Ogre::HardwareIndexBuffer
 Specialisation of HardwareBuffer for vertex index buffers, still abstract. More...
class  Ogre::HardwareIndexBufferSharedPtr
 Shared pointer implementation used to share index buffers. More...
class  Ogre::HardwareOcclusionQuery
 This is a abstract class that that provides the interface for the query class for hardware occlusion. More...
class  Ogre::HardwarePixelBuffer
 Specialisation of HardwareBuffer for a pixel buffer. More...
class  Ogre::HardwarePixelBufferSharedPtr
 Shared pointer implementation used to share pixel buffers. More...
class  Ogre::HardwareVertexBuffer
 Specialisation of HardwareBuffer for a vertex buffer. More...
class  Ogre::HardwareVertexBufferSharedPtr
 Shared pointer implementation used to share index buffers. More...
class  Ogre::VertexElement
 This class declares the usage of a single vertex buffer as a component of a complete VertexDeclaration. More...
class  Ogre::VertexDeclaration
 This class declares the format of a set of vertex inputs, which can be issued to the rendering API through a RenderOperation. More...
class  Ogre::VertexBufferBinding
 Records the state of all the vertex buffer bindings required to provide a vertex declaration with the input data it needs for the vertex elements. More...
class  Ogre::RenderOperation
 'New' rendering operation using vertex buffers. More...
class  Ogre::RenderQueue
 Class to manage the scene object rendering queue. More...
class  Ogre::RenderQueueInvocation
 Class representing the invocation of queue groups in a RenderQueue. More...
class  Ogre::RenderQueueInvocationSequence
 Class to hold a linear sequence of RenderQueueInvocation objects. More...
class  Ogre::RenderQueueListener
 Abstract interface which classes must implement if they wish to receive events from the render queue. More...
struct  Ogre::RenderablePass
 Struct associating a single Pass with a single Renderable. More...
class  Ogre::QueuedRenderableVisitor
 Visitor interface for items in a QueuedRenderableCollection. More...
class  Ogre::QueuedRenderableCollection
 Lowest level collection of renderables. More...
class  Ogre::RenderPriorityGroup
 Collection of renderables by priority. More...
class  Ogre::RenderQueueGroup
 A grouping level underneath RenderQueue which groups renderables to be issued at coarsely the same time to the renderer. More...
class  Ogre::RenderSystem
 Defines the functionality of a 3D API. More...
class  Ogre::RenderSystemCapabilitiesManager
 Class for managing RenderSystemCapabilities database for Ogre. More...
class  Ogre::RenderSystemCapabilitiesSerializer
 Class for serializing RenderSystemCapabilities to / from a .rendercaps script. More...
class  Ogre::RenderTarget
 A 'canvas' which can receive the results of a rendering operation. More...
struct  Ogre::RenderTargetEvent
 Struct containing information about a RenderTarget event. More...
struct  Ogre::RenderTargetViewportEvent
 Struct containing information about a RenderTarget Viewport-specific event. More...
class  Ogre::RenderTargetListener
 A interface class defining a listener which can be used to receive notifications of RenderTarget events. More...
class  Ogre::RenderTexture
 This class represents a RenderTarget that renders to a Texture. More...
class  Ogre::MultiRenderTarget
 This class represents a render target that renders to multiple RenderTextures at once. More...
class  Ogre::RenderToVertexBuffer
 An object which renders geometry to a vertex. More...
class  Ogre::RenderWindow
 Manages the target rendering window. More...
class  Ogre::VertexData
 Summary class collecting together vertex source information. More...
class  Ogre::IndexData
 Summary class collecting together index data source information. More...
class  Ogre::VertexCacheProfiler
 Vertex cache profiler. More...
class  Ogre::Viewport
 An abstraction of a viewport, i.e. More...
class  Ogre::WindowEventListener
 Callback class used to send out window events to client app More...
class  Ogre::WindowEventUtilities
 Utility class to handle Window Events/Pumping/Messages More...

Defines

#define OGRE_RENDERABLE_DEFAULT_PRIORITY   100

Typedefs

typedef vector
< RenderQueueInvocation * >
::type 
Ogre::RenderQueueInvocationList
 List of RenderQueueInvocations.
typedef VectorIterator
< RenderQueueInvocationList > 
Ogre::RenderQueueInvocationIterator
typedef map< String,
RenderTarget * >::type 
Ogre::RenderTargetMap
typedef multimap< uchar,
RenderTarget * >::type 
Ogre::RenderTargetPriorityMap
typedef SharedPtr
< RenderToVertexBuffer > 
Ogre::RenderToVertexBufferSharedPtr
typedef vector
< HardwareBuffer::Usage >
::type 
Ogre::BufferUsageList
 Define a list of usage flags.

Enumerations

enum  Ogre::VertexElementSemantic {
  Ogre::VES_POSITION = 1, Ogre::VES_BLEND_WEIGHTS = 2, Ogre::VES_BLEND_INDICES = 3, Ogre::VES_NORMAL = 4,
  Ogre::VES_DIFFUSE = 5, Ogre::VES_SPECULAR = 6, Ogre::VES_TEXTURE_COORDINATES = 7, Ogre::VES_BINORMAL = 8,
  Ogre::VES_TANGENT = 9
}
 

Vertex element semantics, used to identify the meaning of vertex buffer contents.

More...
enum  Ogre::VertexElementType {
  Ogre::VET_FLOAT1 = 0, Ogre::VET_FLOAT2 = 1, Ogre::VET_FLOAT3 = 2, Ogre::VET_FLOAT4 = 3,
  Ogre::VET_COLOUR = 4, Ogre::VET_SHORT1 = 5, Ogre::VET_SHORT2 = 6, Ogre::VET_SHORT3 = 7,
  Ogre::VET_SHORT4 = 8, Ogre::VET_UBYTE4 = 9, Ogre::VET_COLOUR_ARGB = 10, Ogre::VET_COLOUR_ABGR = 11
}
 

Vertex element type, used to identify the base types of the vertex contents.

More...
enum  Ogre::RenderQueueGroupID {
  Ogre::RENDER_QUEUE_BACKGROUND = 0, Ogre::RENDER_QUEUE_SKIES_EARLY = 5, Ogre::RENDER_QUEUE_1 = 10, Ogre::RENDER_QUEUE_2 = 20,
  Ogre::RENDER_QUEUE_WORLD_GEOMETRY_1 = 25, Ogre::RENDER_QUEUE_3 = 30, Ogre::RENDER_QUEUE_4 = 40, Ogre::RENDER_QUEUE_MAIN = 50,
  Ogre::RENDER_QUEUE_6 = 60, Ogre::RENDER_QUEUE_7 = 70, Ogre::RENDER_QUEUE_WORLD_GEOMETRY_2 = 75, Ogre::RENDER_QUEUE_8 = 80,
  Ogre::RENDER_QUEUE_9 = 90, Ogre::RENDER_QUEUE_SKIES_LATE = 95, Ogre::RENDER_QUEUE_OVERLAY = 100, Ogre::RENDER_QUEUE_MAX = 105
}
 

Enumeration of queue groups, by which the application may group queued renderables so that they are rendered together with events in between.

More...
enum  Ogre::TexCoordCalcMethod {
  Ogre::TEXCALC_NONE, Ogre::TEXCALC_ENVIRONMENT_MAP, Ogre::TEXCALC_ENVIRONMENT_MAP_PLANAR, Ogre::TEXCALC_ENVIRONMENT_MAP_REFLECTION,
  Ogre::TEXCALC_ENVIRONMENT_MAP_NORMAL, Ogre::TEXCALC_PROJECTIVE_TEXTURE
}
 

Enum describing the ways to generate texture coordinates.

More...
enum  Ogre::StencilOperation {
  Ogre::SOP_KEEP, Ogre::SOP_ZERO, Ogre::SOP_REPLACE, Ogre::SOP_INCREMENT,
  Ogre::SOP_DECREMENT, Ogre::SOP_INCREMENT_WRAP, Ogre::SOP_DECREMENT_WRAP, Ogre::SOP_INVERT
}
 

Enum describing the various actions which can be taken onthe stencil buffer.

More...

Define Documentation

#define OGRE_RENDERABLE_DEFAULT_PRIORITY   100

Definition at line 79 of file OgreRenderQueue.h.


Typedef Documentation

typedef vector<HardwareBuffer::Usage>::type Ogre::BufferUsageList

Define a list of usage flags.

Definition at line 44 of file OgreVertexIndexData.h.

typedef VectorIterator<RenderQueueInvocationList> Ogre::RenderQueueInvocationIterator

Definition at line 161 of file OgreRenderQueueInvocation.h.

typedef vector<RenderQueueInvocation*>::type Ogre::RenderQueueInvocationList

List of RenderQueueInvocations.

Definition at line 160 of file OgreRenderQueueInvocation.h.

typedef map< String, RenderTarget * >::type Ogre::RenderTargetMap

Definition at line 58 of file OgreRenderSystem.h.

typedef multimap<uchar, RenderTarget * >::type Ogre::RenderTargetPriorityMap

Definition at line 59 of file OgreRenderSystem.h.

typedef SharedPtr<RenderToVertexBuffer> Ogre::RenderToVertexBufferSharedPtr

Definition at line 146 of file OgreRenderToVertexBuffer.h.


Enumeration Type Documentation

Enumeration of queue groups, by which the application may group queued renderables so that they are rendered together with events in between.

Remarks:
When passed into methods these are actually passed as a uint8 to allow you to use values in between if you want to.
Enumerator:
RENDER_QUEUE_BACKGROUND 

Use this queue for objects which must be rendered first e.g. backgrounds.

RENDER_QUEUE_SKIES_EARLY 

First queue (after backgrounds), used for skyboxes if rendered first.

RENDER_QUEUE_1 
RENDER_QUEUE_2 
RENDER_QUEUE_WORLD_GEOMETRY_1 
RENDER_QUEUE_3 
RENDER_QUEUE_4 
RENDER_QUEUE_MAIN 

The default render queue.

RENDER_QUEUE_6 
RENDER_QUEUE_7 
RENDER_QUEUE_WORLD_GEOMETRY_2 
RENDER_QUEUE_8 
RENDER_QUEUE_9 
RENDER_QUEUE_SKIES_LATE 

Penultimate queue(before overlays), used for skyboxes if rendered last.

RENDER_QUEUE_OVERLAY 

Use this queue for objects which must be rendered last e.g. overlays.

RENDER_QUEUE_MAX 

Final possible render queue, don't exceed this.

Definition at line 53 of file OgreRenderQueue.h.

Enum describing the various actions which can be taken onthe stencil buffer.

Enumerator:
SOP_KEEP 

Leave the stencil buffer unchanged.

SOP_ZERO 

Set the stencil value to zero.

SOP_REPLACE 

Set the stencil value to the reference value.

SOP_INCREMENT 

Increase the stencil value by 1, clamping at the maximum value.

SOP_DECREMENT 

Decrease the stencil value by 1, clamping at 0.

SOP_INCREMENT_WRAP 

Increase the stencil value by 1, wrapping back to 0 when incrementing the maximum value.

SOP_DECREMENT_WRAP 

Decrease the stencil value by 1, wrapping when decrementing 0.

SOP_INVERT 

Invert the bits of the stencil buffer.

Definition at line 77 of file OgreRenderSystem.h.

Enum describing the ways to generate texture coordinates.

Enumerator:
TEXCALC_NONE 

No calculated texture coordinates.

TEXCALC_ENVIRONMENT_MAP 

Environment map based on vertex normals.

TEXCALC_ENVIRONMENT_MAP_PLANAR 

Environment map based on vertex positions.

TEXCALC_ENVIRONMENT_MAP_REFLECTION 
TEXCALC_ENVIRONMENT_MAP_NORMAL 
TEXCALC_PROJECTIVE_TEXTURE 

Projective texture.

Definition at line 63 of file OgreRenderSystem.h.

Vertex element semantics, used to identify the meaning of vertex buffer contents.

Enumerator:
VES_POSITION 

Position, 3 reals per vertex.

VES_BLEND_WEIGHTS 

Blending weights.

VES_BLEND_INDICES 

Blending indices.

VES_NORMAL 

Normal, 3 reals per vertex.

VES_DIFFUSE 

Diffuse colours.

VES_SPECULAR 

Specular colours.

VES_TEXTURE_COORDINATES 

Texture coordinates.

VES_BINORMAL 

Binormal (Y axis if normal is Z).

VES_TANGENT 

Tangent (X axis if normal is Z).

Definition at line 84 of file OgreHardwareVertexBuffer.h.

Vertex element type, used to identify the base types of the vertex contents.

Enumerator:
VET_FLOAT1 
VET_FLOAT2 
VET_FLOAT3 
VET_FLOAT4 
VET_COLOUR 

alias to more specific colour type - use the current rendersystem's colour packing

VET_SHORT1 
VET_SHORT2 
VET_SHORT3 
VET_SHORT4 
VET_UBYTE4 
VET_COLOUR_ARGB 

D3D style compact colour.

VET_COLOUR_ABGR 

GL style compact colour.

Definition at line 107 of file OgreHardwareVertexBuffer.h.


Copyright © 2008 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 28 17:47:23 2010