OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
OmegaEngine.Graphics.Shaders.GeneralShader Class Reference

A general-purpose surface shader with optional support for normal and specular maps More...

Inheritance diagram for OmegaEngine.Graphics.Shaders.GeneralShader:
OmegaEngine.Graphics.Shaders.LightingShader OmegaEngine.Graphics.Shaders.SurfaceShader OmegaEngine.Graphics.Shaders.Shader OmegaEngine.EngineElement

Public Member Functions

override void Apply (Action render, XMaterial material, Camera camera, params LightSource[] lights)
 Applies the shader to the content in the render delegate
Parameters
renderThe render delegate (is called once for every shader pass)
materialThe material to be used by this shader; null for device texture
cameraThe camera for transformation information
lightsAn array of all lights this shader should consider

 
- 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(1, 1)
 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. More...
 
- Protected Member Functions inherited from OmegaEngine.Graphics.Shaders.LightingShader
override void RunPasses (Action render, XMaterial material, params LightSource[] lights)
 Runs the actual shader passes
Parameters
renderThe render delegate (is called once for every shader pass)
materialThe material to be used by this shader; null for device texture
lightsAn array of all lights this shader should consider; null for no lighting

 
- 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...
 
- 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...
 

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< SasScriptCommandGlobalScript
 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...
 
- 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, set]
 Indicates whether this object has been disposed and can therefore no longer be used. More...
 

Detailed Description

A general-purpose surface shader with optional support for normal and specular maps

See Also
Engine.DefaultShader

Member Function Documentation

override void OmegaEngine.Graphics.Shaders.GeneralShader.OnEngineSet ( )
inlineprotectedvirtual

Hook that is calld when Engine is set for the first time.

Reimplemented from OmegaEngine.EngineElement.

Member Data Documentation

Version OmegaEngine.Graphics.Shaders.GeneralShader.MinShaderModel => new Version(1, 1)
static

The minimum shader model version required to use this shader


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