om::graphics::base::RenderMode Class Reference

A class that specifies the configuration of the fixed-function rendering pipeline. More...

#include <omGraphicsRenderMode.h>

Public Member Functions
	RenderMode ()
	Create a new render mode with the default rendering parameters. More...
RenderFlags &	getFlags ()
	Return a reference to an object that contains boolean parameters of the render mode. More...
const RenderFlags &	getFlags () const
	Return an object that contains boolean parameters of the render mode. More...
void	setFlags (const RenderFlags &newFlags)
	Set an object that contains boolean parameters of the render mode. More...
Bool	flagIsSet (RenderFlags::Flag flag) const
	Return whether or not the specified boolan render flag is set for this render mode. More...
void	setFlag (RenderFlags::Flag flag, Bool newIsSet=true)
	Set whether or not the specified boolan render flag is set for this render mode. More...
RasterMode &	getRasterMode ()
	Return a reference to an object representing the raster mode for this render mode. More...
const RasterMode &	getRasterMode () const
	Return a reference to an object representing the raster mode for this render mode. More...
void	setRasterMode (const RasterMode &newRasterMode)
	Set an object representing the raster mode for this render mode. More...
BlendMode &	getBlendMode ()
	Return a reference to an object representing the blend mode for this render mode. More...
const BlendMode &	getBlendMode () const
	Return a reference to an object representing the blend mode for this render mode. More...
void	setBlendMode (const BlendMode &newBlendMode)
	Set an object representing the blend mode for this render mode. More...
DepthMode &	getDepthMode ()
	Return a reference to an object representing the depth mode for this render mode. More...
const DepthMode &	getDepthMode () const
	Return a reference to an object representing the depth mode for this render mode. More...
void	setDepthMode (const DepthMode &newDepthMode)
	Set an object representing the depth mode for this render mode. More...
StencilMode &	getStencilMode ()
	Return a reference to an object representing the stencil mode for this render mode. More...
const StencilMode &	getStencilMode () const
	Return a reference to an object representing the stencil mode for this render mode. More...
void	setStencilMode (const StencilMode &newStencilMode)
	Set an object representing the stencil mode for this render mode. More...
Float	getLineWidth () const
	Return the width in pixels to use when rendering lines. More...
void	setLineWidth (Float newLineWidth)
	Set the width in pixels to use when rendering lines. More...
Float	getPointSize () const
	Return the size in pixels to use when rendering points. More...
void	setPointSize (Float newPointSize)
	Set the size in pixels to use when rendering points. More...
void	set (const RenderMode &other, const RenderModeMask &mask)
	Set the values in this render mode to the values from another render mode for only the masked attributes. More...
Bool	operator== (const RenderMode &other) const
	Return whether or not this render mode is equal to another render mode. More...
Bool	operator!= (const RenderMode &other) const
	Return whether or not this render mode is not equal to another render mode. More...

Detailed Description

A class that specifies the configuration of the fixed-function rendering pipeline.

Constructor & Destructor Documentation

om::graphics::base::RenderMode::RenderMode ( )

inline

Create a new render mode with the default rendering parameters.

By default, color writing, depth writing, and the depth test are enabled by the render flags.

Member Function Documentation

RenderFlags& om::graphics::base::RenderMode::getFlags ( )

inline

Return a reference to an object that contains boolean parameters of the render mode.

const RenderFlags& om::graphics::base::RenderMode::getFlags ( ) const

inline

Return an object that contains boolean parameters of the render mode.

void om::graphics::base::RenderMode::setFlags ( const RenderFlags &  newFlags )

inline

Set an object that contains boolean parameters of the render mode.

Bool om::graphics::base::RenderMode::flagIsSet ( RenderFlags::Flag  flag ) const

inline

Return whether or not the specified boolan render flag is set for this render mode.

void om::graphics::base::RenderMode::setFlag ( RenderFlags::Flag  flag, Bool  newIsSet = true  )

inline

Set whether or not the specified boolan render flag is set for this render mode.

RasterMode& om::graphics::base::RenderMode::getRasterMode ( )

inline

Return a reference to an object representing the raster mode for this render mode.

const RasterMode& om::graphics::base::RenderMode::getRasterMode ( ) const

inline

Return a reference to an object representing the raster mode for this render mode.

void om::graphics::base::RenderMode::setRasterMode ( const RasterMode &  newRasterMode )

inline

Set an object representing the raster mode for this render mode.

BlendMode& om::graphics::base::RenderMode::getBlendMode ( )

inline

Return a reference to an object representing the blend mode for this render mode.

const BlendMode& om::graphics::base::RenderMode::getBlendMode ( ) const

inline

Return a reference to an object representing the blend mode for this render mode.

void om::graphics::base::RenderMode::setBlendMode ( const BlendMode &  newBlendMode )

inline

Set an object representing the blend mode for this render mode.

DepthMode& om::graphics::base::RenderMode::getDepthMode ( )

inline

Return a reference to an object representing the depth mode for this render mode.

const DepthMode& om::graphics::base::RenderMode::getDepthMode ( ) const

inline

Return a reference to an object representing the depth mode for this render mode.

void om::graphics::base::RenderMode::setDepthMode ( const DepthMode &  newDepthMode )

inline

Set an object representing the depth mode for this render mode.

StencilMode& om::graphics::base::RenderMode::getStencilMode ( )

inline

Return a reference to an object representing the stencil mode for this render mode.

const StencilMode& om::graphics::base::RenderMode::getStencilMode ( ) const

inline

Return a reference to an object representing the stencil mode for this render mode.

void om::graphics::base::RenderMode::setStencilMode ( const StencilMode &  newStencilMode )

inline

Set an object representing the stencil mode for this render mode.

Float om::graphics::base::RenderMode::getLineWidth ( ) const

inline

Return the width in pixels to use when rendering lines.

void om::graphics::base::RenderMode::setLineWidth ( Float  newLineWidth )

inline

Set the width in pixels to use when rendering lines.

Float om::graphics::base::RenderMode::getPointSize ( ) const

inline

Return the size in pixels to use when rendering points.

void om::graphics::base::RenderMode::setPointSize ( Float  newPointSize )

inline

Set the size in pixels to use when rendering points.

void om::graphics::base::RenderMode::set ( const RenderMode &  other, const RenderModeMask &  mask  )

inline

Set the values in this render mode to the values from another render mode for only the masked attributes.

Bool om::graphics::base::RenderMode::operator== ( const RenderMode &  other ) const

inline

Return whether or not this render mode is equal to another render mode.

Bool om::graphics::base::RenderMode::operator!= ( const RenderMode &  other ) const

inline

Return whether or not this render mode is not equal to another render mode.

---

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

• omGraphicsRenderMode.h