Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
om::graphics::renderers::Renderer Class Reference

A class that serves as a basic interface for a high-level graphcs renderer. More...

#include <omGraphicsRenderer.h>

Inheritance diagram for om::graphics::renderers::Renderer:
om::graphics::renderers::ImmediateRenderer om::graphics::renderers::SceneRenderer om::graphics::renderers::ForwardRenderer om::graphics::renderers::RayRenderer

Public Member Functions

virtual ~Renderer ()
 Destroy a renderer object. More...
 
virtual void render ()
 Do the main rendering for this renderer. More...
 
GraphicsContextgetContext () const
 Return a pointer to the graphics context that the renderer is using. More...
 
virtual void setContext (GraphicsContext *newContext)
 Set a pointer to the graphics context that this renderer should use. More...
 
void clearContext ()
 Clear the previous context from this object. More...
 

Protected Member Functions

 Renderer ()
 Create a new graphics renderer that doesn't have an associated graphics context. More...
 
 Renderer (GraphicsContext *newContext)
 Create a new graphics renderer that uses the specified context for rendering. More...
 

Protected Attributes

GraphicsContextcontext
 A pointer to the graphics context this object is using. More...
 

Detailed Description

A class that serves as a basic interface for a high-level graphcs renderer.

Constructor & Destructor Documentation

virtual om::graphics::renderers::Renderer::~Renderer ( )
virtual

Destroy a renderer object.

om::graphics::renderers::Renderer::Renderer ( )
inlineprotected

Create a new graphics renderer that doesn't have an associated graphics context.

om::graphics::renderers::Renderer::Renderer ( GraphicsContext newContext)
inlineprotected

Create a new graphics renderer that uses the specified context for rendering.

Member Function Documentation

virtual void om::graphics::renderers::Renderer::render ( )
virtual

Do the main rendering for this renderer.

The default implementation has no effect. Subclasses can override this method to do their main rendering operations. The actual function of this method is defined by the subclass.

Reimplemented in om::graphics::renderers::ImmediateRenderer.

GraphicsContext* om::graphics::renderers::Renderer::getContext ( ) const
inline

Return a pointer to the graphics context that the renderer is using.

virtual void om::graphics::renderers::Renderer::setContext ( GraphicsContext newContext)
virtual

Set a pointer to the graphics context that this renderer should use.

If the new context is NULL, the renderer clears the context data.

The renderer subclass should override this method to perform any initialization and configuration for the new context.

Reimplemented in om::graphics::renderers::ImmediateRenderer, and om::graphics::renderers::ForwardRenderer.

void om::graphics::renderers::Renderer::clearContext ( )
inline

Clear the previous context from this object.

Member Data Documentation

GraphicsContext* om::graphics::renderers::Renderer::context
protected

A pointer to the graphics context this object is using.


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