Struct Device
pub struct Device { /* private fields */ }Available on crate feature
unstable-wgpu-28 and gles only.Implementations§
§impl Device
impl Device
pub fn context(&self) -> &AdapterContext
pub fn context(&self) -> &AdapterContext
Returns the underlying EGL context.
§impl Device
impl Device
pub unsafe fn texture_from_raw(
&self,
name: NonZero<u32>,
desc: &TextureDescriptor<'_>,
drop_callback: Option<Box<dyn FnOnce() + Sync + Send>>,
) -> Texture
Available on native or Emscripten only.
pub unsafe fn texture_from_raw( &self, name: NonZero<u32>, desc: &TextureDescriptor<'_>, drop_callback: Option<Box<dyn FnOnce() + Sync + Send>>, ) -> Texture
native or Emscripten only.pub unsafe fn texture_from_raw_renderbuffer(
&self,
name: NonZero<u32>,
desc: &TextureDescriptor<'_>,
drop_callback: Option<Box<dyn FnOnce() + Sync + Send>>,
) -> Texture
Available on native or Emscripten only.
pub unsafe fn texture_from_raw_renderbuffer( &self, name: NonZero<u32>, desc: &TextureDescriptor<'_>, drop_callback: Option<Box<dyn FnOnce() + Sync + Send>>, ) -> Texture
native or Emscripten only.Trait Implementations§
§impl Device for Device
impl Device for Device
type A = Api
§unsafe fn create_buffer(
&self,
desc: &BufferDescriptor<'_>,
) -> Result<Buffer, DeviceError>
unsafe fn create_buffer( &self, desc: &BufferDescriptor<'_>, ) -> Result<Buffer, DeviceError>
Creates a new buffer. Read more
§unsafe fn destroy_buffer(&self, buffer: Buffer)
unsafe fn destroy_buffer(&self, buffer: Buffer)
Free
buffer and any GPU resources it owns. Read more§unsafe fn add_raw_buffer(&self, _buffer: &Buffer)
unsafe fn add_raw_buffer(&self, _buffer: &Buffer)
A hook for when a wgpu-core buffer is created from a raw wgpu-hal buffer.
§unsafe fn map_buffer(
&self,
buffer: &Buffer,
range: Range<u64>,
) -> Result<BufferMapping, DeviceError>
unsafe fn map_buffer( &self, buffer: &Buffer, range: Range<u64>, ) -> Result<BufferMapping, DeviceError>
Return a pointer to CPU memory mapping the contents of
buffer. Read more§unsafe fn unmap_buffer(&self, buffer: &Buffer)
unsafe fn unmap_buffer(&self, buffer: &Buffer)
Remove the mapping established by the last call to
Device::map_buffer. Read more§unsafe fn flush_mapped_ranges<I>(&self, buffer: &Buffer, ranges: I)
unsafe fn flush_mapped_ranges<I>(&self, buffer: &Buffer, ranges: I)
Indicate that CPU writes to mapped buffer memory should be made visible to the GPU. Read more
§unsafe fn invalidate_mapped_ranges<I>(&self, _buffer: &Buffer, _ranges: I)
unsafe fn invalidate_mapped_ranges<I>(&self, _buffer: &Buffer, _ranges: I)
Indicate that GPU writes to mapped buffer memory should be made visible to the CPU. Read more
§unsafe fn create_texture(
&self,
desc: &TextureDescriptor<'_>,
) -> Result<Texture, DeviceError>
unsafe fn create_texture( &self, desc: &TextureDescriptor<'_>, ) -> Result<Texture, DeviceError>
Creates a new texture. Read more
unsafe fn destroy_texture(&self, texture: Texture)
§unsafe fn add_raw_texture(&self, _texture: &Texture)
unsafe fn add_raw_texture(&self, _texture: &Texture)
A hook for when a wgpu-core texture is created from a raw wgpu-hal texture.
unsafe fn create_texture_view( &self, texture: &Texture, desc: &TextureViewDescriptor<'_>, ) -> Result<TextureView, DeviceError>
unsafe fn destroy_texture_view(&self, _view: TextureView)
unsafe fn create_sampler( &self, desc: &SamplerDescriptor<'_>, ) -> Result<Sampler, DeviceError>
unsafe fn destroy_sampler(&self, sampler: Sampler)
§unsafe fn create_command_encoder(
&self,
_desc: &CommandEncoderDescriptor<'_, Queue>,
) -> Result<CommandEncoder, DeviceError>
unsafe fn create_command_encoder( &self, _desc: &CommandEncoderDescriptor<'_, Queue>, ) -> Result<CommandEncoder, DeviceError>
Create a fresh
CommandEncoder. Read more§unsafe fn create_bind_group_layout(
&self,
desc: &BindGroupLayoutDescriptor<'_>,
) -> Result<BindGroupLayout, DeviceError>
unsafe fn create_bind_group_layout( &self, desc: &BindGroupLayoutDescriptor<'_>, ) -> Result<BindGroupLayout, DeviceError>
Creates a bind group layout.
unsafe fn destroy_bind_group_layout(&self, _bg_layout: BindGroupLayout)
unsafe fn create_pipeline_layout( &self, desc: &PipelineLayoutDescriptor<'_, BindGroupLayout>, ) -> Result<PipelineLayout, DeviceError>
unsafe fn destroy_pipeline_layout(&self, _pipeline_layout: PipelineLayout)
unsafe fn create_bind_group( &self, desc: &BindGroupDescriptor<'_, BindGroupLayout, Buffer, Sampler, TextureView, AccelerationStructure>, ) -> Result<BindGroup, DeviceError>
unsafe fn destroy_bind_group(&self, _group: BindGroup)
unsafe fn create_shader_module( &self, desc: &ShaderModuleDescriptor<'_>, shader: ShaderInput<'_>, ) -> Result<ShaderModule, ShaderError>
unsafe fn destroy_shader_module(&self, _module: ShaderModule)
unsafe fn create_render_pipeline( &self, desc: &RenderPipelineDescriptor<'_, PipelineLayout, ShaderModule, PipelineCache>, ) -> Result<RenderPipeline, PipelineError>
unsafe fn destroy_render_pipeline(&self, pipeline: RenderPipeline)
unsafe fn create_compute_pipeline( &self, desc: &ComputePipelineDescriptor<'_, PipelineLayout, ShaderModule, PipelineCache>, ) -> Result<ComputePipeline, PipelineError>
unsafe fn destroy_compute_pipeline(&self, pipeline: ComputePipeline)
unsafe fn create_pipeline_cache( &self, _: &PipelineCacheDescriptor<'_>, ) -> Result<PipelineCache, PipelineCacheError>
unsafe fn destroy_pipeline_cache(&self, _: PipelineCache)
unsafe fn create_query_set( &self, desc: &QuerySetDescriptor<Option<&str>>, ) -> Result<QuerySet, DeviceError>
unsafe fn destroy_query_set(&self, set: QuerySet)
unsafe fn create_fence(&self) -> Result<Fence, DeviceError>
unsafe fn destroy_fence(&self, fence: Fence)
unsafe fn get_fence_value(&self, fence: &Fence) -> Result<u64, DeviceError>
§unsafe fn wait(
&self,
fence: &Fence,
wait_value: u64,
timeout: Option<Duration>,
) -> Result<bool, DeviceError>
unsafe fn wait( &self, fence: &Fence, wait_value: u64, timeout: Option<Duration>, ) -> Result<bool, DeviceError>
§unsafe fn start_graphics_debugger_capture(&self) -> bool
unsafe fn start_graphics_debugger_capture(&self) -> bool
Start a graphics debugger capture. Read more
§unsafe fn stop_graphics_debugger_capture(&self)
unsafe fn stop_graphics_debugger_capture(&self)
Stop a graphics debugger capture. Read more
unsafe fn create_acceleration_structure( &self, _desc: &AccelerationStructureDescriptor<'_>, ) -> Result<AccelerationStructure, DeviceError>
unsafe fn get_acceleration_structure_build_sizes<'a>( &self, _desc: &GetAccelerationStructureBuildSizesDescriptor<'a, Buffer>, ) -> AccelerationStructureBuildSizes
unsafe fn get_acceleration_structure_device_address( &self, _acceleration_structure: &AccelerationStructure, ) -> u64
unsafe fn destroy_acceleration_structure( &self, _acceleration_structure: AccelerationStructure, )
fn tlas_instance_to_bytes(&self, _instance: TlasInstance) -> Vec<u8> ⓘ
fn get_internal_counters(&self) -> HalCounters
fn check_if_oom(&self) -> Result<(), DeviceError>
fn pipeline_cache_validation_key(&self) -> Option<[u8; 16]>
unsafe fn pipeline_cache_get_data( &self, cache: &<Self::A as Api>::PipelineCache, ) -> Option<Vec<u8>>
fn generate_allocator_report(&self) -> Option<AllocatorReport>
§impl DynResource for Device
impl DynResource for Device
impl Send for Device
Available on
send_sync only.impl Sync for Device
Available on
send_sync only.Auto Trait Implementations§
impl Freeze for Device
impl !RefUnwindSafe for Device
impl Unpin for Device
impl !UnwindSafe for Device
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
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.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
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.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<D> DynDevice for Dwhere
D: Device + DynResource,
impl<D> DynDevice for Dwhere
D: Device + DynResource,
unsafe fn create_buffer( &self, desc: &BufferDescriptor<'_>, ) -> Result<Box<dyn DynBuffer>, DeviceError>
unsafe fn destroy_buffer(&self, buffer: Box<dyn DynBuffer>)
unsafe fn add_raw_buffer(&self, buffer: &(dyn DynBuffer + 'static))
unsafe fn map_buffer( &self, buffer: &(dyn DynBuffer + 'static), range: Range<u64>, ) -> Result<BufferMapping, DeviceError>
unsafe fn unmap_buffer(&self, buffer: &(dyn DynBuffer + 'static))
unsafe fn flush_mapped_ranges( &self, buffer: &(dyn DynBuffer + 'static), ranges: &[Range<u64>], )
unsafe fn invalidate_mapped_ranges( &self, buffer: &(dyn DynBuffer + 'static), ranges: &[Range<u64>], )
unsafe fn create_texture( &self, desc: &TextureDescriptor<'_>, ) -> Result<Box<dyn DynTexture>, DeviceError>
unsafe fn destroy_texture(&self, texture: Box<dyn DynTexture>)
unsafe fn add_raw_texture(&self, texture: &(dyn DynTexture + 'static))
unsafe fn create_texture_view( &self, texture: &(dyn DynTexture + 'static), desc: &TextureViewDescriptor<'_>, ) -> Result<Box<dyn DynTextureView>, DeviceError>
unsafe fn destroy_texture_view(&self, view: Box<dyn DynTextureView>)
unsafe fn create_sampler( &self, desc: &SamplerDescriptor<'_>, ) -> Result<Box<dyn DynSampler>, DeviceError>
unsafe fn destroy_sampler(&self, sampler: Box<dyn DynSampler>)
unsafe fn create_command_encoder( &self, desc: &CommandEncoderDescriptor<'_, dyn DynQueue>, ) -> Result<Box<dyn DynCommandEncoder>, DeviceError>
unsafe fn create_bind_group_layout( &self, desc: &BindGroupLayoutDescriptor<'_>, ) -> Result<Box<dyn DynBindGroupLayout>, DeviceError>
unsafe fn destroy_bind_group_layout( &self, bg_layout: Box<dyn DynBindGroupLayout>, )
unsafe fn create_pipeline_layout( &self, desc: &PipelineLayoutDescriptor<'_, dyn DynBindGroupLayout>, ) -> Result<Box<dyn DynPipelineLayout>, DeviceError>
unsafe fn destroy_pipeline_layout( &self, pipeline_layout: Box<dyn DynPipelineLayout>, )
unsafe fn create_bind_group( &self, desc: &BindGroupDescriptor<'_, dyn DynBindGroupLayout, dyn DynBuffer, dyn DynSampler, dyn DynTextureView, dyn DynAccelerationStructure>, ) -> Result<Box<dyn DynBindGroup>, DeviceError>
unsafe fn destroy_bind_group(&self, group: Box<dyn DynBindGroup>)
unsafe fn create_shader_module( &self, desc: &ShaderModuleDescriptor<'_>, shader: ShaderInput<'_>, ) -> Result<Box<dyn DynShaderModule>, ShaderError>
unsafe fn destroy_shader_module(&self, module: Box<dyn DynShaderModule>)
unsafe fn create_render_pipeline( &self, desc: &RenderPipelineDescriptor<'_, dyn DynPipelineLayout, dyn DynShaderModule, dyn DynPipelineCache>, ) -> Result<Box<dyn DynRenderPipeline>, PipelineError>
unsafe fn destroy_render_pipeline(&self, pipeline: Box<dyn DynRenderPipeline>)
unsafe fn create_compute_pipeline( &self, desc: &ComputePipelineDescriptor<'_, dyn DynPipelineLayout, dyn DynShaderModule, dyn DynPipelineCache>, ) -> Result<Box<dyn DynComputePipeline>, PipelineError>
unsafe fn destroy_compute_pipeline(&self, pipeline: Box<dyn DynComputePipeline>)
unsafe fn create_pipeline_cache( &self, desc: &PipelineCacheDescriptor<'_>, ) -> Result<Box<dyn DynPipelineCache>, PipelineCacheError>
fn pipeline_cache_validation_key(&self) -> Option<[u8; 16]>
unsafe fn destroy_pipeline_cache( &self, pipeline_cache: Box<dyn DynPipelineCache>, )
unsafe fn create_query_set( &self, desc: &QuerySetDescriptor<Option<&str>>, ) -> Result<Box<dyn DynQuerySet>, DeviceError>
unsafe fn destroy_query_set(&self, query_set: Box<dyn DynQuerySet>)
unsafe fn create_fence(&self) -> Result<Box<dyn DynFence>, DeviceError>
unsafe fn destroy_fence(&self, fence: Box<dyn DynFence>)
unsafe fn get_fence_value( &self, fence: &(dyn DynFence + 'static), ) -> Result<u64, DeviceError>
unsafe fn wait( &self, fence: &(dyn DynFence + 'static), value: u64, timeout: Option<Duration>, ) -> Result<bool, DeviceError>
unsafe fn start_graphics_debugger_capture(&self) -> bool
unsafe fn stop_graphics_debugger_capture(&self)
unsafe fn pipeline_cache_get_data( &self, cache: &(dyn DynPipelineCache + 'static), ) -> Option<Vec<u8>>
unsafe fn create_acceleration_structure( &self, desc: &AccelerationStructureDescriptor<'_>, ) -> Result<Box<dyn DynAccelerationStructure>, DeviceError>
unsafe fn get_acceleration_structure_build_sizes( &self, desc: &GetAccelerationStructureBuildSizesDescriptor<'_, dyn DynBuffer>, ) -> AccelerationStructureBuildSizes
unsafe fn get_acceleration_structure_device_address( &self, acceleration_structure: &(dyn DynAccelerationStructure + 'static), ) -> u64
unsafe fn destroy_acceleration_structure( &self, acceleration_structure: Box<dyn DynAccelerationStructure>, )
fn tlas_instance_to_bytes(&self, instance: TlasInstance) -> Vec<u8> ⓘ
fn get_internal_counters(&self) -> HalCounters
fn generate_allocator_report(&self) -> Option<AllocatorReport>
fn check_if_oom(&self) -> Result<(), DeviceError>
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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§impl<T> Pointable for T
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.