vl::OcclusionCullRenderer Class Reference

Wraps a Renderer performing occlusion culling acceleration. More...

#include <OcclusionCullRenderer.hpp>

Inheritance diagram for vl::OcclusionCullRenderer:

List of all members.

Public Member Functions
	OcclusionCullRenderer ()
	Constructor.
virtual const RenderQueue *	render (const RenderQueue *in_render_queue, Camera *camera, Real frame_clock)
	Renders using the wrapped renderer but also performing occlusion culling.
void	setWrappedRenderer (Renderer *renderer)
	The renderer to be wrapped by this occlusion culling renderer.
const Renderer *	wrappedRenderer () const
	The renderer to be wrapped by this occlusion culling renderer.
Renderer *	wrappedRenderer ()
	The renderer to we wrapped by this occlusion culling renderer.
void	setOcclusionThreshold (int threshold)
	The number of pixels visible for an actor to be considered occluded (default = 0)
int	occlusionThreshold () const
	The number of pixels visible for an actor to be considered occluded (default = 0)
const RenderTarget *	renderTarget () const
	Returns the wrapped Renderer's RenderTarget.
RenderTarget *	renderTarget ()
	Returns the wrapped Renderer's RenderTarget.
int	statsTotalObjects () const
	Returns the total number or objects candidate for rendering before occlusion culling.
int	statsOccludedObjects () const
	Returns the number or objects not rendered due to the occlusion culling.
Shader *	occlusionShader ()
	The Shader used to render the bounding boxes during the occlusion culling query.
const Shader *	occlusionShader () const
	The Shader used to render the bounding boxes during the occlusion culling query.
void	setOcclusionShader (Shader *occ_sh)
	The Shader used to render the bounding boxes during the occlusion culling query.
Protected Member Functions
void	render_pass1 (const RenderQueue *in_render_queue)
	Retrieves the occlusion culling query results from the previous rendering frame.
void	render_pass2 (const RenderQueue *in_render_queue, Camera *camera)
	Performs a new set of occlusion culling queries to be tested the next frame.
Protected Attributes
vl::ref< Renderer >	mWrappedRenderer
ref< Shader >	mOcclusionShader
ref< RenderQueue >	mCulledRenderQueue
int	mOcclusionThreshold
Renderer *	mPrevWrapRenderer
int	mStatsTotalObjects
int	mStatsOccludedObjects

---

Detailed Description

Wraps a Renderer performing occlusion culling acceleration.

For more information see OpenGL-Accelerated Occlusion Culling Tutorial

---

Constructor & Destructor Documentation

OcclusionCullRenderer::OcclusionCullRenderer

(

)

Constructor.

---

Member Function Documentation

const RenderQueue * OcclusionCullRenderer::render	(	const RenderQueue *	in_render_queue,
		Camera *	camera,
		Real	frame_clock
	)		[virtual]

Renders using the wrapped renderer but also performing occlusion culling.

Reimplemented from vl::Renderer.

void OcclusionCullRenderer::setWrappedRenderer

(

Renderer *

renderer )

The renderer to be wrapped by this occlusion culling renderer.

const Renderer* vl::OcclusionCullRenderer::wrappedRenderer

(

)

const [inline]

The renderer to be wrapped by this occlusion culling renderer.

Renderer* vl::OcclusionCullRenderer::wrappedRenderer

(

)

[inline]

The renderer to we wrapped by this occlusion culling renderer.

void vl::OcclusionCullRenderer::setOcclusionThreshold

(

int

threshold )

[inline]

The number of pixels visible for an actor to be considered occluded (default = 0)

int vl::OcclusionCullRenderer::occlusionThreshold

(

)

const [inline]

The number of pixels visible for an actor to be considered occluded (default = 0)

const RenderTarget * OcclusionCullRenderer::renderTarget

(

)

const [virtual]

Returns the wrapped Renderer's RenderTarget.

Reimplemented from vl::Renderer.

RenderTarget * OcclusionCullRenderer::renderTarget

(

)

[virtual]

Returns the wrapped Renderer's RenderTarget.

Reimplemented from vl::Renderer.

int vl::OcclusionCullRenderer::statsTotalObjects

(

)

const [inline]

Returns the total number or objects candidate for rendering before occlusion culling.

int vl::OcclusionCullRenderer::statsOccludedObjects

(

)

const [inline]

Returns the number or objects not rendered due to the occlusion culling.

Shader* vl::OcclusionCullRenderer::occlusionShader

(

)

[inline]

The Shader used to render the bounding boxes during the occlusion culling query.

For example if you have problems with the zbuffer percision you can access the Shader to modify the polygon offset settings.

const Shader* vl::OcclusionCullRenderer::occlusionShader

(

)

const [inline]

The Shader used to render the bounding boxes during the occlusion culling query.

For example if you have problems with the zbuffer percision you can access the Shader to modify the polygon offset settings.

void vl::OcclusionCullRenderer::setOcclusionShader

(

Shader *

occ_sh )

[inline]

The Shader used to render the bounding boxes during the occlusion culling query.

For example if you have problems with the zbuffer percision you can access the Shader to modify the polygon offset settings.

void OcclusionCullRenderer::render_pass1

(

const RenderQueue *

in_render_queue )

[protected]

Retrieves the occlusion culling query results from the previous rendering frame.

void OcclusionCullRenderer::render_pass2	(	const RenderQueue *	in_render_queue,
		Camera *	camera
	)		[protected]

Performs a new set of occlusion culling queries to be tested the next frame.

---

Member Data Documentation

vl::ref<Renderer> vl::OcclusionCullRenderer::mWrappedRenderer [protected]

ref<Shader> vl::OcclusionCullRenderer::mOcclusionShader [protected]

ref<RenderQueue> vl::OcclusionCullRenderer::mCulledRenderQueue [protected]

int vl::OcclusionCullRenderer::mOcclusionThreshold [protected]

Renderer* vl::OcclusionCullRenderer::mPrevWrapRenderer [protected]

int vl::OcclusionCullRenderer::mStatsTotalObjects [protected]

int vl::OcclusionCullRenderer::mStatsOccludedObjects [protected]

---

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

• C:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vl/OcclusionCullRenderer.hpp
• C:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vl/OcclusionCullRenderer.cpp