Struct FrameData 

#[non_exhaustive]
pub struct FrameData {
    pub camera: CameraFrame,
    pub scene: SceneFrame,
    pub viewport: ViewportFrame,
    pub interaction: InteractionFrame,
    pub effects: EffectsFrame,
    pub overlays: OverlayFrame,
}

All data needed to render one frame of the viewport.

Fields are grouped by responsibility. Build the sub-objects you need, leave others at their Default, then call prepare() followed by paint() or paint_to().

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.

camera: CameraFrame

Camera state, viewport size, and viewport slot.

scene: SceneFrame

World-space scene content (surfaces, point clouds, glyphs, etc.).

viewport: ViewportFrame

Viewport presentation settings (background, grid, axes indicator).

interaction: InteractionFrame

Interaction and selection visualization (gizmo, outline, x-ray).

effects: EffectsFrame

Global rendering effects (lighting, clipping, post-process).

overlays: OverlayFrame

Semantic overlays rendered after post-processing (labels, scalar bars, rulers).

Implementations

impl FrameData

pub fn new(camera: CameraFrame, scene: SceneFrame) -> Self

Build frame data from the required camera and scene groups.

pub fn from_scene( camera: CameraFrame, scene: &mut Scene, selection: &Selection, ) -> Self

Build frame data from a camera, scene, and selection in one call.

This is the preferred constructor for the common single-viewport path. It collects render items, stamps the scene and selection generation counters, and leaves viewport chrome and effects at their defaults.

Override individual settings with the builder methods:

let frame = FrameData::from_scene(
    CameraFrame::from_camera(&camera, [w, h]),
    &mut scene,
    &selection,
)
.with_background([0.1, 0.1, 0.12, 1.0])
.with_lighting(lighting);

pub fn with_background(self, colour: [f32; 4]) -> Self

Set the viewport background clear colour.

pub fn with_lighting(self, lighting: LightingSettings) -> Self

Override the per-frame lighting configuration.

pub fn with_post_process(self, post: PostProcessSettings) -> Self

Override the post-processing settings.

pub fn with_ground_plane(self, ground: GroundPlane) -> Self

Override the ground plane configuration.

Trait Implementations

impl Default for FrameData

fn default() -> Self

Returns the “default value” for a type.