Implements Ogre's Run-Time Shader system. More...

#include <rendering/rendering.hh>

Public Types
enum	LightingModel { SSLM_PerVertexLighting, SSLM_PerPixelLighting, SSLM_NormalMapLightingTangentSpace, SSLM_NormalMapLightingObjectSpace }

Public Member Functions
void	AddScene (ScenePtr _scene)
	Add a scene manager. More...

void	ApplyShadows (ScenePtr _scene)
	Apply shadows to a scene. More...

void	AttachEntity (Visual *vis) GAZEBO_DEPRECATED(7.0)
	Set an Ogre::Entity to use RT shaders. More...

void	Clear () GAZEBO_DEPRECATED(7.0)
	Clear the shader system. More...

void	DetachEntity (Visual *_vis) GAZEBO_DEPRECATED(7.0)
	Remove and entity. More...

void	Fini ()
	Finalize the shader system. More...

void	GenerateShaders (Visual *_vis) GAZEBO_DEPRECATED(7.0)
	Generate shaders for an entity. More...

void	GenerateShaders (const VisualPtr &_vis)
	Generate shaders for an entity. More...

Ogre::PSSMShadowCameraSetup *	GetPSSMShadowCameraSetup () const
	Get the Ogre PSSM Shadows camera setup. More...

void	Init ()
	Init the run time shader system. More...

void	RemoveScene (ScenePtr _scene)
	Remove a scene. More...

void	RemoveScene (const std::string &_scene)
	Remove a scene. More...

void	RemoveShadows (ScenePtr _scene)
	Remove shadows from a scene. More...

void	SetPerPixelLighting (bool _set)
	Set the lighting model to per pixel or per vertex. More...

void	Update ()
	Update the RT shaders. This should not be called frequently. More...

void	UpdateShaders ()
	Queue a call to update the shaders. More...

Static Public Member Functions
static void	AttachViewport (Ogre::Viewport *_viewport, ScenePtr _scene)
	Set a viewport to use shaders. More...

static void	DetachViewport (Ogre::Viewport *_viewport, ScenePtr _scene)
	Set a viewport to not use shaders. More...

static RTShaderSystem *	Instance ()
	Get an instance of the singleton. More...

Detailed Description

Implements Ogre's Run-Time Shader system.

This class allows Gazebo to generate per-pixel shaders for every material at run-time.

Member Function Documentation

void AddScene ( ScenePtr _scene )

Add a scene manager.

Parameters

[in] _scene The scene to process

void ApplyShadows ( ScenePtr _scene )

Apply shadows to a scene.

Parameters

[in] _scene The scene to receive shadows.

void AttachEntity ( Visual * vis )

Set an Ogre::Entity to use RT shaders.

Parameters

[in] _vis Visual that will use the RTShaderSystem.

Deprecated:: This function is no longer needed, and has no implementation.

static void AttachViewport	(	Ogre::Viewport *	_viewport,
		ScenePtr	_scene
	)

static

Set a viewport to use shaders.

Parameters

[in]	_viewport	The viewport to add.
[in]	_scene	The scene that the viewport uses.

void Clear ( )

Clear the shader system.

void DetachEntity ( Visual * _vis )

Remove and entity.

Parameters

[in] _vis Remove this visual.

Deprecated:: This function is no longer needed, and has no implementation.

static void DetachViewport	(	Ogre::Viewport *	_viewport,
		ScenePtr	_scene
	)

static

Set a viewport to not use shaders.

Parameters

[in]	_viewport	The viewport to remove.
[in]	_scene	The scene that the viewport uses.

void Fini ( )

Finalize the shader system.

void GenerateShaders ( Visual * _vis )

Generate shaders for an entity.

Parameters

[in] _vis The visual to generate shaders for.

See also: GenerateShaders(const VisualPtr &_vis)

void GenerateShaders ( const VisualPtr & _vis )

Generate shaders for an entity.

Parameters

[in] _vis The visual to generate shaders for.

Ogre::PSSMShadowCameraSetup* GetPSSMShadowCameraSetup ( ) const

Get the Ogre PSSM Shadows camera setup.

Returns: The Ogre PSSM Shadows camera setup.

void Init ( )

Init the run time shader system.

static RTShaderSystem * Instance ( )

inlinestaticinherited

Get an instance of the singleton.

void RemoveScene ( ScenePtr _scene )

Remove a scene.

Parameters

[in] The scene to remove

void RemoveScene ( const std::string & _scene )

Remove a scene.

Parameters

[in] Name of the scene to remove.

void RemoveShadows ( ScenePtr _scene )

Remove shadows from a scene.

Parameters

[in] _scene The scene to remove shadows from.

void SetPerPixelLighting ( bool _set )

Set the lighting model to per pixel or per vertex.

Parameters

[in] _set True means to use per-pixel shaders.

void Update ( )

Update the RT shaders. This should not be called frequently.

void UpdateShaders ( )

Queue a call to update the shaders.

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

RTShaderSystem.hh

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation