GeneralRulesApplyLights Method |
Use properties of the sprites in the specified category to configure real-time lighting on the display
for the current frame.
Namespace: (Default Namespace)Assembly: Default (in Default.exe) Version: 1.0.0.0
Syntax public virtual void ApplyLights(
SpriteCollection sprites,
int view
)
Parameters
- sprites
- Type: (Default Namespace)SpriteCollection
Sprite category containing all the light sources to apply to the display. - view
- Type: SystemInt32
View number (0 to 3) whose light sources are being applied. The display will
remember up to 4 light source configurations to be used when drawing up to 4 views as defined by
SetViewLayout(ViewLayout).
Remarks Light sources are sprites whose base class is set to LightSpriteBase. Only sprites with that
base class will affect the lighting. Only MAX_LIGHTS lights will be processed. Any quantity in excess
of that number will be ignored. Only active light sources are applied; to exclude a light source from
consuming one of the limited slots available within MAX_LIGHTS, deactivate the sprite.
See Also