Struct Device

pub struct Device { /* private fields */ }

Available on vulkan only.

Implementations

impl Device

pub unsafe fn texture_from_raw( vk_image: Image, desc: &TextureDescriptor<'_>, drop_guard: Option<DropGuard>, ) -> Texture

Safety

• vk_image must be created respecting desc
• If drop_guard is Some, the application must manually destroy the image handle. This can be done inside the Drop impl of drop_guard.
• If the ImageCreateFlags does not contain MUTABLE_FORMAT, the view_formats of desc must be empty.

pub unsafe fn buffer_from_raw(vk_buffer: Buffer) -> Buffer

Safety

• vk_buffer’s memory must be managed by the caller
• Externally imported buffers can’t be mapped by wgpu

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 exit(self, queue: Queue)

Exit connection to this logical device.

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

Creates a new buffer.

unsafe fn destroy_buffer(&self, buffer: Buffer)

unsafe fn map_buffer( &self, buffer: &Buffer, range: MemoryRange, ) -> Result<BufferMapping, DeviceError>

unsafe fn unmap_buffer(&self, buffer: &Buffer) -> Result<(), DeviceError>

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

where I: Iterator<Item = MemoryRange>,

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

where I: Iterator<Item = MemoryRange>,

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

Creates a new texture.

unsafe fn destroy_texture(&self, texture: 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<'_, Api>, ) -> Result<CommandEncoder, DeviceError>

Create a fresh CommandEncoder.

unsafe fn destroy_command_encoder(&self, cmd_encoder: 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<'_, Api>, ) -> Result<PipelineLayout, DeviceError>

unsafe fn destroy_pipeline_layout(&self, pipeline_layout: PipelineLayout)

unsafe fn create_bind_group( &self, desc: &BindGroupDescriptor<'_, Api>, ) -> 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<'_, Api>, ) -> Result<RenderPipeline, PipelineError>

unsafe fn destroy_render_pipeline(&self, pipeline: RenderPipeline)

unsafe fn create_compute_pipeline( &self, desc: &ComputePipelineDescriptor<'_, Api>, ) -> Result<ComputePipeline, PipelineError>

unsafe fn destroy_compute_pipeline(&self, pipeline: ComputePipeline)

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_ms: u32, ) -> Result<bool, DeviceError>

Wait for fence to reach value.

unsafe fn start_capture(&self) -> bool

unsafe fn stop_capture(&self)

unsafe fn get_acceleration_structure_build_sizes<'a>( &self, desc: &GetAccelerationStructureBuildSizesDescriptor<'a, Api>, ) -> 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, )