A class that specifies a boolean mask for different attributes of a RenderMode. More...

#include <omGraphicsRenderModeMask.h>

Public Types
enum	Flag { NONE = 0, FLAGS = (1 << 0), RASTER_MODE = (1 << 1), DEPTH_MODE = (1 << 2), BLEND_MODE = (1 << 3), STENCIL_MODE = (1 << 4), LINE_WIDTH = (1 << 5), POINT_SIZE = (1 << 6), ALL = (-1) }
	An enum that specifies the different flags for a render mode mask. More...

Public Member Functions
	RenderModeMask ()
	Create a new render mode mask object with no flags set. More...

	RenderModeMask (Flag flag)
	Create a new render mode mask object with the specified flag value initially set. More...

	RenderModeMask (UInt32 newFlags)
	Create a new render mode mask object with the specified initial combined flags value. More...

	operator UInt32 () const
	Convert this render mode mask 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=true)
	Set whether or not the specified flag value is set for this flags object. More...

Detailed Description

A class that specifies a boolean mask for different attributes of a RenderMode.

Using a mask, certain attributes can be updated for a render mode without modifying the other attributes.

Member Enumeration Documentation

An enum that specifies the different flags for a render mode mask.

Enumerator
NONE	The mask for when no flags are set.
FLAGS	A flag representing the RenderFlags attribute for a render mode.
RASTER_MODE	A flag representing the RasterMode attribute for a render mode.
DEPTH_MODE	A flag representing the DepthMode attribute for a render mode.
BLEND_MODE	A flag representing the BlendMode attribute for a render mode.
STENCIL_MODE	A flag representing the StencilMode attribute for a render mode.
LINE_WIDTH	A flag representing the line width attribute for a render mode.
POINT_SIZE	A flag representing the point size attribute for a render mode.
ALL	The mask that incorporates all render mode attributes.

om::graphics::base::RenderModeMask::RenderModeMask ( )

inline

Create a new render mode mask object with no flags set.

om::graphics::base::RenderModeMask::RenderModeMask ( Flag flag )

inline

Create a new render mode mask object with the specified flag value initially set.

om::graphics::base::RenderModeMask::RenderModeMask ( UInt32 newFlags )

inline

Create a new render mode mask object with the specified initial combined flags value.

om::graphics::base::RenderModeMask::operator UInt32 ( ) const

inline

Convert this render mode mask object to an integer value.

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

Bool om::graphics::base::RenderModeMask::isSet ( Flag flag ) const

inline

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

void om::graphics::base::RenderModeMask::set	(	Flag	flag,
		Bool	newIsSet = `true`
	)

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: