Struct BackgroundSettings 

pub struct BackgroundSettings { /* private fields */ }

Background rendering configuration (mode + automatic uniform version control).

Wraps BackgroundMode together with a CpuBuffer<SkyboxParamsUniforms> whose version is automatically bumped only when setter methods write new values. The render pass only calls ensure_buffer_id() — no per-frame buffer writes occur in the render pipeline.

Usage

// Set mode (automatically syncs uniform values)
scene.background.set_mode(BackgroundMode::equirectangular(tex, 1.0));

// Fine-tune individual parameters
scene.background.set_rotation(0.5);
scene.background.set_intensity(2.0);

Implementations

impl BackgroundSettings

pub fn mode(&self) -> &BackgroundMode

Returns a reference to the current background mode.

pub fn set_mode(&mut self, mode: BackgroundMode)

Sets the background mode and syncs uniform values accordingly.

The CpuBuffer version is bumped only if the derived uniform values actually differ from the current state.

pub fn set_rotation(&mut self, rotation: f32)

Sets the Y-axis rotation (radians) for texture-based backgrounds.

Also updates the rotation field inside BackgroundMode::Texture to keep the enum and buffer in sync.

pub fn set_intensity(&mut self, intensity: f32)

Sets the brightness/exposure multiplier for texture-based backgrounds.

Also updates the intensity field inside BackgroundMode::Texture to keep the enum and buffer in sync.

pub fn set_gradient_colors(&mut self, top: Vec4, bottom: Vec4)

Sets gradient colors (top and bottom).

Switches the mode to Gradient if it isn’t already.

pub fn clear_color(&self) -> Color

Returns the clear color for the RenderPass.

pub fn needs_skybox_pass(&self) -> bool

Returns true if the current mode requires a skybox draw call.

Trait Implementations

impl Clone for BackgroundSettings

fn clone(&self) -> BackgroundSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BackgroundSettings

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

Formats the value using the given formatter.

impl Default for BackgroundSettings

fn default() -> BackgroundSettings

Returns the “default value” for a type.