Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
Package SiliconStudio.Paradox.Effects

Namespaces

package  Data
 
package  Images
 
package  Modules
 

Classes

class  AOPlugin
 Posteffect manager. More...
 
class  AssemblyEffectKeysAttribute
 Assembly attribute used to mark assembly that has been preprocessed using the ParameterKeyProcessor. Assemblies without this attribute will have all of their type members tagged with EffectKeysAttribute scanned for ParameterKey. More...
 
class  BackgroundRenderer
 This renderer draws a full-screen image as background. The ratio or the texture used is preserved. The texture is centered and cropped along X or Y axis depending on the screen ratio. More...
 
class  CameraSetter
 A processor that updates camera view and projection along the setup of RenderTargetSetter More...
 
class  DeferredLightingShaderPlugin
 Shader used with LightingPrepassPlugin. More...
 
class  DelegateRenderer
 A processor that updates camera view and projection along the setup of RenderTargetSetter More...
 
class  DirectionalLight
 
class  DynamicEffectCompiler
 Provides a dynamic compiler for an effect based on parameters changed. More...
 
class  DynamicEffectInstance
 A dynamic effect instance updated by DynamicEffectCompiler. More...
 
class  EffectMeshDataPermutation
 
class  EffectParameterExtensions
 Various extension methods to quickly get and set values in EffectVariable. More...
 
class  EffectParameterUpdater
 
class  EffectParameterUpdaterDefinition
 Used to detect parameters change for dynamic effect.
 
class  EffectSystem
 The effect system. More...
 
class  EffectSystemExtensions
 Extensions for EffectSystem More...
 
class  GBufferPlugin
 Plugin used to render to a GBuffer from a MainPlugin. More...
 
class  GBufferShaderPlugin
 Shader effect used with GBufferPlugin More...
 
class  GraphicsResizeContext
 Keep track of actions to execute when GraphicsDevice is resized. More...
 
class  GraphicsResizeExtensions
 
class  HeatShimmerPlugin
 Light Shaft plugin. More...
 
interface  IModelInstance
 Instance of a model with its parameters. More...
 
class  InheritanceDefinition
 Inheritance only applies to specific keys (which can be remapped). More...
 
class  InheritanceIndexer
 Applies IndexedOf(index) on each key. More...
 
interface  IParameterCollectionInheritance
 Base for inheriting ParameterCollection (used by ParameterCollection.AddSources). This allows for directly using ParameterCollection or a more advanced class (such as InheritanceDefinition) when adding sources. More...
 
interface  IParameterCollectionInheritanceInternal
 Actual definition of IParameterCollectionInheritance (hidden in internal interface). This could be moved directly in IParameterCollectionInheritance if it becomes public.
 
class  Light
 
struct  LightBinding
 
struct  LightingConfiguration
 Lighting configuration for a mesh. Stores the number of lights per type and the number of shadow maps. More...
 
class  LightingConfigurationsSet
 
class  LightingKeys
 Keys used for lighting. More...
 
class  LightingPermutation
 
class  LightingPlugin
 
class  LightingPrepassPlugin
 Deffered lighting plugin. More...
 
class  LightingPrepassShaderPlugin
 
class  LightingShaderPlugin
 
class  LightPlugin
 
class  LightShaftsPlugin
 Light Shaft plugin. More...
 
class  MainPlugin
 Plugin used for the main rendering view. More...
 
class  Material
 
class  MaterialAssetKeys
 Defines keys associated with mesh used for compiling assets. More...
 
class  MaterialParameters
 
class  MaterialShaderPlugin
 
class  Mesh
 
class  MeshAnimationUpdater
 Applies animation from a AnimationClip to a ModelViewHierarchyUpdater. More...
 
struct  MeshBoneDefinition
 Describes a bone cluster inside a Mesh. More...
 
class  MeshDraw
 
class  MeshKeys
 Defines keys associated with mesh used for compiling assets. More...
 
class  MeshRenderExtensions
 
class  MeshSkinningDefinition
 Describes skinning for a Mesh, through a collection of MeshBoneDefinition. More...
 
class  MeshSkinningUpdater
 Performs blend matrix skinning. More...
 
class  MinMaxShaderPlugin
 Light Shaft plugin. More...
 
class  Model
 Collection of Mesh, each one usually being a different LOD of the same Model. The effect system will select the appropriate LOD depending on distance, current pass, and other effect-specific requirements. More...
 
struct  ModelNodeDefinition
 Describes a single transformation node, usually in a Model node hierarchy. More...
 
struct  ModelNodeTransformation
 
class  ModelRenderer
 This Renderer is responsible to prepare and render meshes for a specific pass. More...
 
class  ModelRendererExtensions
 Extensions filter for ModelRenderer More...
 
class  ModelRendererState
 State stored in a RenderPipeline by a ModelRenderer
 
class  ModelViewHierarchyDefinition
 Describes hiderarchical nodes in a flattened array. More...
 
class  ModelViewHierarchyUpdater
 Performs hierarchical updates for a given Model. More...
 
class  MultipleRenderTargetsSetter
 
class  NoisePlugin
 Plugin used to render to a GBuffer from a MainPlugin. More...
 
class  ParameterCollection
 A container to handle a hierarchical collection of effect variables. More...
 
class  ParameterCollectionExtensions
 Extensions for ParameterCollection. More...
 
class  ParameterDynamicBase
 Base class for ParameterDynamicValue. More...
 
class  ParameterDynamicValue
 Base class for ParameterDynamicValue{T}. More...
 
class  ParameterDynamicValue1< T, T1, TCast, TCast1 >
 Describes a dynamic value with 1 inputs.
 
class  ParameterDynamicValue2< T, T1, T2, TCast, TCast1, TCast2 >
 Describes a dynamic value with 2 inputs.
 
class  ParameterDynamicValue3< T, T1, T2, T3, TCast, TCast1, TCast2, TCast3 >
 Describes a dynamic value with 3 inputs.
 
class  ParameterDynamicValue4< T, T1, T2, T3, T4, TCast, TCast1, TCast2, TCast3, TCast4 >
 Describes a dynamic value with 4 inputs.
 
class  ParameterDynamicValue5< T, T1, T2, T3, T4, T5, TCast, TCast1, TCast2, TCast3, TCast4, TCast5 >
 Describes a dynamic value with 5 inputs.
 
class  ParameterDynamicValue6< T, T1, T2, T3, T4, T5, T6, TCast, TCast1, TCast2, TCast3, TCast4, TCast5, TCast6 >
 Describes a dynamic value with 6 inputs.
 
class  ParameterDynamicValue< T >
 Describes a dynamic value with no input. More...
 
class  ParameterKey
 Key of an effect parameter. More...
 
class  ParameterKey< T >
 Key of an gereric effect parameter. More...
 
class  ParameterKeyMetadata
 
class  ParameterKeyMetadata< T >
 Metadata used for ParameterKey More...
 
class  ParameterKeys
 
class  ParameterKeySerializer< T >
 
class  ParameterListener
 
class  ParameterPath
 
class  ParameterUpdater
 Merges and filters parameters coming from multiple ParameterCollection.
 
class  ParameterUpdaterDefinition
 Describes the expected parameters when using a ParameterUpdater.
 
class  ParticlePlugin
 
class  ParticleUtils
 
class  PickingPlugin
 
class  PickingShaderPlugin
 
class  PostEffectGraphPlugin
 Posteffect manager. More...
 
class  PostEffectMeshPlugin
 
class  PostEffectPlugin
 
class  PostEffectSeparateShaderPlugin
 TODO: Update summary. More...
 
class  PostEffectShaderPlugin
 
class  ProfilingKeys
 Various ProfilingKey used to measure performance across some part of the effect system. More...
 
class  RecursiveRenderer
 This Renderer recursively render another RenderPass. More...
 
class  RenderContext
 Thread-local storage context used during rendering. More...
 
class  Renderer
 Performs render pipeline transformations attached to a specific RenderPass. More...
 
class  RendererExtensions
 Extensions for Renderer More...
 
class  RenderingParameters
 
class  RenderMesh
 An effect mesh. More...
 
class  RenderModel
 Instantiation of a Model through a RenderPipeline. More...
 
class  RenderPass
 RenderPass is a hierarchy that defines how to collect and render meshes. More...
 
class  RenderPassExtensions
 Extensions for RenderPass. More...
 
class  RenderPipeline
 Defines an entry point for mesh instantiation and recursive rendering. More...
 
class  RenderPipelineFactory
 Helper class to easily setup various predefined RenderPipeline, using RenderPipeline.Pipeline. More...
 
class  RenderStateSetter
 Sets given render state during rendering. More...
 
class  RenderStreamPlugin
 
class  RenderSystem
 Renders its RenderSystem.Pipeline, which will usually result in drawing all meshes, UI, etc... More...
 
class  RenderTargetSetter
 A processor that setup a RenderTarget and a DepthStencil on a RenderPass. More...
 
class  RenderTargetsPlugin
 Level10 render pass using a depth buffer and a render target. More...
 
class  Scene
 Scene as exported by third-party exporters (FBX, Assimp, etc...) More...
 
class  ShaderMixins
 
struct  ShadowConfiguration
 
class  ShadowConfigurationArray
 
class  ShadowMap
 Represents a ShadowMap. More...
 
struct  ShadowMapData
 Intermediate ShadowMap calculation structure.
 
class  ShadowMapFilter
 
class  ShadowMapFilterDefault
 
class  ShadowMapFilterVsm
 
class  ShadowMapParameters
 
class  ShadowMapPermutation
 
class  ShadowMapPermutationArray
 
struct  ShadowMapReceiverInfo
 
struct  ShadowMapReceiverVsmInfo
 
class  SkyBoxPlugin
 Posteffect manager. More...
 
class  SlideShowPlugin
 Posteffect manager. More...
 
class  SpriteRenderer
 This Renderer is responsible to prepare and render sprites for a specific pass. More...
 
class  StateShaderPlugin
 Basic shader plugin built directly from shader source file. More...
 
class  TessellationPlugin
 
struct  TransformTRS
 Stores transformation in a TRS format (Translation, Rotation and Scaling). More...
 
class  UIRenderer
 The renderer in charge of drawing the UI. More...
 
class  WireframeShaderPlugin
 
class  YebisPlugin
 

Enumerations

enum  MaterialShadingModel { MaterialShadingModel.Flat, MaterialShadingModel.Gouraud, MaterialShadingModel.Phong }
 Shading interpolation model. More...
 
enum  MaterialDiffuseModel { MaterialDiffuseModel.None, MaterialDiffuseModel.Lambert, MaterialDiffuseModel.OrenNayar }
 Diffuse component model. More...
 
enum  MaterialSpecularModel { MaterialSpecularModel.None, MaterialSpecularModel.Phong, MaterialSpecularModel.BlinnPhong, MaterialSpecularModel.CookTorrance }
 Specular component model. More...
 
enum  MaterialLightingType {
  MaterialLightingType.DiffuseVertex = 1, MaterialLightingType.DiffusePixel = 2, MaterialLightingType.SpecularPixel = 4, MaterialLightingType.DiffuseVertexSpecularPixel = DiffuseVertex | SpecularPixel,
  MaterialLightingType.DiffuseSpecularPixel = DiffusePixel | SpecularPixel
}
 
enum  ModelNodeFlags { ModelNodeFlags.EnableTransform = 1, ModelNodeFlags.EnableRender = 2, ModelNodeFlags.Default = EnableTransform | EnableRender }
 Flags describing state of a ModelNodeDefinition. More...
 
enum  RenderLayers {
  RenderLayers.RenderLayerNone = 0, RenderLayers.RenderLayer1 = 0x1, RenderLayers.RenderLayer2 = 0x2, RenderLayers.RenderLayer3 = 0x4,
  RenderLayers.RenderLayer4 = 0x8, RenderLayers.RenderLayer5 = 0x10, RenderLayers.RenderLayer6 = 0x20, RenderLayers.RenderLayer7 = 0x40,
  RenderLayers.RenderLayer8 = 0x80, RenderLayers.RenderLayer9 = 0x100, RenderLayers.RenderLayer10 = 0x200, RenderLayers.RenderLayer11 = 0x400,
  RenderLayers.RenderLayer12 = 0x800, RenderLayers.RenderLayer13 = 0x1000, RenderLayers.RenderLayer14 = 0x2000, RenderLayers.RenderLayer15 = 0x4000,
  RenderLayers.RenderLayerAll = 0xffff
}
 
enum  AOQuality { AOQuality.Low, AOQuality.Medium, AOQuality.High }
 
enum  CascadeShadowMapLevel { CascadeShadowMapLevel.X1 = 1, CascadeShadowMapLevel.X2 = 2, CascadeShadowMapLevel.X4 = 4 }
 Level defined for a cascade shadow map. More...
 
enum  ShadowMapMode { ShadowMapMode.None = 0, ShadowMapMode.Caster = 1, ShadowMapMode.Receiver = 2, ShadowMapMode.All = Caster | Receiver }
 

Functions

delegate void ParameterUpdateDelegate1< TCast1, T > (ref TCast1 param1, ref T output)
 
delegate void ParameterUpdateDelegate2< TCast1, TCast2, T > (ref TCast1 param1, ref TCast2 param2, ref T output)
 
delegate void ParameterUpdateDelegate3< TCast1, TCast2, TCast3, T > (ref TCast1 param1, ref TCast2 param2, ref TCast3 param3, ref T output)
 
delegate void ParameterUpdateDelegate4< TCast1, TCast2, TCast3, TCast4, T > (ref TCast1 param1, ref TCast2 param2, ref TCast3 param3, ref TCast4 param4, ref T output)
 
delegate void ParameterUpdateDelegate5< TCast1, TCast2, TCast3, TCast4, TCast5, T > (ref TCast1 param1, ref TCast2 param2, ref TCast3 param3, ref TCast4 param4, ref TCast5 param5, ref T output)
 
delegate void ParameterUpdateDelegate6< TCast1, TCast2, TCast3, TCast4, TCast5, TCast6, T > (ref TCast1 param1, ref TCast2 param2, ref TCast3 param3, ref TCast4 param4, ref TCast5 param5, ref TCast6 param6, ref T output)
 
delegate void UpdateMeshesDelegate (RenderPass currentRenderPass, ref FastList< RenderMesh > meshes)
 
delegate void RenderPassForeach (RenderPass renderPass, int level)
 Delegate used by RenderPassExtensions.Foreach. More...
 

Enumeration Type Documentation

Enumerator
Low 
Medium 
High 

Definition at line 13 of file AOPlugin.cs.

Level defined for a cascade shadow map.

Enumerator
X1 

Use only one view.

X2 

Use two views.

X4 

Use four views.

Definition at line 8 of file CascadeShadowMapLevel.cs.

Diffuse component model.

Enumerator
None 
Lambert 
OrenNayar 

Definition at line 59 of file MaterialParametersKeys.cs.

Enumerator
DiffuseVertex 
DiffusePixel 
SpecularPixel 
DiffuseVertexSpecularPixel 
DiffuseSpecularPixel 

Definition at line 80 of file MaterialParametersKeys.cs.

Shading interpolation model.

Enumerator
Flat 
Gouraud 
Phong 

Definition at line 48 of file MaterialParametersKeys.cs.

Specular component model.

Enumerator
None 
Phong 
BlinnPhong 
CookTorrance 

Definition at line 70 of file MaterialParametersKeys.cs.

Flags describing state of a ModelNodeDefinition.

Enumerator
EnableTransform 

If true, ModelNodeTransformation.Transform will be used to update ModelNodeTransformation.LocalMatrix.

EnableRender 

If true, associated Mesh will be rendered.

Default 

The default flags.

Definition at line 13 of file ModelNodeFlags.cs.

Enumerator
RenderLayerNone 
RenderLayer1 
RenderLayer2 
RenderLayer3 
RenderLayer4 
RenderLayer5 
RenderLayer6 
RenderLayer7 
RenderLayer8 
RenderLayer9 
RenderLayer10 
RenderLayer11 
RenderLayer12 
RenderLayer13 
RenderLayer14 
RenderLayer15 
RenderLayerAll 

Definition at line 12 of file RenderLayers.cs.

Enumerator
None 
Caster 
Receiver 
All 

Definition at line 6 of file ShadowMapMode.cs.

Function Documentation

delegate void SiliconStudio.Paradox.Effects.ParameterUpdateDelegate1< TCast1, T > ( ref TCast1  param1,
ref T  output 
)
delegate void SiliconStudio.Paradox.Effects.ParameterUpdateDelegate2< TCast1, TCast2, T > ( ref TCast1  param1,
ref TCast2  param2,
ref T  output 
)
delegate void SiliconStudio.Paradox.Effects.ParameterUpdateDelegate3< TCast1, TCast2, TCast3, T > ( ref TCast1  param1,
ref TCast2  param2,
ref TCast3  param3,
ref T  output 
)
delegate void SiliconStudio.Paradox.Effects.ParameterUpdateDelegate4< TCast1, TCast2, TCast3, TCast4, T > ( ref TCast1  param1,
ref TCast2  param2,
ref TCast3  param3,
ref TCast4  param4,
ref T  output 
)
delegate void SiliconStudio.Paradox.Effects.ParameterUpdateDelegate5< TCast1, TCast2, TCast3, TCast4, TCast5, T > ( ref TCast1  param1,
ref TCast2  param2,
ref TCast3  param3,
ref TCast4  param4,
ref TCast5  param5,
ref T  output 
)
delegate void SiliconStudio.Paradox.Effects.ParameterUpdateDelegate6< TCast1, TCast2, TCast3, TCast4, TCast5, TCast6, T > ( ref TCast1  param1,
ref TCast2  param2,
ref TCast3  param3,
ref TCast4  param4,
ref TCast5  param5,
ref TCast6  param6,
ref T  output 
)
delegate void SiliconStudio.Paradox.Effects.RenderPassForeach ( RenderPass  renderPass,
int  level 
)

Delegate used by RenderPassExtensions.Foreach.

Parameters
renderPassThe render pass.
levelThe level reflects the deepness of this renderpass in the renderpass tree. Zero for the top level render pass.
delegate void SiliconStudio.Paradox.Effects.UpdateMeshesDelegate ( RenderPass  currentRenderPass,
ref FastList< RenderMesh >  meshes 
)