jop::RenderPass Class Reference

#include <RenderPass.hpp>

Inheritance diagram for jop::RenderPass:

Public Types
enum	Pass { Pass::BeforePost, Pass::AfterPost }

Public Member Functions
	RenderPass (Renderer &renderer, const RenderTarget &target, const Pass pass, const uint32 weight)
	Constructor. More...
virtual	~RenderPass ()=0
	Virtual destructor. More...
void	setActive (const bool active)
	Set this render pass active/inactive. More...
bool	isActive () const
	Check if this render pass is active. More...
Renderer &	getRenderer ()
	Get the renderer this pass is bound to. More...
Pass	getPass () const
	Get the render pass type. More...

Static Public Attributes
static const uint32	DefaultWeight
	The default render pass weight. More...

Protected Member Functions
virtual void	draw ()=0
	Virtual draw function. More...
virtual void	bind (const Drawable *drawable)=0
	Bind a drawable. More...
virtual void	unbind (const Drawable *drawable)=0
	Unbind a drawable. More...

Protected Attributes
Renderer &	m_rendererRef
	Reference to the renderer. More...
const RenderTarget &	m_target
	Reference to the render target. More...
const uint32	m_weight
	Weight value. More...
const Pass	m_pass
	Render pass type. More...
bool	m_active
	Is this render pass active? More...

Friends
class	Renderer
class	Drawable

Detailed Description

Definition at line 40 of file RenderPass.hpp.

Member Enumeration Documentation

enum jop::RenderPass::Pass

strong

Render pass type

Enumerator
BeforePost	Before post-processing.
AfterPost	After post-processing.

Definition at line 59 of file RenderPass.hpp.

Constructor & Destructor Documentation

jop::RenderPass::RenderPass	(	Renderer &	renderer,
		const RenderTarget &	target,
		const Pass	pass,
		const uint32	weight
	)

Constructor.

Parameters

renderer	Reference to the renderer
target	Reference to the render target
pass	The render pass type
weight	The weight of this render pass

virtual jop::RenderPass::~RenderPass ( )

pure virtual

Virtual destructor.

Member Function Documentation

virtual void jop::RenderPass::bind ( const Drawable *  drawable )

protectedpure virtual

Bind a drawable.

Parameters

drawable

The drawable to bind

Implemented in jop::OrderedRenderPass, and jop::SortedRenderPass.

virtual void jop::RenderPass::draw ( )

protectedpure virtual

Virtual draw function.

Implemented in jop::OrderedRenderPass, and jop::SortedRenderPass.

Pass jop::RenderPass::getPass

(

)

const

Get the render pass type.

Returns

The render pass type

Renderer& jop::RenderPass::getRenderer

(

)

Get the renderer this pass is bound to.

Returns

Reference to the renderer

bool jop::RenderPass::isActive

(

)

const

Check if this render pass is active.

Returns

True if active

void jop::RenderPass::setActive

(

const bool

active

)

Set this render pass active/inactive.

Parameters

active

True to set active

virtual void jop::RenderPass::unbind ( const Drawable *  drawable )

protectedpure virtual

Unbind a drawable.

Parameters

drawable

The drawable to unbind

Implemented in jop::OrderedRenderPass, and jop::SortedRenderPass.

Friends And Related Function Documentation

friend class Drawable

friend

Definition at line 47 of file RenderPass.hpp.

friend class Renderer

friend

Definition at line 46 of file RenderPass.hpp.

Member Data Documentation

const uint32 jop::RenderPass::DefaultWeight

static

The default render pass weight.

Defined as 0x88888888

Definition at line 55 of file RenderPass.hpp.

bool jop::RenderPass::m_active

protected

Is this render pass active?

Definition at line 128 of file RenderPass.hpp.

const Pass jop::RenderPass::m_pass

protected

Render pass type.

Definition at line 127 of file RenderPass.hpp.

Renderer& jop::RenderPass::m_rendererRef

protected

Reference to the renderer.

Definition at line 124 of file RenderPass.hpp.

const RenderTarget& jop::RenderPass::m_target

protected

Reference to the render target.

Definition at line 125 of file RenderPass.hpp.

const uint32 jop::RenderPass::m_weight

protected

Weight value.

Definition at line 126 of file RenderPass.hpp.

---

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

• RenderPass.hpp