gfx.env.set_background_color

Client

Sets the background color of the environment


Syntax

local status = gfx.env.set_background_color(
    color
)
local status = gfx.env.set_background_color(
    hex
)

Parameters

TypeNameDescription
colorcolorBackground color as {r, g, b, a}
stringhexAlternatively, a valid HTML hex color string (e.g. "#ffffff")

Returns

TypeNameDescription
boolstatustrue on successful execution, false otherwise

Examples

Set environment background color using a color table
gfx.env.set_background_color({0.1, 0.2, 0.4, 1.0})
Set environment background color using a hex string
gfx.env.set_background_color("#1a3366")

On this page