Struct Context 

pub struct Context { /* private fields */ }

Context for 3D (combined heightmap and normal) rendering

Implementations

impl Context

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

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

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).

pub fn run( &self, shape: &RenderShape, workspace: &mut Workspace, out: &mut ReadBuffer<GeomBufferTag>, 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

pub fn run_with_vars( &self, shape: &RenderShape, vars: &ShapeVars<f32>, workspace: &mut Workspace, out: &mut ReadBuffer<GeomBufferTag>, 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

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

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

This can be called either natively or on the web

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

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

This can be called either natively or on the web

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 GeometryPixel data) is available on the GPU in workspace.output().

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.

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

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

See submit for additional details.