om::graphics::renderers::SceneRenderFlags Class Reference

A class that encapsulates the different boolean flags that a scene renderer can have. More...

#include <omGraphicsSceneRenderFlags.h>

Public Types
enum	Flag {   UNDEFINED = 0, CLEAR_COLOR = (1 << 0), CLEAR_DEPTH = (1 << 1), OBJECTS_ENABLED = (1 << 2),   LIGHTS_ENABLED = (1 << 3), SHADOWS = (1 << 4), DEBUG_ENABLED = (1 << 5), DEBUG_LIGHTS = (1 << 6),   DEBUG_CAMERAS = (1 << 7), DEBUG_OBJECTS = (1 << 8), DEBUG_SHAPES = (1 << 9), DEBUG_BOUNDING_BOXES = (1 << 10),   DEFAULT = CLEAR_COLOR | CLEAR_DEPTH | OBJECTS_ENABLED | LIGHTS_ENABLED | SHADOWS }
	An enum that specifies the different scene renderer flags. More...

Public Member Functions
	SceneRenderFlags ()
	Create a new scene renderer flags object with no flags set. More...
	SceneRenderFlags (Flag flag)
	Create a new scene renderer flags object with the specified flag value initially set. More...
	SceneRenderFlags (UInt32 newFlags)
	Create a new scene renderer flags object with the specified initial combined flags value. More...
	operator UInt32 () const
	Convert this scene renderer flags object to an integer value. More...
Bool	isSet (Flag flag) const
	Return whether or not the specified flag value is set for this flags object. More...
void	set (Flag flag, Bool newIsSet)
	Set whether or not the specified flag value is set for this flags object. More...

Detailed Description

A class that encapsulates the different boolean flags that a scene renderer can have.

These flags provide boolean information about a certain scene renderer. Flags are indicated by setting a single bit of a 32-bit unsigned integer to 1.

Enum values for the different flags are defined as members of the class. Typically, the user would bitwise-OR the flag enum values together to produce a final set of set flags.

Member Enumeration Documentation

enum om::graphics::renderers::SceneRenderFlags::Flag

An enum that specifies the different scene renderer flags.

Enumerator
UNDEFINED	The flag value when all flags are not set.
CLEAR_COLOR	A flag indicating whether or not the color buffer should be cleared before drawing.
CLEAR_DEPTH	A flag indicating whether or not the depth buffer should be cleared before drawing.
OBJECTS_ENABLED	A flag indicating whether or not objects should be drawn.
LIGHTS_ENABLED	A flag indicating whether or not lighting is enabled.
SHADOWS	A flag indicating whether or not shadowing is enabled.
DEBUG_ENABLED	A flag indicating that debug drawing is enabled.
DEBUG_LIGHTS	A flag indicating whether or not debug info should be drawn for lights.
DEBUG_CAMERAS	A flag indicating whether or not debug info should be drawn for cameras.
DEBUG_OBJECTS	A flag indicating whether or not debug info should be drawn for objects.
DEBUG_SHAPES	A flag indicating whether or not debug info should be drawn for shapes.
DEBUG_BOUNDING_BOXES	A flag indicating whether or not bounding boxes should be drawn.
DEFAULT	The default scene renderer flags.

Constructor & Destructor Documentation

om::graphics::renderers::SceneRenderFlags::SceneRenderFlags ( )

inline

Create a new scene renderer flags object with no flags set.

om::graphics::renderers::SceneRenderFlags::SceneRenderFlags ( Flag  flag )

inline

Create a new scene renderer flags object with the specified flag value initially set.

om::graphics::renderers::SceneRenderFlags::SceneRenderFlags ( UInt32  newFlags )

inline

Create a new scene renderer flags object with the specified initial combined flags value.

Member Function Documentation

om::graphics::renderers::SceneRenderFlags::operator UInt32 ( ) const

inline

Convert this scene renderer flags object to an integer value.

This operator is provided so that the SceneRendererFlags object can be used as an integer value for bitwise logical operations.

Bool om::graphics::renderers::SceneRenderFlags::isSet ( Flag  flag ) const

inline

Return whether or not the specified flag value is set for this flags object.

void om::graphics::renderers::SceneRenderFlags::set ( Flag  flag, Bool  newIsSet  )

inline

Set whether or not the specified flag value is set for this flags object.

---

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

• omGraphicsSceneRenderFlags.h