Struct ViewportRect 

pub struct ViewportRect {
    pub x: f32,
    pub y: f32,
    pub width: f32,
    pub height: f32,
    pub min_depth: f32,
    pub max_depth: f32,
}

The region of the render target a scene draws into, in pixels.

Fragments outside it are discarded and the clip space a pipeline writes is stretched across it, which is what letterboxes a scene whose own aspect differs from its target’s: the projection keeps the scene’s aspect, and the viewport places the result inside the target without distortion.

Unlike ScissorRect, which clips in whole pixels, a viewport is fractional — a centred letterbox rarely lands on a pixel boundary — so its fields are floats. It is pass state with no reset call, so see Scene::viewport.

Fields

x: f32

Left edge, in pixels.

y: f32

Top edge, in pixels.

width: f32

Width in pixels.

height: f32

Height in pixels.

min_depth: f32

The depth the near plane of the viewport’s clip space maps to.

max_depth: f32

The depth the far plane of the viewport’s clip space maps to.

Implementations

impl ViewportRect

pub fn new(width: f32, height: f32) -> Self

A rectangle covering width x height pixels from the origin, over the whole 0.0..=1.0 depth range.

pub fn at(self, x: f32, y: f32) -> Self

Same rectangle, with its origin moved to (x, y).

pub fn with_depth(self, min_depth: f32, max_depth: f32) -> Self

Same rectangle, mapped over min_depth..=max_depth instead of the whole depth range.

pub fn fit_aspect(aspect: f32, target_width: u32, target_height: u32) -> Self

The largest rectangle of aspect that fits inside a target_width x target_height target, centred.

This is the letterbox: a target wider than aspect gets a rectangle spanning the full height with bars at the sides, a narrower one spans the full width with bars above and below, and the rectangle’s own aspect is aspect either way — so content drawn through it is scaled uniformly, showing the same picture on any target shape rather than being stretched to the target’s.

A degenerate target, or an aspect that is not a positive finite number, has no rectangle to fit, so the whole target comes back rather than a zero-sized region.

Trait Implementations

impl Clone for ViewportRect

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ViewportRect

impl Debug for ViewportRect

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

Formats the value using the given formatter.

impl PartialEq for ViewportRect

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ViewportRect