An enum class that specifies the set of possible rendering passes. More...

#include <omGraphicsRenderPass.h>

Public Types
enum	Flag { UNDEFINED = 0, DEPTH_FILL = (1 << 0), SHADOW = (1 << 1), REFLECTION = (1 << 2), REFRACTION = (1 << 3), DEFERRED_G_BUFFER = (1 << 4), DEFERRED_LIGHTING = (1 << 5), FORWARD_OPAQUE = (1 << 6), FORWARD_TRANSPARENT = (1 << 7), RAY_TRACING = (1 << 8), VELOCITY = (1 << 9), POST_PROCESS = (1 << 10) }
	An enum type which represents the different possible rendering passes. More...

Public Member Functions
	RenderPass ()
	Create a new render pass object with no passes set. More...

	RenderPass (Flag newFlag)
	Create a new render pass with the specified render pass enum value. More...

	RenderPass (UInt32 newPasses)
	Create a new render pass object with the specified initial combined passes value. More...

	operator UInt32 () const
	Convert this render pass 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

An enum class that specifies the set of possible rendering passes.

Member Enumeration Documentation

An enum type which represents the different possible rendering passes.

Enumerator
UNDEFINED	An undefined rendering pass.
DEPTH_FILL	A rendering pass where depth-only rendering is performed to avoid overdraw during the main pass.
SHADOW	A rendering pass where depth-only rendering is performed for generation of shadow maps.
REFLECTION	A rendering pass where reflection maps are generated.
REFRACTION	A rendering pass where refraction maps are generated.
DEFERRED_G_BUFFER	A render pass when the G-Buffer is filled during deferred rendering.
DEFERRED_LIGHTING	A render pass when lighting is computed using the contents of the G-Buffer.
FORWARD_OPAQUE	A forward rendering pass where opaque objects are drawn.
FORWARD_TRANSPARENT	A forward rendering pass where transparent objects are drawn with blending after the opaque objects.
RAY_TRACING	A rendering pass where ray tracing is used to draw objects.
VELOCITY	A rendering pass where per-pixel velocity vectors are generated for motion blur.
POST_PROCESS	A pass where post-processing is done on the final image.

om::graphics::base::RenderPass::RenderPass ( )

inline

Create a new render pass object with no passes set.

om::graphics::base::RenderPass::RenderPass ( Flag newFlag )

inline

Create a new render pass with the specified render pass enum value.

om::graphics::base::RenderPass::RenderPass ( UInt32 newPasses )

inline

Create a new render pass object with the specified initial combined passes value.

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

inline

Convert this render pass object to an integer value.

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

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

inline

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

void om::graphics::base::RenderPass::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: