gfx.env.set_background_mode

Client

Sets the background mode of the environment


Syntax

local status = gfx.env.set_background_mode(
    mode
)

Parameters

TypeNameDescription
gfx.env.background_modemodeBackground mode to apply

Returns

TypeNameDescription
boolstatustrue on successful execution, false otherwise

Examples

Set environment background mode to sky
gfx.env.set_background_mode(gfx.env.background_mode.SKY)

On this page