Skip to main content

Context

Struct Context 

Source
pub struct Context { /* private fields */ }
Expand description

Context for 2D (distance field) rendering

Implementations§

Source§

impl Context

Source

pub fn new(gpu: &Gpu) -> Self

Build a new 2D rendering context, given a device and queue

If render timestamps are desirable, then the device should be initialized with wgpu::Features::TIMESTAMP_QUERY.

Source

pub fn workspace(&self) -> Workspace

Builds a new Workspace object for use in rendering

The buffers are initialized with a dummy size and resized automatically when passed into any of the runner functions (e.g. run or submit).

Source

pub fn run( &self, shape: &RenderShape, workspace: &mut Workspace, out: &mut ReadBuffer<PixelBufferTag>, settings: RenderConfig, ) -> Result<Image, SubmitError>

Renders the image, with a blocking wait to read pixel data from the GPU

This function is not present when built for the wasm32 target

Source

pub fn run_with_vars( &self, shape: &RenderShape, vars: &ShapeVars<f32>, workspace: &mut Workspace, out: &mut ReadBuffer<PixelBufferTag>, settings: RenderConfig, ) -> Result<Image, SubmitError>

Renders the image, with a blocking wait to read pixel data from the GPU

This function is not present when built for the wasm32 target

Source

pub async fn run_async( &self, shape: &RenderShape, workspace: &mut Workspace, out: &mut ReadBuffer<PixelBufferTag>, settings: RenderConfig, ) -> Result<Image, SubmitError>

Renders the image, with an async wait to read pixel data from the GPU

Source

pub async fn run_with_vars_async( &self, shape: &RenderShape, vars: &ShapeVars<f32>, workspace: &mut Workspace, out: &mut ReadBuffer<PixelBufferTag>, settings: RenderConfig, ) -> Result<Image, SubmitError>

Renders the image, with an async wait to read pixel data from the GPU

Source

pub fn submit( &self, shape: &RenderShape, workspace: &mut Workspace, settings: &RenderConfig, ) -> Result<(), SubmitError>

Submits a single image to be rendered on the GPU

The resulting image (as a buffer of RawDistancePixel data) is available on the GPU in buffers.output().

Source

pub fn submit_with_vars( &self, shape: &RenderShape, vars: &ShapeVars<f32>, workspace: &mut Workspace, settings: &RenderConfig, ) -> Result<(), SubmitError>

Submits a single image to be rendered on the GPU, with extra variables

See submit for additional details.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>