Add a light to an Entity, that will be used during rendering. More...

Inheritance diagram for SiliconStudio.Paradox.Engine.LightComponent:

Public Member Functions
	LightComponent ()

Public Member Functions inherited from SiliconStudio.Paradox.EntityModel.EntityComponent
	EntityComponent ()
	Initializes a new instance of the EntityComponent class. More...

Static Public Attributes
static PropertyKey < LightComponent >	Key = new PropertyKey<LightComponent>("Key", typeof(LightComponent))

Properties
bool	Enabled `[get, set]`
	Gets or sets a value indicating whether the light is enabled. More...

bool	Deferred `[get, set]`
	Gets or sets a value indicating whether the light is deferred (if available). More...

LightType	Type `[get, set]`
	Gets or sets the light type. More...

Color3	Color `[get, set]`
	Gets or sets the light color. More...

float	Intensity `[get, set]`
	Gets or sets the light intensity. More...

float	DecayStart `[get, set]`
	Gets or sets the decay start. More...

Vector3	LightDirection `[get, set]`
	Gets or sets the light direction. More...

float	SpotBeamAngle `[get, set]`
	Gets or sets the beam angle of the spot light. More...

float	SpotFieldAngle `[get, set]`
	Gets or sets the spot field angle of the spot light. More...

bool	ShadowMap `[get, set]`
	Gets or Sets a value indicating if the light cast shadows. More...

int	ShadowMapMaxSize `[get, set]`
	Gets or Sets the maximium size (in pixel) of one cascade of the shadow map. More...

int	ShadowMapMinSize `[get, set]`
	Gets or Sets the minimum size (in pixel) of one cascade of the shadow map. More...

int	ShadowMapCascadeCount `[get, set]`
	Gets or Sets the number of cascades for this shadow. More...

float	ShadowNearDistance `[get, set]`
	Gets or Sets the near plane distance of the shadow. More...

float	ShadowFarDistance `[get, set]`
	Gets or Sets the far plane distance of the shadow. More...

ShadowMapFilterType	ShadowMapFilterType `[get, set]`
	Gets or sets the shadow map filtering. More...

float	BleedingFactor `[get, set]`
	Gets or sets the bleeding factor of the variance shadow map. More...

float	MinVariance `[get, set]`
	Gets or sets the minimal value of the variance of the variance shadow map. More...

RenderLayers	Layers `[get, set]`
	Get or sets the layers that the light influences More...

override PropertyKey	DefaultKey `[get]`

Properties inherited from SiliconStudio.Paradox.EntityModel.EntityComponent
Entity	Entity `[get, set]`
	Gets or sets the owner entity. More...

Entity	EnsureEntity `[get]`
	Gets the entity and throws an exception if the entity is null. More...

virtual PropertyKey	DefaultKey `[get]`
	The default key this component is associated to. More...

Properties inherited from SiliconStudio.Core.IContentUrl
string	Url `[get, set]`
	The URL of this asset. More...

Additional Inherited Members
Static Public Member Functions inherited from SiliconStudio.Paradox.EntityModel.EntityComponent
static PropertyKey	GetDefaultKey< T > ()
	Gets the default key for the specified entity component type. More...

Detailed Description

Add a light to an Entity, that will be used during rendering.

Definition at line 28 of file LightComponent.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.Engine.LightComponent.LightComponent ( )

Definition at line 32 of file LightComponent.cs.

Member Data Documentation

PropertyKey<LightComponent> SiliconStudio.Paradox.Engine.LightComponent.Key = new PropertyKey<LightComponent>("Key", typeof(LightComponent))

static

Definition at line 30 of file LightComponent.cs.

Referenced by ScriptShader.Effects.LightShaftsProcessor.GenerateAssociatedData().

Property Documentation

float SiliconStudio.Paradox.Engine.LightComponent.BleedingFactor

getset

Gets or sets the bleeding factor of the variance shadow map.

The bleeding factor.

Definition at line 167 of file LightComponent.cs.

Color3 SiliconStudio.Paradox.Engine.LightComponent.Color

getset

Gets or sets the light color.

The color.

Definition at line 79 of file LightComponent.cs.

float SiliconStudio.Paradox.Engine.LightComponent.DecayStart

getset

Gets or sets the decay start.

The decay start.

Definition at line 98 of file LightComponent.cs.

override PropertyKey SiliconStudio.Paradox.Engine.LightComponent.DefaultKey

get

Definition at line 188 of file LightComponent.cs.

bool SiliconStudio.Paradox.Engine.LightComponent.Deferred

getset

Gets or sets a value indicating whether the light is deferred (if available).

true if light is deferred, false if not.

Definition at line 61 of file LightComponent.cs.

Referenced by ScriptShader.Effects.LightProcessor.OnEntityAdded().

bool SiliconStudio.Paradox.Engine.LightComponent.Enabled

getset

Gets or sets a value indicating whether the light is enabled.

Definition at line 56 of file LightComponent.cs.

float SiliconStudio.Paradox.Engine.LightComponent.Intensity

getset

Gets or sets the light intensity.

The light intensity.

Definition at line 89 of file LightComponent.cs.

RenderLayers SiliconStudio.Paradox.Engine.LightComponent.Layers

getset

Get or sets the layers that the light influences

The layer mask.

Definition at line 185 of file LightComponent.cs.

Vector3 SiliconStudio.Paradox.Engine.LightComponent.LightDirection

getset

Gets or sets the light direction.

The light direction.

Definition at line 103 of file LightComponent.cs.

Referenced by SiliconStudio.Paradox.Effects.Modules.Processors.LightShadowProcessor.UpdateEntityLightShadow().

float SiliconStudio.Paradox.Engine.LightComponent.MinVariance

getset

Gets or sets the minimal value of the variance of the variance shadow map.

The minimal variance.

Definition at line 175 of file LightComponent.cs.

float SiliconStudio.Paradox.Engine.LightComponent.ShadowFarDistance

getset

Gets or Sets the far plane distance of the shadow.

The far plane distance of the shadow.

Definition at line 151 of file LightComponent.cs.

bool SiliconStudio.Paradox.Engine.LightComponent.ShadowMap

getset

Gets or Sets a value indicating if the light cast shadows.

True if the ligh generates a shadowmap, false otherwise.

Definition at line 121 of file LightComponent.cs.

Referenced by ScriptShader.Effects.LightProcessor.OnEntityAdded().

int SiliconStudio.Paradox.Engine.LightComponent.ShadowMapCascadeCount

getset

Gets or Sets the number of cascades for this shadow.

The number of cascades for this shadow.

Definition at line 139 of file LightComponent.cs.

ShadowMapFilterType SiliconStudio.Paradox.Engine.LightComponent.ShadowMapFilterType

getset

Gets or sets the shadow map filtering.

The filter type.

Definition at line 159 of file LightComponent.cs.

Referenced by SiliconStudio.Paradox.Effects.Modules.Processors.DynamicLightShadowProcessor.CreateShadowMap().

int SiliconStudio.Paradox.Engine.LightComponent.ShadowMapMaxSize

getset

Gets or Sets the maximium size (in pixel) of one cascade of the shadow map.

The maximum size of the shadow map.

Definition at line 127 of file LightComponent.cs.

int SiliconStudio.Paradox.Engine.LightComponent.ShadowMapMinSize

getset

Gets or Sets the minimum size (in pixel) of one cascade of the shadow map.

The minimum size of the shadow map.

Definition at line 133 of file LightComponent.cs.

float SiliconStudio.Paradox.Engine.LightComponent.ShadowNearDistance

getset

Gets or Sets the near plane distance of the shadow.

The near plane distance of the shadow.

Definition at line 145 of file LightComponent.cs.

float SiliconStudio.Paradox.Engine.LightComponent.SpotBeamAngle

getset

Gets or sets the beam angle of the spot light.

The beam angle of the spot (in degrees between 0 and 90).

Definition at line 109 of file LightComponent.cs.

float SiliconStudio.Paradox.Engine.LightComponent.SpotFieldAngle

getset

Gets or sets the spot field angle of the spot light.

The spot field angle of the spot (in degrees between 0 and 90).

Definition at line 115 of file LightComponent.cs.

LightType SiliconStudio.Paradox.Engine.LightComponent.Type

getset

Gets or sets the light type.

The type.

Definition at line 70 of file LightComponent.cs.

Referenced by ScriptShader.Effects.LightProcessor.OnEntityAdded(), and SiliconStudio.Paradox.Effects.Modules.Processors.LightShadowProcessor.OnEntityAdding().

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

D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/engine/SiliconStudio.Paradox.Engine/Engine/LightComponent.cs

Public Member Functions

Static Public Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation

Property Documentation