Struct Device 

pub struct Device {
    mem_allocator: Mutex<Allocator>,
    desc_allocator: Mutex<DescriptorAllocator>,
    valid_ash_memory_types: u32,
    naga_options: Options<'static>,
    counters: Arc<HalCounters>,
    shared: Arc<DeviceShared>,
}

Fields

mem_allocator: Mutex<Allocator>

desc_allocator: Mutex<DescriptorAllocator>

valid_ash_memory_types: u32

naga_options: Options<'static>

counters: Arc<HalCounters>

shared: Arc<DeviceShared>

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.

fn find_memory_type_index( &self, type_bits_req: u32, flags_req: MemoryPropertyFlags, ) -> Option<usize>

fn create_image_without_memory( &self, desc: &TextureDescriptor<'_>, external_memory_image_create_info: Option<&mut ExternalMemoryImageCreateInfo<'_>>, ) -> Result<ImageWithoutMemory, DeviceError>

fn create_image_without_memory_with_tiling( &self, desc: &TextureDescriptor<'_>, tiling: ImageTiling, external_memory_image_create_info: Option<&mut ExternalMemoryImageCreateInfo<'_>>, drm_modifier_info: Option<&mut ImageDrmFormatModifierExplicitCreateInfoEXT<'_>>, ) -> Result<ImageWithoutMemory, DeviceError>

pub unsafe fn texture_from_dmabuf_fd( &self, fd: OwnedFd, desc: &TextureDescriptor<'_>, drm_modifier: u64, stride: u64, offset: u64, ) -> Result<Texture, DeviceError>

Import a DMA-buf as a texture. Currently only supports single-plane DMA-bufs.

Safety

• Requires VULKAN_EXTERNAL_MEMORY_DMA_BUF feature (implies VK_EXT_external_memory_dma_buf and VK_EXT_image_drm_format_modifier)
• The fd must be a valid DMA-buf file descriptor matching desc
• On success, Vulkan takes ownership of the file descriptor. On failure, the file descriptor is closed.
• The drm_modifier, stride, and offset must match the DMA-buf layout

fn import_dmabuf_memory( &self, external_memory_fd_fn: &Device, fd_raw: i32, image: Image, requirements: &MemoryRequirements, ) -> Result<DeviceMemory, DeviceError>

Import DMA-buf memory and bind it to the image.

On failure, the raw fd is closed (if not yet consumed by Vulkan) and the caller is responsible for destroying the VkImage.

fn create_shader_module_impl( &self, spv: &[u32], label: &Label<'_>, ) -> Result<ShaderModule, DeviceError>

fn compile_stage( &self, stage: &ProgrammableStage<'_, ShaderModule>, naga_stage: ShaderStage, binding_map: &BindingMap, ) -> Result<CompiledStage, PipelineError>

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

fn get_memory_properties(&self) -> Option<MemoryProperties>

fn error_if_would_oom_on_resource_allocation( &self, location: MemoryLocation, requirements: &MemoryRequirements, ) -> Result<(), DeviceError>

Predict whether a proposed allocation will result in an OOM condition.

If so, returns Err(crate::DeviceError::OutOfMemory). If not, returns Ok(()).

The prediction quality depends on accurately selecting the heap that gpu_allocator will use for the allocation, and is subject to deteriorate if the logic in gpu_allocator changes.

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_ray_tracing_pipeline( &self, desc: &RayTracingPipelineDescriptor<'_, PipelineLayout, ShaderModule, PipelineCache>, ) -> Result<RayTracingPipeline, PipelineError>

unsafe fn destroy_ray_tracing_pipeline(&self, pipeline: RayTracingPipeline)

unsafe fn get_raytracing_pipeline_group_data( &self, pipeline: &RayTracingPipeline, groups: Range<u32>, ) -> Result<Vec<u8>, DeviceError>

Obtain the opaque data from each group, behaves as if group 0 is the ray generation, group 1 is the miss shader, and group 2.. are the intersection groups.

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