Struct Device 

pub struct Device { /* private fields */ }

Available on vulkan only.

Implementations

impl Device

pub unsafe fn texture_from_raw( &self, vk_image: Image, desc: &TextureDescriptor<'_>, drop_callback: Option<DropCallback>, memory: TextureMemory, ) -> Texture

Safety

• vk_image must be created respecting desc
• If drop_callback is None, wgpu-hal will take ownership of vk_image. If drop_callback is Some, vk_image must be valid until the callback is called.
• If the ImageCreateFlags does not contain MUTABLE_FORMAT, the view_formats of desc must be empty.
• If memory is not super::TextureMemory::External, wgpu-hal will take ownership of the memory (which is presumed to back vk_image). Otherwise, the memory must remain valid until drop_callback is called.

pub fn queue_family_index(&self) -> u32

Returns the queue family index of the device’s internal queue.

This is useful for constructing memory barriers needed for queue family ownership transfer when external memory is involved (from/to VK_QUEUE_FAMILY_EXTERNAL_KHR and VK_QUEUE_FAMILY_FOREIGN_EXT for example).

pub fn queue_index(&self) -> u32

pub fn raw_device(&self) -> &Device

pub fn raw_physical_device(&self) -> PhysicalDevice

pub fn raw_queue(&self) -> Queue

pub fn enabled_device_extensions(&self) -> &[&'static CStr]

pub fn shared_instance(&self) -> &InstanceShared

Trait Implementations

impl Device for Device

type A = Api

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

Creates a new buffer.

unsafe fn destroy_buffer(&self, buffer: Buffer)

Free buffer and any GPU resources it owns.

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: MemoryRange, ) -> Result<BufferMapping, DeviceError>

Return a pointer to CPU memory mapping the contents of buffer.

unsafe fn unmap_buffer(&self, buffer: &Buffer)

Remove the mapping established by the last call to Device::map_buffer.

unsafe fn flush_mapped_ranges<I>(&self, buffer: &Buffer, ranges: I)

where I: Iterator<Item = MemoryRange>,

Indicate that CPU writes to mapped buffer memory should be made visible to the GPU.

unsafe fn invalidate_mapped_ranges<I>(&self, buffer: &Buffer, ranges: I)

where I: Iterator<Item = MemoryRange>,

Indicate that GPU writes to mapped buffer memory should be made visible to the CPU.

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

Creates a new texture.

unsafe fn destroy_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>

Create a fresh CommandEncoder.

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, desc: &PipelineCacheDescriptor<'_>, ) -> Result<PipelineCache, PipelineCacheError>

fn pipeline_cache_validation_key(&self) -> Option<[u8; 16]>

unsafe fn destroy_pipeline_cache(&self, cache: PipelineCache)

unsafe fn create_query_set( &self, desc: &QuerySetDescriptor<Label<'_>>, ) -> 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<FenceValue, DeviceError>

unsafe fn wait( &self, fence: &Fence, wait_value: FenceValue, timeout: Option<Duration>, ) -> Result<bool, DeviceError>

Wait for fence to reach value.

unsafe fn start_graphics_debugger_capture(&self) -> bool

Start a graphics debugger capture.

unsafe fn stop_graphics_debugger_capture(&self)

Stop a graphics debugger capture.

unsafe fn pipeline_cache_get_data( &self, cache: &PipelineCache, ) -> Option<Vec<u8>>

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, ) -> BufferAddress

unsafe fn create_acceleration_structure( &self, desc: &AccelerationStructureDescriptor<'_>, ) -> Result<AccelerationStructure, DeviceError>

unsafe fn destroy_acceleration_structure( &self, acceleration_structure: AccelerationStructure, )

fn get_internal_counters(&self) -> HalCounters

fn generate_allocator_report(&self) -> Option<AllocatorReport>

fn tlas_instance_to_bytes(&self, instance: TlasInstance) -> Vec<u8>

fn check_if_oom(&self) -> Result<(), DeviceError>

impl Drop for Device

fn drop(&mut self)

Executes the destructor for this type.

impl DynResource for Device

fn as_any(&self) -> &dyn Any

fn as_any_mut(&mut self) -> &mut dyn Any