Light Class

Language:

Defines a set of lighting properties.

Definition

Visual Basic NotInheritable Public Class Light
Inherits Object

C# public sealed class Light : Object

C++ public ref class Light sealed : Object

JScript public final class Light extends Object

Visual Basic	NotInheritable Public Class Light Inherits Object
C#	public sealed class Light : Object
C++	public ref class Light sealed : Object
JScript	public final class Light extends Object

Members Table

The following table lists the members exposed by the object. Click a tab on the left to choose the type of member you want to view.

Methods

Method Description

FromLight Creates a new light based on an existing light.

Light Creates a new instance of the Light class.

ToString Obtains a string representation of the current instance.

Update Updates the settings for the current Light object.

Properties

Property Description

Ambient Retrieves or sets the ambient color emitted by the light.
This member is a Color structure.

AmbientColor Retrieves or sets the ambient color emitted by the light.
This member is a ColorValue structure.

Attenuation0 Retrieves or sets a value that specifies how light intensity changes over distance.

Attenuation1 Retrieves or sets a value that specifies how light intensity changes over distance.

Attenuation2 Retrieves or sets a value that specifies how light intensity changes over distance.

Diffuse Retrieves or sets the diffuse color emitted by the light.
This member is a Color structure.

DiffuseColor Retrieves or sets the diffuse color emitted by the light.
This member is a ColorValue structure.

Direction Retrieves or sets the direction in which the light is pointing in world space, as specified by a Vector3 structure.

Enabled Retrieves or sets a Boolean value that enables or disables a set of lighting parameters within a device.

Falloff Retrieves or sets the decrease in illumination between a spotlight's inner cone (the angle specified by InnerConeAngle) and the outer edge of the outer cone (the angle specified by OuterConeAngle).

InnerConeAngle Retrieves or sets the angle, in radians, of a spotlight's inner cone; that is, the fully illuminated spotlight cone.

OuterConeAngle Retrieves or sets the angle, in radians, that defines the outer edge of a spotlight's outer cone.

Position Retrieves or sets the position of the light in world space, as specified by a Vector3 structure.

Range Retrieves or sets the distance beyond which the light has no effect.

Specular Retrieves or sets the specular color emitted by the light.
This member is a Color structure.

SpecularColor Retrieves or sets the specular color emitted by the light.
This member is a ColorValue structure.

Type Retrieves or sets the type of the light source.

XDirection Retrieves or sets an X-axis value that indicates the direction in which the light points.

XPosition Retrieves or sets an X-coordinate value that indicates the position of the light.

YDirection Retrieves or sets a Y-axis value that indicates the direction of the light.

YPosition Retrieves or sets a Y-coordinate value that indicates the position of the light.

ZDirection Retrieves or sets a Z-axis value that indicates the direction of the light.

ZPosition Retrieves or sets a Z-coordinate value that indicates the position of the light.

Method	Description
FromLight	Creates a new light based on an existing light.
Light	Creates a new instance of the Light class.
ToString	Obtains a string representation of the current instance.
Update	Updates the settings for the current Light object.

Property	Description
Ambient	Retrieves or sets the ambient color emitted by the light. This member is a Color structure.
AmbientColor	Retrieves or sets the ambient color emitted by the light. This member is a ColorValue structure.
Attenuation0	Retrieves or sets a value that specifies how light intensity changes over distance.
Attenuation1	Retrieves or sets a value that specifies how light intensity changes over distance.
Attenuation2	Retrieves or sets a value that specifies how light intensity changes over distance.
Diffuse	Retrieves or sets the diffuse color emitted by the light. This member is a Color structure.
DiffuseColor	Retrieves or sets the diffuse color emitted by the light. This member is a ColorValue structure.
Direction	Retrieves or sets the direction in which the light is pointing in world space, as specified by a Vector3 structure.
Enabled	Retrieves or sets a Boolean value that enables or disables a set of lighting parameters within a device.
Falloff	Retrieves or sets the decrease in illumination between a spotlight's inner cone (the angle specified by InnerConeAngle) and the outer edge of the outer cone (the angle specified by OuterConeAngle).
InnerConeAngle	Retrieves or sets the angle, in radians, of a spotlight's inner cone; that is, the fully illuminated spotlight cone.
OuterConeAngle	Retrieves or sets the angle, in radians, that defines the outer edge of a spotlight's outer cone.
Position	Retrieves or sets the position of the light in world space, as specified by a Vector3 structure.
Range	Retrieves or sets the distance beyond which the light has no effect.
Specular	Retrieves or sets the specular color emitted by the light. This member is a Color structure.
SpecularColor	Retrieves or sets the specular color emitted by the light. This member is a ColorValue structure.
Type	Retrieves or sets the type of the light source.
XDirection	Retrieves or sets an X-axis value that indicates the direction in which the light points.
XPosition	Retrieves or sets an X-coordinate value that indicates the position of the light.
YDirection	Retrieves or sets a Y-axis value that indicates the direction of the light.
YPosition	Retrieves or sets a Y-coordinate value that indicates the position of the light.
ZDirection	Retrieves or sets a Z-axis value that indicates the direction of the light.
ZPosition	Retrieves or sets a Z-coordinate value that indicates the position of the light.

Inheritance Hierarchy

Object
Light

Remarks

Light properties are not updated on the device until either Light.Update is called to commit the changes or Light.Enabled is set to true.

Class Information

Namespace Microsoft.DirectX.Direct3D

Assembly Microsoft.DirectX.Direct3D (microsoft.directx.direct3d.dll)

Strong Name Microsoft.DirectX.Direct3D, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Namespace	Microsoft.DirectX.Direct3D
Assembly	Microsoft.DirectX.Direct3D (microsoft.directx.direct3d.dll)
Strong Name	Microsoft.DirectX.Direct3D, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492