Renders a particle system by manipulating positions of a batch of vertexes. More...

Inheritance diagram for OmegaEngine.Graphics.Shaders.ParticleShader:

Public Member Functions
	ParticleShader (ITextureProvider particleTexture)
	Creates a new instance of the water shader with refraction and reflection More...

override void	Apply (Action render, XMaterial material, Camera camera, params LightSource[] lights)
	Applies the shader to the content in the render delegate. More...

Public Member Functions inherited from OmegaEngine.Graphics.Shaders.Shader
void	LoadShaderFile (string path)
	Loads an Effect from an More...

void	Inject (string path)
	Replaces the loaded shader with a new one loaded from a file at run time. More...

override string	ToString ()

void	OnLostDevice ()
	Called when the device has been lost. More...

void	OnResetDevice ()
	Called when the device has been reset. More...

Public Member Functions inherited from OmegaEngine.EngineElement
void	Dispose ()

Static Public Attributes
static Version	MinShaderModel => new Version(2, 0)
	The minimum shader model version required to use this shader More...

Protected Member Functions
override void	OnEngineSet ()
	Hook that is calld when Engine is set for the first time.

override void	OnDispose ()
	Hook that is called when the object needs to dispose its internal resources.

Protected Member Functions inherited from OmegaEngine.Graphics.Shaders.SurfaceShader
void	SetupLight (PointLight light, int index, XMaterial material)
	Transfer lighting data from a PointLight to the shader More...

void	SetupLight (DirectionalLight light, int index, XMaterial material)
	Transfer lighting data from a DirectionalLight to the shader More...

virtual void	RunPasses (Action render, XMaterial material, params LightSource[] lights)
	Runs the actual shader passes More...

Protected Member Functions inherited from OmegaEngine.Graphics.Shaders.Shader
void	ExecuteScript (IEnumerable< SasScriptCommand > script, Action render, Size sceneSize, RenderTarget sceneMap, bool passScipt)
	Executes a SAS script block More...

void	ExecuteScript (IEnumerable< SasScriptCommand > script, Action render=null, Size sceneSize=new Size(), RenderTarget sceneMap=null)
	Executes a SAS post-screen shader technique script block More...

void	SetShaderParameter< T > (string name, T value)
	Sets a specific shader parameter. Automatically defers the action if Effect has not been set yet. More...

void	SetShaderParameter (string name, Color value)
	Sets a specific shader parameter. Automatically defers the action if Effect has not been set yet. More...

override void	OnEngineSet ()
	Hook that is calld when Engine is set for the first time.

override void	OnDispose ()
	Hook that is called when the object needs to dispose its internal resources.

Protected Member Functions inherited from OmegaEngine.EngineElement
void	RegisterChild (EngineElement element, bool autoDispose=true)
	Registers a child EngineElement for automatic Engine setting and Dispose calling. More...

void	UnregisterChild (EngineElement element)
	Unregisters a child EngineElement (opposite of RegisterChild). More...

Properties
float	SpawnRadius `[get, set]`
	The largest distance from the emitter at which particle shall be spawned More...

float	SystemHeight `[get, set]`
	The largest distance from the emitter particles can travel before dying More...

float	ParticleSpeed `[get, set]`
	The speed with which the particles move More...

float	ParticleSpread `[get, set]`
	How to spread the particles More...

float	ParticleSize `[get, set]`
	The size of the particles More...

float	ParticleShape `[get, set]`
	The shape of the particles More...

Properties inherited from OmegaEngine.Graphics.Shaders.Shader
Effect	Effect `[get, set]`
	The Direct3D effect for this shader More...

Properties inherited from OmegaEngine.EngineElement
Engine	Engine `[get, set]`
	The Engine instance used by this object. Must be set before using the object. May not be changed once it has been set! More...

bool	IsDisposed `[get]`
	Indicates whether this object has been disposed and can therefore no longer be used. More...

Additional Inherited Members
Public Attributes inherited from OmegaEngine.EngineElement
bool	IsEngineSet => _engine != null
	`true` if the Engine has been set. More...

Protected Attributes inherited from OmegaEngine.Graphics.Shaders.Shader
ScriptEffectType	ScriptType
	The type of shader the SAS scripts were written for More...

IList< SasScriptCommand >	GlobalScript
	A list of commands composing the global SAS script More...

readonly Dictionary< EffectHandle, IList< SasScriptCommand > >	Techniques = new Dictionary<EffectHandle, IList<SasScriptCommand>>()
	A list of techniques and their SAS scripts More...

readonly Dictionary< EffectHandle, IList< SasScriptCommand > >	Passes = new Dictionary<EffectHandle, IList<SasScriptCommand>>()
	A list of passes and their SAS scripts More...

ParameterInfo []	ParameterInfos
	A list of annotated shader parameters More...

Detailed Description

Renders a particle system by manipulating positions of a batch of vertexes.

See also: GpuParticleSystem

Constructor & Destructor Documentation

◆ ParticleShader()

OmegaEngine.Graphics.Shaders.ParticleShader.ParticleShader ( ITextureProvider particleTexture )

inline

Creates a new instance of the water shader with refraction and reflection

Parameters

particleTexture The normal texture to apply to the water surface for ripples

Member Function Documentation

◆ Apply()

override void OmegaEngine.Graphics.Shaders.ParticleShader.Apply	(	Action	render,
		XMaterial	material,
		Camera	camera,
		params LightSource []	lights
	)

inlinevirtual

Applies the shader to the content in the render delegate.

Parameters

render	The render delegate (is called once for every shader pass).
material	The material to be used by this shader; `null` for device texture.
camera	The camera for transformation information.
lights	An array of all lights this shader should consider; should be `null`.

Reimplemented from OmegaEngine.Graphics.Shaders.SurfaceShader.

Member Data Documentation

◆ MinShaderModel

Version OmegaEngine.Graphics.Shaders.ParticleShader.MinShaderModel => new Version(2, 0)

static

The minimum shader model version required to use this shader

Property Documentation

◆ ParticleShape

float OmegaEngine.Graphics.Shaders.ParticleShader.ParticleShape

getset

The shape of the particles

◆ ParticleSize

float OmegaEngine.Graphics.Shaders.ParticleShader.ParticleSize

getset

The size of the particles

◆ ParticleSpeed

float OmegaEngine.Graphics.Shaders.ParticleShader.ParticleSpeed

getset

The speed with which the particles move

◆ ParticleSpread

float OmegaEngine.Graphics.Shaders.ParticleShader.ParticleSpread

getset

How to spread the particles

◆ SpawnRadius

float OmegaEngine.Graphics.Shaders.ParticleShader.SpawnRadius

getset

The largest distance from the emitter at which particle shall be spawned

◆ SystemHeight

float OmegaEngine.Graphics.Shaders.ParticleShader.SystemHeight

getset

The largest distance from the emitter particles can travel before dying

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

OmegaEngine/Graphics/Shaders/ParticleShader.cs

Public Member Functions

Static Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParticleShader()

Member Function Documentation

◆ Apply()

Member Data Documentation

◆ MinShaderModel

Property Documentation

◆ ParticleShape

◆ ParticleSize

◆ ParticleSpeed

◆ ParticleSpread

◆ SpawnRadius

◆ SystemHeight