Urho.Light Class

Light component.

See Also: Light

Syntax

public class Light : Drawable

Requirements

Namespace: Urho
Assembly: Urho (in Urho.dll)
Assembly Versions: 1.0.0.0

The members of Urho.Light are listed below.

See Also: Drawable

Public Constructors

Constructs a new instance of Urho.Light which is tied to the Application.CurrentContext.
Constructs a new instance of Urho.Light, given a raw pointer to an unmanaged object
Constructs a new instance of Urho.Light linked to a specific Context.

Protected Constructors

Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.

Public Properties

AspectRatioSingle. Return spotlight aspect ratio. Or Set spotlight aspect ratio.
BrightnessSingle. Return brightness multiplier. Or Set light brightness multiplier. Both the color and specular intensity are multiplied with this to get final values for rendering.
ColorColor. Return color. Or Set color.
[read-only]
ColorFromTemperatureColor. Return the color value of the temperature in Kelvin.
[read-only]
EffectiveColorColor. Return effective color, multiplied by brightness. Do not multiply the alpha so that can compare against the default black color to detect a light with no effect.
[read-only]
EffectiveSpecularIntensitySingle. Return effective specular intensity, multiplied by absolute value of brightness.
FadeDistanceSingle. Return fade start distance. Or Set fade out start distance.
FovSingle. Return spotlight field of view. Or Set spotlight field of view.
[read-only]
FrustumFrustum. Return spotlight frustum.
LengthSingle.
LightQueueLightBatchQueue*. Return light queue. Called by View. Or Set light queue used for this light. Called by View.
LightTypeLightType. Return light type. Or Set light type.
[read-only]
NegativeBoolean. Return whether light has negative (darkening) color.
[read-only]
NumShadowSplitsInt32. Return number of shadow map cascade splits for a directional light, considering also graphics API limitations.
PerVertexBoolean. Return vertex lighting mode. Or Set vertex lighting mode.
RadiusSingle.
RampTextureTexture. Return range attenuation texture. Or Set range attenuation texture.
[read-only]
RampTextureAttrResourceRef. Return ramp texture attribute.
RangeSingle. Return range. Or Set range.
ShadowBiasBiasParameters. Return shadow depth bias parameters. Or Set shadow depth bias parameters.
ShadowCascadeCascadeParameters. Return directional light cascaded shadow parameters. Or Set directional light cascaded shadow parameters.
ShadowFadeDistanceSingle. Return shadow fade start distance. Or Set shadow fade out start distance. Only has effect if shadow distance is also non-zero.
ShadowFocusFocusParameters. Controsl the shadow map focusing parameters
ShadowIntensitySingle. Return shadow intensity. Or Set shadow intensity between 0.0 - 1.0. 0.0 (the default) gives fully dark shadows.
ShadowMaxExtrusionSingle. Return maximum shadow extrusion distance for directional lights. Or Set maximum shadow extrusion for directional lights. The actual extrusion will be the smaller of this and camera far clip. Default 1000.
ShadowNearFarRatioSingle. Return shadow camera near/far clip distance ratio. Or Set shadow camera near/far clip distance ratio.
ShadowResolutionSingle. Return shadow resolution. Or Set shadow resolution between 0.25 - 1.0. Determines the shadow map to use.
ShapeTextureTexture. Return spotlight attenuation texture. Or Set spotlight attenuation texture.
[read-only]
ShapeTextureAttrResourceRef. Return shape texture attribute.
SpecularIntensitySingle. Return specular intensity. Or Set specular intensity. Zero disables specular calculations.
TemperatureSingle. Return the temperature of the light in Kelvin. Or Set temperature of the light in Kelvin. Modulates the light color when "use physical values" is enabled.
[read-only]
override
TypeStringHash. Urho's type system type.
[read-only]
override
TypeNameString. Urho's low-level type name.
[read-only]
static
TypeNameStaticString. Urho's low-level type name, accessible as a static method.
[read-only]
static
TypeStaticStringHash. Urho's low-level type, accessible as a static method.
UsePhysicalValuesBoolean. Return if light uses temperature and brightness in lumens. Or Set use physical light values.

Public Methods

override
DrawDebugGeometry(DebugRenderer, Boolean)
Visualize the component as debug geometry.
static
GetFullscreenQuadTransform(Camera) : Matrix3x4
GetIntensityDivisor(Single) : Single
Return a divisor value based on intensity for calculating the sort value.
GetViewSpaceFrustum(Matrix3x4) : Frustum
Return spotlight frustum in the specified view space.
GetVolumeTransform(Camera) : Matrix3x4
static
RegisterObject(Context)
Register object factory. Drawable must be registered first.
SetIntensitySortValue(Single)
Set sort value based on intensity and view distance.
SetIntensitySortValue(BoundingBox)
Set sort value based on overall intensity over a bounding box.