Struct Context

pub struct Context { /* private fields */ }

Contains the adapter, device, queue, RenderTarget and configuration.

A Context is created to initialize rendering to a window, canvas or texture.

use renderling::context::Context;

let ctx = futures_lite::future::block_on(Context::headless(100, 100));

Implementations

impl Context

pub fn new( target: RenderTarget, adapter: impl Into<Arc<Adapter>>, device: impl Into<Arc<Device>>, queue: impl Into<Arc<Queue>>, ) -> Self

Creates a new Context with the specified target, adapter, device, and queue.

pub async fn try_new_headless( width: u32, height: u32, backends: Option<Backends>, ) -> Result<Self, ContextError>

Attempts to create a new headless Context with the specified width, height, and backends.

pub async fn try_new_with_surface( width: u32, height: u32, backends: Option<Backends>, window: impl Into<SurfaceTarget<'static>>, ) -> Result<Self, ContextError>

Attempts to create a new Context with a surface, using the specified width, height, backends, and window.

pub async fn from_winit_window( backends: Option<Backends>, window: Arc<Window>, ) -> Self

Create a Context from an existing [winit::window::Window].

Panics

Panics if the context could not be created.

pub async fn headless(width: u32, height: u32) -> Self

Creates a new headless renderer.

Immediately proxies to Context::try_new_headless and unwraps.

Panics

This function will panic if an adapter cannot be found. For example, this would happen on machines without a GPU.

pub fn get_size(&self) -> UVec2

pub fn set_size(&mut self, size: UVec2)

Sets the size of the render target.

pub fn create_texture<P>( &self, label: Option<&str>, img: &ImageBuffer<P, Vec<u8>>, ) -> Result<Texture, TextureError>

where P: PixelWithColorType, ImageBuffer<P, Vec<u8>>: GenericImage + Deref<Target = [u8]>,

Creates a texture from an image buffer.

pub fn texture_from_wgpu_tex( &self, texture: impl Into<Arc<Texture>>, sampler: Option<SamplerDescriptor<'_>>, ) -> Texture

Creates a Texture from a wgpu::Texture and an optional sampler.

pub fn runtime(&self) -> &WgpuRuntime

Returns a reference to the WgpuRuntime.

pub fn get_device(&self) -> &Device

Returns a reference to the wgpu::Device.

pub fn get_queue(&self) -> &Queue

Returns a reference to the wgpu::Queue.

pub fn get_adapter(&self) -> &Adapter

Returns a reference to the wgpu::Adapter.

pub fn get_adapter_owned(&self) -> Arc<Adapter>

Returns the adapter in an owned wrapper.

pub fn get_render_target(&self) -> &RenderTarget

Returns a reference to the RenderTarget.

pub fn get_next_frame(&self) -> Result<Frame, ContextError>

Gets the next frame from the render target.

A surface context (window or canvas) will return the next swapchain texture.

A headless context will return the underlying headless texture.

Errors

Errs if the render target is a surface and there was an error getting the next swapchain texture. This can happen if the frame has already been acquired.

pub fn set_default_atlas_texture_size(&self, size: impl Into<UVec3>) -> &Self

Sets the default texture size for the material atlas.

• Width is size.x and must be a power of two.
• Height is size.y, must match size.x and must be a power of two.
• Layers is size.z and must be two or greater.

pub fn with_default_atlas_texture_size(self, size: impl Into<UVec3>) -> Self

Sets the default texture size for the material atlas.

• Width is size.x and must be a power of two.
• Height is size.y, must match size.x and must be a power of two.
• Layers is size.z and must be greater than zero.

Panics

Will panic if the above conditions are not met.

pub fn set_shadow_mapping_atlas_texture_size( &self, size: impl Into<UVec3>, ) -> &Self

Sets the default texture size for the shadow mapping atlas.

• Width is size.x and must be a power of two.
• Height is size.y, must match size.x and must be a power of two.
• Layers is size.z and must be two or greater.

pub fn with_shadow_mapping_atlas_texture_size( self, size: impl Into<UVec3>, ) -> Self

Sets the default texture size for the shadow mapping atlas.

• Width is size.x and must be a power of two.
• Height is size.y, must match size.x and must be a power of two.
• Layers is size.z and must be greater than zero.

Panics

Will panic if the above conditions are not met.

pub fn set_use_direct_draw(&self, use_direct_drawing: bool)

Sets the use of direct drawing.

Default is false.

If set to true, all compute culling, including frustum and occlusion culling, will not run.

pub fn with_use_direct_draw(self, use_direct_drawing: bool) -> Self

Sets the use of direct drawing.

Default is false.

If set to true, all compute culling is turned off. This includes frustum and occlusion culling.

pub fn get_use_direct_draw(&self) -> bool

Returns whether direct drawing is used.

pub fn new_stage(&self) -> Stage

Creates and returns a new Stage renderer.

pub fn new_ui(&self) -> Ui

Creates and returns a new Ui renderer.

Trait Implementations

impl AsRef<WgpuRuntime> for Context

fn as_ref(&self) -> &WgpuRuntime

Converts this type into a shared reference of the (usually inferred) input type.