BBMOD_SpotLight

A constructor defined in BBMOD_SpotLight.gml

Extends BBMOD_PunctualLight

new BBMOD_SpotLight([_color[, _position[, _range[, _direction[, _angleInner[, _angleOuter]]]]]])

Description

A spot light.

Arguments

Name Type Description
_color Struct.BBMOD_Color The light's color. Defaults to BBMOD_C_WHITE.
_position Struct.BBMOD_Vec3 The light's position. Defaults to (0, 0, 0) if undefined.
_range Real The light's range. Defaults to 1.
_direction Struct.BBMOD_Vec3 The light's direction. Defaults to BBMOD_VEC3_FORWARD if undefined.
_angleInner Real The inner cone angle in degrees. Defaults to 10.
_angleOuter Real The outer cone angle in degrees. Defaults to 20.

Properties

Name Description
AngleInner The inner cone angle in degrees. Default value is 10.
AngleOuter The inner cone angle in degrees. Default value is 20.
Direction The direction of the light. The default value is (1, 0, 0).

Inherited properties

Name Description
AffectLightmaps If true then the light affects also materials with baked lightmaps. Defaults to true.
CastShadows If true then the light should casts shadows. This may not be implemented for all types of lights! Defaults to false.
Color The color of the light. Default value is BBMOD_C_WHITE.
Enabled Use false to disable the light. Defaults to true (the light is enabled).
Frameskip Number of frames to skip between individual updates of the light's shadowmap. Default value is 0, which means no frame skipping.
NeedsUpdate If true and the light is static, its shadowmap needs to be updated.
Position The position of the light.
Range The range of the light.
RenderPass Bitwise OR of 1 << render pass in which the light is enabled. By default this is BBMOD_ERenderPass.Forward and BBMOD_ERenderPass.ReflectionCapture, which means the light is visible only in the forward render pass and during capture of reflection probes.
ShadowmapResolution The resolution of the shadowmap surface. Must be power of 2. Defaults to 512.
Static If true then the light's shadowmap is captured only once or when requested via setting the BBMOD_Light.NeedsUpdate property to true.
Do you find this page helpful?

Copyright © 2023, BlueBurn. Built on September 11, 2023 using GMDoc.