om::graphics::renderers::SceneRenderRequest Class Reference

A class that specifies how a camera viewport in a scene should be drawn. More...

#include <omGraphicsSceneRenderRequest.h>

Public Member Functions
	SceneRenderRequest ()
	Create a default scene render request that has no scene or camera. More...
	SceneRenderRequest (const GraphicsScene *newScene, const Camera *newCamera, const Viewport &newViewport=Viewport())
	Create a scene render request for the given scene, camera, and viewport. More...

Public Attributes
const GraphicsScene *	scene
	A pointer to the scene which should be drawn. More...
const Camera *	camera
	A pointer to the camera whose view is to be drawn in the scene. More...
Viewport	viewport
	The viewport on the screen where the scene view should be drawn. More...
SceneRenderFlags	flags
	An object containing boolean configuration flags for a scene renderer. More...
Size	maxNumLights
	The maximum number of lights that can be used to illuminate an object. More...
Size	maxNumShadows
	The maximum number of light shadows that can be rendered for a scene. More...
Double	clearDepth
	The depth value that the depth framebuffer is cleared to before the scene viewport is drawn. More...
Color4d	clearColor
	The color value that the color framebuffer is cleared to before the scene viewport is drawn. More...
Color4f	lightDebugColor
	The color to use when drawing debug info for lights. More...
Color4f	cameraDebugColor
	The color to use when drawing debug info for cameras. More...
Color4f	objectDebugColor
	The color to use when drawing debug info for objects. More...
Color4f	shapeDebugColor
	The color to use when drawing debug info for shapes. More...
Color4f	boundingBoxDebugColor
	The color to use when drawing debug bounding boxes. More...

Detailed Description

A class that specifies how a camera viewport in a scene should be drawn.

A scene viewport consists of a scene, a camera that should view the scene, and a viewport that the camera should be drawn to on the screen. Additional attributes control how the viewport is rendered.

Constructor & Destructor Documentation

om::graphics::renderers::SceneRenderRequest::SceneRenderRequest

(

)

Create a default scene render request that has no scene or camera.

om::graphics::renderers::SceneRenderRequest::SceneRenderRequest	(	const GraphicsScene *	newScene,
		const Camera *	newCamera,
		const Viewport &	newViewport = Viewport()
	)

Create a scene render request for the given scene, camera, and viewport.

Member Data Documentation

const GraphicsScene* om::graphics::renderers::SceneRenderRequest::scene

A pointer to the scene which should be drawn.

const Camera* om::graphics::renderers::SceneRenderRequest::camera

A pointer to the camera whose view is to be drawn in the scene.

Viewport om::graphics::renderers::SceneRenderRequest::viewport

The viewport on the screen where the scene view should be drawn.

SceneRenderFlags om::graphics::renderers::SceneRenderRequest::flags

An object containing boolean configuration flags for a scene renderer.

Size om::graphics::renderers::SceneRenderRequest::maxNumLights

The maximum number of lights that can be used to illuminate an object.

Size om::graphics::renderers::SceneRenderRequest::maxNumShadows

The maximum number of light shadows that can be rendered for a scene.

Double om::graphics::renderers::SceneRenderRequest::clearDepth

The depth value that the depth framebuffer is cleared to before the scene viewport is drawn.

Color4d om::graphics::renderers::SceneRenderRequest::clearColor

The color value that the color framebuffer is cleared to before the scene viewport is drawn.

Color4f om::graphics::renderers::SceneRenderRequest::lightDebugColor

The color to use when drawing debug info for lights.

Color4f om::graphics::renderers::SceneRenderRequest::cameraDebugColor

The color to use when drawing debug info for cameras.

Color4f om::graphics::renderers::SceneRenderRequest::objectDebugColor

The color to use when drawing debug info for objects.

Color4f om::graphics::renderers::SceneRenderRequest::shapeDebugColor

The color to use when drawing debug info for shapes.

Color4f om::graphics::renderers::SceneRenderRequest::boundingBoxDebugColor

The color to use when drawing debug bounding boxes.

---

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

• omGraphicsSceneRenderRequest.h