nvidia::apex::ModuleIofx Class Reference

IOFX Module. More...

#include <ModuleIofx.h>

List of all members.

Public Member Functions
virtual void	disableCudaInterop ()=0
	Disable use of OGL/D3D Interop. Must be called before emitters are created to have any effect.
virtual void	disableCudaModifiers ()=0
	Disable use of CUDA IOFX modifiers. Must be called before emitters are created to have any effect.
virtual void	disableDeferredRenderableAllocation ()=0
	Disables deferred allocation of IOFX actors.
virtual RenderVolume *	createRenderVolume (const Scene &apexScene, const PxBounds3 &b, uint32_t priority, bool allIofx)=0
	Create a new render volume.
virtual void	releaseRenderVolume (RenderVolume &volume)=0
	Release a render volume.
virtual const TestBase *	getTestBase (Scene *apexScene) const =0
	Get TestBase implementation of Iofx scene.
virtual bool	setIofxRenderCallback (const Scene &apexScene, IofxRenderCallback *)=0
	Set IofxRenderCallback.
virtual IofxRenderCallback *	getIofxRenderCallback (const Scene &apexScene) const =0
	Get IofxRenderCallback.
virtual IofxRenderableIterator *	createIofxRenderableIterator (const Scene &)=0
	Create an iterator for all renderables in IOFX module.
virtual void	prepareRenderables (const Scene &)=0
	Prepare renderables for rendering, should be called each frame before using renderables to update them with the most recent data.
Protected Member Functions
virtual	~ModuleIofx ()

---

Detailed Description

IOFX Module.

This module is used to convert physical parameters of particles into visual parameters that can be used to render particles. ApexRenderVolume provide the ability to partition world space into separate renderables.

---

Constructor & Destructor Documentation

virtual nvidia::apex::ModuleIofx::~ModuleIofx

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual IofxRenderableIterator* nvidia::apex::ModuleIofx::createIofxRenderableIterator

(

const Scene &

)

[pure virtual]

Create an iterator for all renderables in IOFX module.

virtual RenderVolume* nvidia::apex::ModuleIofx::createRenderVolume	(	const Scene &	apexScene,
		const PxBounds3 &	b,
		uint32_t	priority,
		bool	allIofx
	)		[pure virtual]

Create a new render volume.

Render volumes may be created at any time, unlike most other APEX asset and actor types. Their insertion into the scene is deferred if the simulation is active.

virtual void nvidia::apex::ModuleIofx::disableCudaInterop

(

)

[pure virtual]

Disable use of OGL/D3D Interop. Must be called before emitters are created to have any effect.

virtual void nvidia::apex::ModuleIofx::disableCudaModifiers

(

)

[pure virtual]

Disable use of CUDA IOFX modifiers. Must be called before emitters are created to have any effect.

virtual void nvidia::apex::ModuleIofx::disableDeferredRenderableAllocation

(

)

[pure virtual]

Disables deferred allocation of IOFX actors.

By default, IOFX actors and their render resources will not be created until it has objects to render.

virtual IofxRenderCallback* nvidia::apex::ModuleIofx::getIofxRenderCallback

(

const Scene &

apexScene

)

const [pure virtual]

Get IofxRenderCallback.

See also:

IofxRenderCallback

virtual const TestBase* nvidia::apex::ModuleIofx::getTestBase

(

Scene *

apexScene

)

const [pure virtual]

Get TestBase implementation of Iofx scene.

virtual void nvidia::apex::ModuleIofx::prepareRenderables

(

const Scene &

)

[pure virtual]

Prepare renderables for rendering, should be called each frame before using renderables to update them with the most recent data.

virtual void nvidia::apex::ModuleIofx::releaseRenderVolume

(

RenderVolume &

volume

)

[pure virtual]

Release a render volume.

Render volumes may be released at any time, unlike most other APEX asset and actor types. If the simulation is active, their resources are released at the end of the simulation step.

virtual bool nvidia::apex::ModuleIofx::setIofxRenderCallback	(	const Scene &	apexScene,
		IofxRenderCallback *
	)		[pure virtual]

Set IofxRenderCallback.

See also:

IofxRenderCallback

---

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

• ModuleIofx.h