Header menu logo Mibo

LightDraw Module

Pipe-friendly DSL for lighting commands. Each function takes a RenderBuffer2D as the last argument, adds the command, and returns the buffer for chaining.

Functions and values

Function or value Description

addDirectionalLight lightCtx layer light buffer

Full Usage: addDirectionalLight lightCtx layer light buffer

Parameters:
Returns: RenderBuffer2D
Modifiers: inline

Adds a directional light.

lightCtx : LightContext2D
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
light : DirectionalLight2D
buffer : RenderBuffer2D
Returns: RenderBuffer2D

addOccluder lightCtx layer occluder buffer

Full Usage: addOccluder lightCtx layer occluder buffer

Parameters:
Returns: RenderBuffer2D
Modifiers: inline

Adds an occluder segment.

lightCtx : LightContext2D
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
occluder : Occluder2D
buffer : RenderBuffer2D
Returns: RenderBuffer2D

addPointLight lightCtx layer light buffer

Full Usage: addPointLight lightCtx layer light buffer

Parameters:
Returns: RenderBuffer2D
Modifiers: inline

Adds a point light.

lightCtx : LightContext2D
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
light : PointLight2D
buffer : RenderBuffer2D
Returns: RenderBuffer2D

disableShadows lightCtx layer buffer

Full Usage: disableShadows lightCtx layer buffer

Parameters:
Returns: RenderBuffer2D
Modifiers: inline

Disables shadows.

lightCtx : LightContext2D
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
buffer : RenderBuffer2D
Returns: RenderBuffer2D

enableShadows lightCtx layer buffer

Full Usage: enableShadows lightCtx layer buffer

Parameters:
Returns: RenderBuffer2D
Modifiers: inline

Enables shadows.

lightCtx : LightContext2D
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
buffer : RenderBuffer2D
Returns: RenderBuffer2D

endLighting lightCtx layer buffer

Full Usage: endLighting lightCtx layer buffer

Parameters:
Returns: RenderBuffer2D
Modifiers: inline

Ends the current lighting block.

lightCtx : LightContext2D
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
buffer : RenderBuffer2D
Returns: RenderBuffer2D

litAnimatedSprite lightCtx layer dest animSprite buffer

Full Usage: litAnimatedSprite lightCtx layer dest animSprite buffer

Parameters:
Returns: RenderBuffer2D
Modifiers: inline

Draws a lit animated sprite.

lightCtx : LightContext2D
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
dest : Rectangle
animSprite : AnimatedSprite
buffer : RenderBuffer2D
Returns: RenderBuffer2D

litSprite lightCtx sprite buffer

Full Usage: litSprite lightCtx sprite buffer

Parameters:
Returns: RenderBuffer2D
Modifiers: inline

Draws a lit sprite.

lightCtx : LightContext2D
sprite : SpriteState
buffer : RenderBuffer2D
Returns: RenderBuffer2D

setAmbient lightCtx (layer, ambient) buffer

Full Usage: setAmbient lightCtx (layer, ambient) buffer

Parameters:
Returns: RenderBuffer2D
Modifiers: inline

Sets the ambient light color.

lightCtx : LightContext2D
layer : int<MeasureProduct<RenderLayer, MeasureOne>>
ambient : AmbientLight2D
buffer : RenderBuffer2D
Returns: RenderBuffer2D

Type something to start searching.