pub struct RenderDevice { /* private fields */ }
Expand description

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

Implementations§

source§

impl RenderDevice

source

pub fn features(&self) -> Features

List all Features that may be used with this device.

Functions may panic if you use unsupported features.

source

pub fn limits(&self) -> Limits

List all Limits that were requested of this device.

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

source

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

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

source

pub fn poll(&self, maintain: Maintain) -> bool

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.

source

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

Creates an empty CommandEncoder.

source

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

Creates an empty RenderBundleEncoder.

source

pub fn create_bind_group(&self, desc: &BindGroupDescriptor<'_>) -> BindGroup

Creates a new BindGroup.

source

pub fn create_bind_group_layout( &self, desc: &BindGroupLayoutDescriptor<'_> ) -> BindGroupLayout

Creates a BindGroupLayout.

source

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

Creates a PipelineLayout.

source

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

Creates a RenderPipeline.

source

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

Creates a ComputePipeline.

source

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

Creates a Buffer.

source

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

Creates a Buffer and initializes it with the specified data.

source

pub fn create_texture_with_data( &self, render_queue: &RenderQueue, desc: &TextureDescriptor<'_>, 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.

source

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

Creates a new Texture.

desc specifies the general format of the texture.

source

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

Creates a new Sampler.

desc specifies the behavior of the sampler.

source

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

pub fn wgpu_device(&self) -> &Device

Returns the wgpu Device.

source

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

source

pub fn align_copy_bytes_per_row(row_bytes: usize) -> usize

source

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

Trait Implementations§

source§

impl Clone for RenderDevice

source§

fn clone(&self) -> RenderDevice

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl From<Device> for RenderDevice

source§

fn from(device: Device) -> Self

Converts to this type from the input type.
source§

impl Resource for RenderDevicewhere Self: Send + Sync + 'static,

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,

source§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

source§

impl<T> Downcast for Twhere T: Any,

source§

fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T, Global>) -> Arc<dyn Any + Send + Sync, Global>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere 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 Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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> TypeData for Twhere T: 'static + Send + Sync + Clone,

§

impl<T> Upcast<T> for T

§

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

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more