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

Keys used for lighting. More...

Inheritance diagram for SiliconStudio.Paradox.Effects.LightingKeys:
SiliconStudio.Paradox.Shaders.ShaderMixinParameters SiliconStudio.Paradox.Effects.ParameterCollection IDictionary< ParameterKey, object >

Static Public Attributes

static readonly ParameterKey< int > MaxDirectionalLights = ParameterKeys.New(0)
 Maximum number of directional lights. More...
 
static readonly ParameterKey< int > MaxPointLights = ParameterKeys.New(0)
 Maximum number of point lights. More...
 
static readonly ParameterKey< int > MaxSpotLights = ParameterKeys.New(0)
 Maximum number of spot lights. More...
 
static readonly ParameterKey
< bool > 
UnrollDirectionalLightLoop = ParameterKeys.New(false)
 A flag stating if directional light loop should be unrolled. More...
 
static readonly ParameterKey
< bool > 
UnrollPointLightLoop = ParameterKeys.New(false)
 A flag stating if point light loop should be unrolled. More...
 
static readonly ParameterKey
< bool > 
UnrollSpotLightLoop = ParameterKeys.New(false)
 A flag stating if spot light loop should be unrolled. More...
 
static readonly ParameterKey
< bool > 
CastShadows = ParameterKeys.New(true)
 Flag stating if the mesh casts shadows. More...
 
static readonly ParameterKey
< bool > 
ReceiveShadows = ParameterKeys.New(true)
 Flag stating if the mesh receives shadows. More...
 
static readonly ParameterKey
< LightingConfigurationsSet
LightingConfigurations = ParameterKeys.New<LightingConfigurationsSet>()
 Supported lighting configurations. More...
 
static readonly ParameterKey< int > MaxDeferredLights = ParameterKeys.New(64)
 Maximum number of deferred lights. More...
 
static readonly ParameterKey
< bool > 
UnrollDeferredLightLoop = ParameterKeys.New(false)
 A flag stating if deferred light loop should be unrolled. More...
 

Additional Inherited Members

- Public Member Functions inherited from SiliconStudio.Paradox.Shaders.ShaderMixinParameters
 ShaderMixinParameters ()
 Initializes a new instance of the ShaderMixinParameters class. More...
 
 ShaderMixinParameters (string name)
 Initializes a new instance of the ParameterCollection class. More...
 
- Public Member Functions inherited from SiliconStudio.Paradox.Effects.ParameterCollection
 ParameterCollection ()
 Initializes a new instance of the ParameterCollection class. More...
 
 ParameterCollection (string name)
 Initializes a new instance of the ParameterCollection class. More...
 
delegate void ValueChangedDelegate (ParameterKey key, InternalValue internalValue, object oldValue)
 
void Clear ()
 
void AddEvent (ParameterKey key, ValueChangedDelegate valueUpdated)
 Adds an event that will be raised when a value is updated. More...
 
bool ContainsKey (ParameterKey key)
 Determines whether the specified instance contains a parameter key. More...
 
void Add (ParameterKey key, object value)
 
bool TryGetValue (ParameterKey key, out object value)
 
IEnumerator< KeyValuePair
< ParameterKey, object > > 
GetEnumerator ()
 
override string ToString ()
 
string ToStringDetailed (string itemSeparator="\r\n", string itemTab=" ")
 
void Add< T > (ParameterKey< T > key, T value)
 
Get< T > (ParameterKey< T > key)
 Gets the value for the specified key. More...
 
void Get< T > (ParameterKey< T > key, out T result)
 Gets the value for the specified key. More...
 
object GetObject (ParameterKey key)
 
TryGet< T > (ParameterKey< T > key)
 Tries to get the value for the specified key. More...
 
bool TryGet< T > (ParameterKey< T > key, out T result)
 Tries to get the value for the specified key. More...
 
void AddDynamic< T > (ParameterKey< T > key, ParameterDynamicValue< T > dynamicValue)
 
void SetDefault (ParameterKey key, bool overrideIfInherited=false)
 Sets the default value for the specified key (if undefined, otherwise do nothing). More...
 
void Set< T > (ParameterKey< T > key, T value)
 Sets a struct value for the specified key. More...
 
void SetArray< T > (ParameterKey< T[]> key, T[] values)
 Sets an array of valuetypes for the specified key. More...
 
void Set< T > (ParameterKey< T[]> key, T[] values, int destinationOffset, int count)
 Sets an array of valuetypes for the specified key. More...
 
void Set< T > (ParameterKey< T[]> key, T[] values, int sourceOffset, int destinationOffset, int count)
 Sets an array of valuetypes for the specified key. More...
 
void SetObject (ParameterKey key, object resourceValue)
 
void Remove (ParameterKey key)
 Removes the specified key and associated value More...
 
bool Contains (ParameterCollection parameters)
 Tests if the values in parameters are contained into this instance. It will automatically handle default values as well (that is, if something is set in parameters with default value but not set in this instance, it will be ignored). More...
 
void AddSources (params IParameterCollectionInheritance[] newSources)
 Adds the sources. More...
 
bool RemoveSource (IParameterCollectionInheritance removedInheritance)
 Removes the sources. More...
 
void Reset (ParameterKey key)
 Removes the value locally and try to get a value from a source. More...
 
bool IsValueOwner (InternalValue internalValue)
 Determines whether [is value owner] of [the specified key]. More...
 
- Protected Member Functions inherited from SiliconStudio.Paradox.Effects.ParameterCollection
bool GetKeyIndex (ParameterKey key, out int index)
 
int InternalValueBinarySearch (ParameterKey key)
 Gets the index of an InternalValue within internalValues given its key. More...
 
int GetOrCreateKeyIndex (ParameterKey key)
 Gets or creates an internal value index given its key. More...
 
void Destroy ()
 
- Properties inherited from SiliconStudio.Paradox.Effects.ParameterCollection
string Name [get, set]
 
IParameterCollectionInheritance[] Sources [get]
 Gets the sources for this collection. More...
 
IEnumerable
< ParameterDynamicValue
DynamicValues [get]
 Gets the dynamic values. More...
 
int Count [get]
 Gets the number of parameters stored in this instance.. More...
 
bool IsReadOnly [get, set]
 
IEnumerable< ParameterKeyKeys [get]
 Gets the keys of this collection. More...
 
ICollection< object > Values [get, set]
 
object this[ParameterKey key] [get, set]
 

Detailed Description

Keys used for lighting.

Definition at line 12 of file LightingKeys.cs.

Member Data Documentation

readonly ParameterKey<bool> SiliconStudio.Paradox.Effects.LightingKeys.CastShadows = ParameterKeys.New(true)
static

Flag stating if the mesh casts shadows.

<userdoc> When checked, the mesh will cast shadows. </userdoc>

Definition at line 68 of file LightingKeys.cs.

Referenced by SiliconStudio.Paradox.Effects.ModelRendererExtensions.AddShadowCasterFilter().

readonly ParameterKey<LightingConfigurationsSet> SiliconStudio.Paradox.Effects.LightingKeys.LightingConfigurations = ParameterKeys.New<LightingConfigurationsSet>()
static

Supported lighting configurations.

<userdoc> The supported lighting configurations. </userdoc>

Definition at line 84 of file LightingKeys.cs.

Referenced by SiliconStudio.BuildEngine.ImportModelCommand.DoCommandOverride(), and SiliconStudio.Paradox.Assets.Effect.Generators.EntityCompilerParametersGenerator.Generate().

readonly ParameterKey<int> SiliconStudio.Paradox.Effects.LightingKeys.MaxDeferredLights = ParameterKeys.New(64)
static

Maximum number of deferred lights.

<userdoc> Maximum number of deferred point lights. </userdoc>

Definition at line 92 of file LightingKeys.cs.

readonly ParameterKey<int> SiliconStudio.Paradox.Effects.LightingKeys.MaxDirectionalLights = ParameterKeys.New(0)
static

Maximum number of directional lights.

<userdoc> Maximum number of supported directional lights. </userdoc>

Definition at line 20 of file LightingKeys.cs.

readonly ParameterKey<int> SiliconStudio.Paradox.Effects.LightingKeys.MaxPointLights = ParameterKeys.New(0)
static

Maximum number of point lights.

<userdoc> Maximum number of supported point lights. </userdoc>

Definition at line 28 of file LightingKeys.cs.

readonly ParameterKey<int> SiliconStudio.Paradox.Effects.LightingKeys.MaxSpotLights = ParameterKeys.New(0)
static

Maximum number of spot lights.

<userdoc> Maximum number of supported spot lights. </userdoc>

Definition at line 36 of file LightingKeys.cs.

readonly ParameterKey<bool> SiliconStudio.Paradox.Effects.LightingKeys.ReceiveShadows = ParameterKeys.New(true)
static

Flag stating if the mesh receives shadows.

<userdoc> When checked, the mesh will receive shadows. </userdoc>

Definition at line 76 of file LightingKeys.cs.

readonly ParameterKey<bool> SiliconStudio.Paradox.Effects.LightingKeys.UnrollDeferredLightLoop = ParameterKeys.New(false)
static

A flag stating if deferred light loop should be unrolled.

<userdoc> When checked, the deferred effect will support exactly the set number of point lights. </userdoc>

Definition at line 100 of file LightingKeys.cs.

readonly ParameterKey<bool> SiliconStudio.Paradox.Effects.LightingKeys.UnrollDirectionalLightLoop = ParameterKeys.New(false)
static

A flag stating if directional light loop should be unrolled.

<userdoc> When checked, the effect will support exactly the set number of directional lights. </userdoc>

Definition at line 44 of file LightingKeys.cs.

readonly ParameterKey<bool> SiliconStudio.Paradox.Effects.LightingKeys.UnrollPointLightLoop = ParameterKeys.New(false)
static

A flag stating if point light loop should be unrolled.

<userdoc> When checked, the effect will support exactly the set number of point lights. </userdoc>

Definition at line 52 of file LightingKeys.cs.

readonly ParameterKey<bool> SiliconStudio.Paradox.Effects.LightingKeys.UnrollSpotLightLoop = ParameterKeys.New(false)
static

A flag stating if spot light loop should be unrolled.

<userdoc> When checked, the effect will support exactly the set number of spot lights. </userdoc>

Definition at line 60 of file LightingKeys.cs.


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