Skip to main content

Background

Enum Background 

Source
#[non_exhaustive]
pub enum Background { Color(Color), CubeTexture(CubeTexture), Node(NodeRef), Pmrem(PmremHandle), EnvironmentNode(EnvironmentNode), }
Expand description

Scene.background. three.js accepts a Color, a Texture or a CubeTexture; Background.update() branches on which one it is — a colour becomes the clear value, anything else becomes the skybox mesh.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Color(Color)

A flat clear colour.

§

CubeTexture(CubeTexture)

A skybox drawn from a cube texture.

§

Node(NodeRef)

scene.backgroundNode = … — Background.update()’s background.isNode branch, which draws the skybox sphere with vec4( node ).mul( backgroundIntensity ) instead of clearing. Held in the same slot because nodes.getBackgroundNode( scene ) || scene.background makes the node win over a plain background.

Any node, not just a color(): webgpu_skinning uses screenUV.y.mix( color( 0x66bbff ), color( 0x4466ff ) ).

§

Pmrem(PmremHandle)

scene.background = <the texture of a generated PMREM>.

Upstream this is the PMREM cube render target’s texture, flagged isPMREMTexture; NodeManager.getBackgroundNode() turns it into pmremTexture( background ) and Background.update() wraps that in the node branch’s context — getUV is backgroundRotation.mul( normalWorldGeometry ) and getTextureLevel is backgroundBlurriness. The port carries the handle rather than the texture, because the maxLod uniform the read needs travels with it; the renderer builds the node, so an application writes the one line the page does.

§

EnvironmentNode(EnvironmentNode)

scene.backgroundNode = <a graph of pmremTexture()s> — webgpu_cubemap_mix’s mix( pmremTexture( cube2 ), pmremTexture( cube1 ), … ). Background.update() builds it under the same context as Background::Pmrem.

Trait Implementations§

Source§

impl Clone for Background

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Background

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl From<Color> for Background

Source§

fn from(color: Color) -> Self

Converts to this type from the input type.
Source§

impl From<CubeTexture> for Background

Source§

fn from(texture: CubeTexture) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.