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

A class that specifies parameters for how a renderable object should be rendered. More...

#include <omGraphicsRenderRequest.h>

Public Member Functions

 RenderRequest ()
 Create a new render request with the default rendering parameters. More...
 
 RenderRequest (const RenderableFlags &newFlags, const Vector2f &newViewportSize, const ViewVolume *newViewVolume=((void *) 0), const Camera *newCamera=((void *) 0))
 Create a new render request with the specified rendering parameters. More...
 

Public Attributes

RenderableFlags requiredFlags
 An object containing the required flags that a renderable must have set to be rendered. More...
 
Vector2f viewportSize
 The size of the viewport's area on the framebuffer in pixels. More...
 
const ViewVolumeviewVolume
 A pointer to a view volume that should be culled against. More...
 
const Cameracamera
 A pointer to a camera that is being rendered. More...
 
Real lightCutoff
 The cutoff in absolute light intensity below which a light should be considered not affecting an object. More...
 

Detailed Description

A class that specifies parameters for how a renderable object should be rendered.

Constructor & Destructor Documentation

om::graphics::shapes::RenderRequest::RenderRequest ( )
inline

Create a new render request with the default rendering parameters.

om::graphics::shapes::RenderRequest::RenderRequest ( const RenderableFlags newFlags,
const Vector2f newViewportSize,
const ViewVolume newViewVolume = ((void *)0),
const Camera newCamera = ((void *)0) 
)
inline

Create a new render request with the specified rendering parameters.

Member Data Documentation

RenderableFlags om::graphics::shapes::RenderRequest::requiredFlags

An object containing the required flags that a renderable must have set to be rendered.

Vector2f om::graphics::shapes::RenderRequest::viewportSize

The size of the viewport's area on the framebuffer in pixels.

This value is used for level-of-detail determination that is based on the apparent pixel size of an object.

const ViewVolume* om::graphics::shapes::RenderRequest::viewVolume

A pointer to a view volume that should be culled against.

If the pointer is NULL, no view volume culling is performed.

const Camera* om::graphics::shapes::RenderRequest::camera

A pointer to a camera that is being rendered.

This value is used for level-of-detail determination that is based on the apparent pixel size of an object for a camera's viewpoint.

Real om::graphics::shapes::RenderRequest::lightCutoff

The cutoff in absolute light intensity below which a light should be considered not affecting an object.


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