effect-motion
API ReferencethreeNamespacesSceneFunctions

getBackground

function getBackground(self): Texture<unknown, TextureEventMap> | Color | null;

Function: getBackground()

function getBackground(self): Texture<unknown, TextureEventMap> | Color | null;

Defined in: packages/three/src/Scene.ts:172

Read the current background so a temporary coverage pass can restore it.

Parameters

ParameterType
selfScene

Returns

Texture<unknown, TextureEventMap> | Color | null

On this page