lens_flare

This page is incomplete! You can contribute information using GitHub issues or pull requests.

...

	Function/global	Type
	`(rasterizer_lens_flares [boolean])` Toggles rendering of all lens flares.	Global
	`(rasterizer_lens_flares_occlusion [boolean])` Toggles lens flare occlusion. If set to `false`, lens flares will no longer be occluded and stay visible even through objects in the foreground.	Global
	`(rasterizer_lens_flares_occlusion_debug [boolean])` Displays red squares over lens flares in the environment. How much the square is occluded by other geometry or the view frustrum is how much the lens flare fades out. The size of the square relates to the occlusion radius.	Global

Function/global

Type

(rasterizer_lens_flares [boolean])

Toggles rendering of all lens flares.

Global

(rasterizer_lens_flares_occlusion [boolean])

Toggles lens flare occlusion. If set to false, lens flares will no longer be occluded and stay visible even through objects in the foreground.

Global

(rasterizer_lens_flares_occlusion_debug [boolean])

Displays red squares over lens flares in the environment. How much the square is occluded by other geometry or the view frustrum is how much the lens flare fades out. The size of the square relates to the occlusion radius.

Global

Structure and fields

Field Type Comments

falloff angle float

cutoff angle float

cos falloff angle

float

Cache only

cos cutoff angle

float

Cache only

occlusion radius

float

Unit: world units

Primarily controls the size of the camera-facing occlusion square. The more this square is covered, the more the lens flare fades out. A larger radius covers more screen space and gradually fades in/out while passing behind objects in the foreground, while a small radius will cause the lens flare to quickly appear or disappear. The square can be visualized with rasterizer_lens_flares_occlusion_debug 1.

This also controls how far the test square is moved depending on the occlusion offset direction.

occlusion offset direction enum

Option Value Comments

toward viewer

0x0

The occlusion test square is moved towards the viewer by the occlusion radius. This avoids the test square being always half-embedded if the lens flare is placed directly on a surface.

However, this offsets the test square perpendicularly toward the camera's view plane, not toward the camera location itself. This results in test squares near the edges of the screen not aligning with their lens flares, causing them to fade out even while on-screen. Avoid setting this value too high to make this less apparent.

marker forward

0x1

The test square is moved in the "forward" direction of the marker by the occlusion radius, usually off the surface in the case of BSP lens flares.

none

0x2

The test square is not offset.

near fade distance

float

Unit: world units

far fade distance

float

Unit: world units

bitmap TagDependency: bitmap

flags bitfield

Flag	Mask	Comments
sun	`0x1`

rotation function enum

Option	Value	Comments
none	`0x0`
rotation a	`0x1`
rotation b	`0x2`
rotation translation	`0x3`
translation	`0x4`

rotation function scale

float

Default: 360

Yes, the default is indeed 360 radians.

horizontal scale

float

Default: 1

vertical scale

float

Default: 1

reflections

Block

HEK max count: 32

Field Type Comments

flags bitfield

Flag	Mask	Comments
align rotation with screen center	`0x1`
radius not scaled by distance	`0x2`
radius scaled by occlusion factor	`0x4`
occluded by solid objects	`0x8`

bitmap index uint16

position

float

Unit: along flare axis

rotation offset float

radius

Bounds

Unit: world units

Field	Type	Comments
min	`float`
max	`float`

radius scaled by enum

Option	Value	Comments
none	`0x0`
rotation	`0x1`
rotation and strafing	`0x2`
distance from center	`0x3`

brightness

Bounds

Min: 0
Max: 1

Field	Type	Comments
min	`float`
max	`float`

brightness scaled by enum^?

tint color ColorARGB

Field	Type	Comments
alpha	`float`
red	`float`
green	`float`
blue	`float`

color lower bound ColorARGB^?

color upper bound ColorARGB^?

more flags bitfield

Flag	Mask	Comments
interpolate colors in hsv	`0x1`
more colors	`0x2`

animation function enum

Option	Value	Comments
one	`0x0`
zero	`0x1`
cosine	`0x2`
cosine variable period	`0x3`
diagonal wave	`0x4`
diagonal wave variable period	`0x5`
slide	`0x6`
slide variable period	`0x7`
noise	`0x8`
jitter	`0x9`
wander	`0xA`
spark	`0xB`

animation period

float

Unit: world units
Default: 1

animation phase

float

Unit: world units

Acknowledgements

Thanks to the following individuals for their research or contributions to this topic:

Kavawuvi (Invader tag definitions)
MosesOfEgypt (Tag structure research)

lens_flare

Related HaloScript

Structure and fields

Acknowledgements