Struct RenderDevice

pub struct RenderDevice { /* private fields */ }

This GPU device is responsible for the creation of most rendering and compute resources.

Implementations

impl RenderDevice

pub fn new(device: WgpuWrapper<Device>) -> Self

pub fn features(&self) -> Features

List all Features that may be used with this device.

Functions may panic if you use unsupported features.

pub fn limits(&self) -> Limits

List all Limits that were requested of this device.

If any of these limits are exceeded, functions may panic.

pub unsafe fn create_shader_module( &self, desc: ShaderModuleDescriptor<'_>, ) -> ShaderModule

Creates a ShaderModule from either SPIR-V or WGSL source code.

Safety

Creates a shader module with user-customizable runtime checks which allows shaders to perform operations which can lead to undefined behavior like indexing out of bounds, To avoid UB, ensure any unchecked shaders are sound! This method should never be called for user-supplied shaders.

pub fn create_and_validate_shader_module( &self, desc: ShaderModuleDescriptor<'_>, ) -> ShaderModule

Creates and validates a ShaderModule from either SPIR-V or WGSL source code.

See ValidateShader for more information on the tradeoffs involved with shader validation.

pub fn poll(&self, maintain: PollType) -> Result<PollStatus, PollError>

Check for resource cleanups and mapping callbacks.

Return true if the queue is empty, or false if there are more queue submissions still in flight. (Note that, unless access to the wgpu::Queue is coordinated somehow, this information could be out of date by the time the caller receives it. Queues can be shared between threads, so other threads could submit new work at any time.)

no-op on the web, device is automatically polled.

pub fn create_command_encoder( &self, desc: &CommandEncoderDescriptor<'_>, ) -> CommandEncoder

Creates an empty CommandEncoder.

pub fn create_render_bundle_encoder( &self, desc: &RenderBundleEncoderDescriptor<'_>, ) -> RenderBundleEncoder<'_>

Creates an empty RenderBundleEncoder.

pub fn create_bind_group<'a>( &self, label: impl Into<Label<'a>>, layout: &'a BindGroupLayout, entries: &'a [BindGroupEntry<'a>], ) -> BindGroup

Creates a new BindGroup.

pub fn create_bind_group_layout<'a>( &self, label: impl Into<Label<'a>>, entries: &'a [BindGroupLayoutEntry], ) -> BindGroupLayout

Creates a BindGroupLayout.

pub fn create_pipeline_layout( &self, desc: &PipelineLayoutDescriptor<'_>, ) -> PipelineLayout

Creates a PipelineLayout.

pub fn create_render_pipeline( &self, desc: &RawRenderPipelineDescriptor<'_>, ) -> RenderPipeline

Creates a RenderPipeline.

pub fn create_compute_pipeline( &self, desc: &ComputePipelineDescriptor<'_>, ) -> ComputePipeline

Creates a ComputePipeline.

pub fn create_buffer(&self, desc: &BufferDescriptor<'_>) -> Buffer

Creates a Buffer.

pub fn create_buffer_with_data(&self, desc: &BufferInitDescriptor<'_>) -> Buffer

Creates a Buffer and initializes it with the specified data.

pub fn create_texture_with_data( &self, render_queue: &RenderQueue, desc: &TextureDescriptor<'_>, order: TextureDataOrder, data: &[u8], ) -> Texture

Creates a new Texture and initializes it with the specified data.

desc specifies the general format of the texture. data is the raw data.

pub fn create_texture(&self, desc: &TextureDescriptor<'_>) -> Texture

Creates a new Texture.

desc specifies the general format of the texture.

pub fn create_sampler(&self, desc: &SamplerDescriptor<'_>) -> Sampler

Creates a new Sampler.

desc specifies the behavior of the sampler.

pub fn configure_surface( &self, surface: &Surface<'_>, config: &SurfaceConfiguration, )

Initializes Surface for presentation.

Panics

• A old SurfaceTexture is still alive referencing an old surface.
• Texture format requested is unsupported on the surface.

pub fn wgpu_device(&self) -> &Device

Returns the wgpu Device.

pub fn map_buffer( &self, buffer: &BufferSlice<'_>, map_mode: MapMode, callback: impl FnOnce(Result<(), BufferAsyncError>) + Send + 'static, )

pub const fn align_copy_bytes_per_row(row_bytes: usize) -> usize

pub fn get_supported_read_only_binding_type( &self, buffers_per_shader_stage: u32, ) -> BufferBindingType

Trait Implementations

impl Clone for RenderDevice

fn clone(&self) -> RenderDevice

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<Device> for RenderDevice

fn from(device: Device) -> Self

Converts to this type from the input type.

impl Resource for RenderDevice

where Self: Send + Sync + 'static,