nvidia::apex::RenderDebugInterface Class Reference

wrapper for DebugRenderable More...

#include <RenderDebugInterface.h>

Inheritance diagram for nvidia::apex::RenderDebugInterface:

List of all members.

Public Member Functions
virtual void	setUseDebugRenderable (bool state)=0
	Method to support rendering to a legacy PhysX SDK DebugRenderable object instead of to the APEX Render Resources API (i.e.: Renderable).
virtual void	getRenderBuffer (PhysXRenderBuffer &renderable)=0
	Method to support rendering to a legacy PhysX SDK PxRenderBuffer object instead of to the APEX Render Resources API (i.e.: Renderable).
virtual void	getRenderBufferScreenSpace (PhysXRenderBuffer &renderable)=0
	Method to support rendering to a legacy PhysX SDK PxRenderBuffer object instead of to the APEX Render Resources API (i.e.: Renderable). Lines and triangle in screen space.
virtual void	addDebugRenderable (const physx::PxRenderBuffer &renderBuffer)=0
	Method to support rendering from an existing PhysX SDK PxRenderBuffer object.
virtual void	release ()=0
	Release an object instance.
virtual RENDER_DEBUG::RenderDebugTyped *	getRenderDebugInterface ()=0
	Returns render debug interface RENDER_DEBUG::RenderDebugTyped.

---

Detailed Description

wrapper for DebugRenderable

---

Member Function Documentation

virtual void nvidia::apex::RenderDebugInterface::addDebugRenderable

(

const physx::PxRenderBuffer &

renderBuffer

)

[pure virtual]

Method to support rendering from an existing PhysX SDK PxRenderBuffer object.

The contents of the PxRenderBuffer is added to the current contents of the RenderDebug object, and is output through the APEX Render Resources API.

virtual void nvidia::apex::RenderDebugInterface::getRenderBuffer

(

PhysXRenderBuffer &

renderable

)

[pure virtual]

Method to support rendering to a legacy PhysX SDK PxRenderBuffer object instead of to the APEX Render Resources API (i.e.: Renderable).

When enabled with a call to setUseDebugRenderable(true), this method will return a legacy PxRenderBuffer object that contains all of the output of the RenderDebug class.

virtual void nvidia::apex::RenderDebugInterface::getRenderBufferScreenSpace

(

PhysXRenderBuffer &

renderable

)

[pure virtual]

Method to support rendering to a legacy PhysX SDK PxRenderBuffer object instead of to the APEX Render Resources API (i.e.: Renderable). Lines and triangle in screen space.

When enabled with a call to setUseDebugRenderable(true), this method will return a legacy PxRenderBuffer object that contains all of the output of the RenderDebug class.

virtual void nvidia::apex::RenderDebugInterface::release

(

)

[pure virtual]

Release an object instance.

Calling this will unhook the class and delete it from memory. You should not keep any reference to this class instance after calling release

Implements nvidia::apex::ApexInterface.

virtual void nvidia::apex::RenderDebugInterface::setUseDebugRenderable

(

bool

state

)

[pure virtual]

Method to support rendering to a legacy PhysX SDK DebugRenderable object instead of to the APEX Render Resources API (i.e.: Renderable).

This method is used to enable or disable the use of a legacy DebugRenderable. When enabled, use the getDebugRenderable() method to get a legacy DebugRenerable object that will contain all the debug output.

---

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

• RenderDebugInterface.h