Skip to main content

RenderConfig

Struct RenderConfig 

Source
pub struct RenderConfig {
    pub backend: RenderBackendType,
    pub canvas_selector: String,
    pub width: f64,
    pub height: f64,
    pub quality: RenderQuality,
    pub antialias: bool,
    pub power_preference: GpuPowerPreference,
    pub ssaa_scale_factor: f64,
}
Expand description

Rendering configuration controlling the backend type, canvas target, viewport dimensions, quality, and backend-specific options.

Passed as part of EngineConfig when instantiating the engine.

Fields§

§backend: RenderBackendType

The rendering backend to use (Canvas 2D or WebGPU).

§canvas_selector: String

The CSS selector used to query the canvas element from the DOM.

§width: f64

The logical viewport width in CSS pixels.

§height: f64

The logical viewport height in CSS pixels.

§quality: RenderQuality

The rendering quality preset for canvas smoothing and SSAA downscaling.

§antialias: bool

Whether MSAA anti-aliasing is enabled for the WebGPU backend.

Ignored when backend is Canvas2D.

§power_preference: GpuPowerPreference

The power preference hint for WebGPU adapter selection.

Ignored when backend is Canvas2D.

§ssaa_scale_factor: f64

The SSAA supersampling scale factor for the Canvas 2D backend.

A value of 2.0 renders at 4x resolution and downscales for smoother edges. Ignored when backend is WebGpu.

Implementations§

Source§

impl RenderConfig

Implements construction helpers for RenderConfig.

Source

pub fn canvas2d<S>(canvas_selector: S, width: f64, height: f64) -> RenderConfig
where S: AsRef<str>,

Creates a rendering configuration for the Canvas 2D backend.

§Arguments
  • S - The CSS selector for the canvas element.
  • f64 - The viewport width in CSS pixels.
  • f64 - The viewport height in CSS pixels.
§Returns
  • RenderConfig - The Canvas 2D rendering configuration.
Source

pub fn webgpu<S>(canvas_selector: S, width: f64, height: f64) -> RenderConfig
where S: AsRef<str>,

Creates a rendering configuration for the WebGPU backend.

§Arguments
  • S - The CSS selector for the canvas element.
  • f64 - The viewport width in CSS pixels.
  • f64 - The viewport height in CSS pixels.
§Returns
  • RenderConfig - The WebGPU rendering configuration.
Source

pub fn webgl<S>(canvas_selector: S, width: f64, height: f64) -> RenderConfig
where S: AsRef<str>,

Creates a rendering configuration for the WebGL 2 backend.

§Arguments
  • S - The CSS selector for the canvas element.
  • f64 - The viewport width in CSS pixels.
  • f64 - The viewport height in CSS pixels.
§Returns
  • RenderConfig - The WebGL 2 rendering configuration.
Source§

impl RenderConfig

Source§

impl RenderConfig

Source

pub fn new( backend: RenderBackendType, canvas_selector: String, width: f64, height: f64, ) -> Self

Trait Implementations§

Source§

impl Clone for RenderConfig

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 Debug for RenderConfig

Source§

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

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

impl Default for RenderConfig

Implements Default for RenderConfig with sensible default values.

Source§

fn default() -> RenderConfig

Constructs a default RenderConfig value.

§Returns
  • RenderConfig - A default-constructed instance with the documented initial state.
Source§

impl PartialEq for RenderConfig

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 RenderConfig

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