Struct EffectsFrame 

#[non_exhaustive]
pub struct EffectsFrame {
    pub lighting: LightingSettings,
    pub clip_objects: Vec<ClipObject>,
    pub cap_fill_enabled: bool,
    pub post_process: PostProcessSettings,
    pub compute_filter_items: Vec<ComputeFilterItem>,
    pub environment: Option<EnvironmentMap>,
    pub ground_plane: GroundPlane,
}

Global rendering effects and modifiers for one frame.

Groups lighting, clipping, post-processing, compute filtering, and clip volumes : effects that apply globally across the scene rather than to individual objects.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

lighting: LightingSettings

Per-frame lighting configuration.

clip_objects: Vec<ClipObject>

Active clip objects (planes, boxes, spheres). Max 6 planes + 1 box/sphere. Default: empty (no clipping).

cap_fill_enabled: bool

Whether to render filled caps at clip plane cross-sections. Default: true.

post_process: PostProcessSettings

Optional post-processing settings. Default: disabled.

compute_filter_items: Vec<ComputeFilterItem>

GPU compute filter items dispatched before the render pass.

environment: Option<EnvironmentMap>

Optional environment map for IBL and skybox. Default: None.

ground_plane: GroundPlane

Ground plane configuration. Default: mode = None (not drawn, zero overhead).

Implementations

impl EffectsFrame

pub fn split(&self) -> (SceneEffects<'_>, ViewportEffects<'_>)

Decompose into scene-global and per-viewport effect references.

Both halves borrow from self and cannot outlive the EffectsFrame. The scene half is passed to [ViewportRenderer::prepare_scene]; the viewport half is passed to [ViewportRenderer::prepare_viewport].

Single-viewport callers can continue using [ViewportRenderer::prepare] directly without calling split().

Trait Implementations

impl Default for EffectsFrame

fn default() -> Self

Returns the “default value” for a type.