Skip to main content

FrameParams

Struct FrameParams 

Source
pub struct FrameParams<'a> {
    pub elapsed: f32,
    pub fov_y_radians: f32,
    pub near: f32,
    pub far: f32,
    pub cam_pos: [f32; 3],
    pub text_calls: &'a [TextDrawCall],
    pub lines: &'a [LineVertex],
    pub world_hidden: bool,
    pub view_mode: ViewMode,
    pub show: ShowFlags,
    pub sky_rot: [[f32; 4]; 3],
}
Expand description

Per-frame inputs for RenderBackend::draw_frame. world_hidden is set when an opaque menu backdrop covers the scene: the backend skips every world pass and presents only the overlay (text_calls) over a cleared target.

Fields§

§elapsed: f32

Seconds since the world started, for time-driven effects.

§fov_y_radians: f32

Vertical field of view in radians.

§near: f32

Near clip distance in world units.

§far: f32

Far clip distance in world units.

§cam_pos: [f32; 3]

World-space camera position.

§text_calls: &'a [TextDrawCall]

Overlay draw calls for this frame.

§lines: &'a [LineVertex]

Expanded line ribbons (lines::build_vertices) for this frame’s camera, drawn depth-tested into the scene after the world passes. Empty on any frame that submits no lines, which also drops the pass from the graph.

§world_hidden: bool

true when an opaque menu backdrop covers the scene.

§view_mode: ViewMode

Viewport view mode + show flags for the frame (ViewOverrides when the editor publishes one, defaults otherwise). Backends run their seeded graph inputs through render_graph::apply_view and steer the composite by the mode.

§show: ShowFlags

Feature passes to run this frame.

§sky_rot: [[f32; 4]; 3]

Rows of the rotation taking a world-space direction into the environment cubemaps’ baked frame (SkyOrientation::sample_rows). The backend holds it for the frame and uploads it into every uniform block whose pass samples the sky, so the sky, the IBL and the reflections turn together. Identity in a world with no SkyRotation.

Trait Implementations§

Source§

impl<'a> Clone for FrameParams<'a>

Source§

fn clone(&self) -> FrameParams<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for FrameParams<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for FrameParams<'a>

§

impl<'a> RefUnwindSafe for FrameParams<'a>

§

impl<'a> Send for FrameParams<'a>

§

impl<'a> Sync for FrameParams<'a>

§

impl<'a> Unpin for FrameParams<'a>

§

impl<'a> UnsafeUnpin for FrameParams<'a>

§

impl<'a> UnwindSafe for FrameParams<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.