Struct ViewportFrame 

#[non_exhaustive]
pub struct ViewportFrame {
    pub background_colour: Option<[f32; 4]>,
    pub wireframe_mode: bool,
    pub show_grid: bool,
    pub grid_cell_size: f32,
    pub grid_half_extent: f32,
    pub grid_z: f32,
    pub grid_colour: Option<[f32; 3]>,
    pub show_axes_indicator: bool,
    pub force_cluster_fallback: bool,
    pub cluster_stats_request: bool,
}

Viewport presentation settings for one frame.

Groups background, grid, and axes indicator : the viewport chrome that is independent of world-space content.

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.

background_colour: Option<[f32; 4]>

Optional background/clear colour [r, g, b, a]. None = adapter default.

wireframe_mode: bool

Whether to render the scene in wireframe mode. Default: false.

show_grid: bool

Whether to render the ground-plane grid. Default: false.

grid_cell_size: f32

Grid cell size in world units. Zero = camera-distance-based adaptive spacing.

grid_half_extent: f32

Half-extent of the grid in world units. Zero = 1000 (effectively infinite).

grid_z: f32

World-space Z coordinate of the grid plane (3D mode only, Z-up). Default: 0.0.

grid_colour: Option<[f32; 3]>

RGB colour for the grid lines. None = renderer default (mid-grey).

show_axes_indicator: bool

Whether to draw the axes orientation indicator overlay. Default: true.

force_cluster_fallback: bool

Force every lit pipeline to take the straight-iteration light loop even when the active light count is above the cluster-build threshold. Set this and the clustered path renders pixels identical to the path the renderer would take with one or two lights, which lets a consumer A/B against the clustered path to spot bugs. Default: false.

cluster_stats_request: bool

Trigger a host-visible readback of the cluster cell array at the end of prepare_scene. The result is exposed via ViewportRenderer::cluster_stats. The readback blocks the calling thread on a device poll, so leave this off unless a debug panel is actively displaying the numbers. Default: false.

Trait Implementations

impl Default for ViewportFrame

fn default() -> Self

Returns the “default value” for a type.