Skip to main content

GlRenderState

Struct GlRenderState 

Source
pub struct GlRenderState {
    pub depth: GlDepthState,
    pub blend: GlBlendState,
    pub cull: GlCullState,
    pub color_mask: GlColorMask,
    pub scissor: Option<GlScissor>,
    pub viewport: GlViewport,
}
Expand description

The whole fixed-function state of one draw, as a single Copy value.

The point of bundling these six fields into one struct is that it can be diffed field by field against the state currently bound, so WebGl2Backend::apply_state issues a GL call only for what actually changed. A renderer that calls enable, depthFunc, depthMask, blendFunc, blendEquation, cullFace, frontFace, colorMask, scissor, and viewport unconditionally pays for a dozen redundant calls per draw, each one a validation check inside the driver.

Fields§

§depth: GlDepthState

The depth-test state.

§blend: GlBlendState

The blend state.

§cull: GlCullState

The culling and winding state.

§color_mask: GlColorMask

Which channels the fragment stage may write.

§scissor: Option<GlScissor>

The scissor rectangle, or None when scissoring is off.

§viewport: GlViewport

The viewport rectangle.

Implementations§

Source§

impl GlRenderState

Implements default construction for the fixed-function state shadow.

Source

pub fn from_init(init: GlRenderStateInit) -> Self

Builds a render state from explicit field values.

context_defaults covers only the state a freshly created GL context happens to be in. Anything else – a depth-tested draw, a scissored viewport, a masked render target – has to be assembled field by field to reach apply_state, which without this is impossible from outside the crate.

§Arguments
  • GlRenderStateInit - The six fixed-function fields.
§Returns
  • GlRenderState - The assembled state.
Source

pub fn context_defaults(width: i32, height: i32) -> GlRenderState

Builds the state a freshly created WebGL 2 context is actually in.

Every value here is one the driver has already set up, not a zero placeholder, and that is the point: seeding the diffing shadow with the real defaults means the first WebGl2Backend::apply_state emits only the calls that genuinely differ from what the driver already did, rather than a dozen redundant re-assertions. Getting a single default wrong would instead leave one field permanently un-applied, because the diff would consider it unchanged forever.

Depth test off, depth write on, LEQUAL once enabled; blending off; culling off with counter-clockwise front faces; all four color channels writable; scissor off; viewport covering the given size.

§Arguments
  • i32 - The viewport width in pixels.
  • i32 - The viewport height in pixels.
§Returns
  • GlRenderState - The state a new context starts in.
Source§

impl GlRenderState

Trait Implementations§

Source§

impl Clone for GlRenderState

Source§

fn clone(&self) -> Self

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 Copy for GlRenderState

Source§

impl Debug for GlRenderState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for GlRenderState

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GlRenderState

Auto Trait Implementations§

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.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more