This reference page is linked to from the following overview topics: Principal Light Classes, Light Parameters.
Detailed Description
This structure describes the properties of a light.
- See also:
- Class GenLight, Class LightObject, Class Color, Class Matrix3
#include <object.h>
Public Attributes |
|
| LightType | type |
| One of the following values from enum
LightType: OMNI_LGT - Omnidirectional SPOT_LGT - Spot (cone) DIRECT_LGT - Directional (parallel) AMBIENT_LGT - Global. |
|
| Matrix3 | tm |
| The transformation matrix of the light.
|
|
| Color | color |
| The color of the light (its intensity).
|
|
| float | intens |
| The multiplier applied to the color.
|
|
| float | hotsize |
| The hotspot size in degrees. |
|
| float | fallsize |
| The hotspot falloff size in degrees.
|
|
| int | useNearAtten |
| Nonzero if near attenuation is used;
otherwise zero. |
|
| float | nearAttenStart |
| The near attenuation start value. |
|
| float | nearAttenEnd |
| The near attenuation end value. |
|
| int | useAtten |
| Nonzero if (far) attenuation is used;
otherwise zero. |
|
| float | attenStart |
| The (far) start attenuation value. |
|
| float | attenEnd |
| The (far) end attenuation value. |
|
| int | shape |
| One of the following values: RECT_LIGHT, CIRCLE_LIGHT. |
|
| float | aspect |
| The aspect ratio of the light. |
|
| BOOL | overshoot |
| TRUE if the light supports overshoot;
otherwise FALSE. |
|
| BOOL | shadow |
| TRUE if shadows are on; otherwise FALSE.
|
|
| BOOL | on |
| TRUE if the light is on; otherwise FALSE.
|
|
| BOOL | affectDiffuse |
| TRUE if affect diffuse is on; otherwise
FALSE. |
|
| BOOL | affectSpecular |
| TRUE if affect specular is on; otherwise
FALSE. |
|
| BOOL | ambientOnly |
| DWORD | extra |
Member Data Documentation
| LightType type |
One of the following values from enum LightType:
OMNI_LGT - Omnidirectional
SPOT_LGT - Spot (cone)
DIRECT_LGT - Directional (parallel)
AMBIENT_LGT - Global.
The transformation matrix of the light.
The color of the light (its intensity).
| float intens |
The multiplier applied to the color.
| float hotsize |
The hotspot size in degrees.
| float fallsize |
The hotspot falloff size in degrees.
| int useNearAtten |
Nonzero if near attenuation is used; otherwise zero.
| float nearAttenStart |
The near attenuation start value.
| float nearAttenEnd |
The near attenuation end value.
| int useAtten |
Nonzero if (far) attenuation is used; otherwise zero.
| float attenStart |
The (far) start attenuation value.
| float attenEnd |
The (far) end attenuation value.
| int shape |
One of the following values:
RECT_LIGHT, CIRCLE_LIGHT.
| float aspect |
The aspect ratio of the light.
| BOOL overshoot |
TRUE if the light supports overshoot; otherwise FALSE.
| BOOL shadow |
TRUE if shadows are on; otherwise FALSE.
| BOOL on |
TRUE if the light is on; otherwise FALSE.
| BOOL affectDiffuse |
TRUE if affect diffuse is on; otherwise FALSE.
| BOOL affectSpecular |
TRUE if affect specular is on; otherwise FALSE.
