Struct wgpu_hal::vulkan::Device

source ·
pub struct Device {
    shared: Arc<DeviceShared>,
    mem_allocator: Mutex<GpuAllocator<DeviceMemory>>,
    desc_allocator: Mutex<DescriptorAllocator<DescriptorPool, DescriptorSet>>,
    valid_ash_memory_types: u32,
    naga_options: Options<'static>,
    counters: HalCounters,
}

Fields§

§shared: Arc<DeviceShared>§mem_allocator: Mutex<GpuAllocator<DeviceMemory>>§desc_allocator: Mutex<DescriptorAllocator<DescriptorPool, DescriptorSet>>§valid_ash_memory_types: u32§naga_options: Options<'static>§counters: HalCounters

Implementations§

source§

impl Device

source

pub(super) unsafe fn create_swapchain( &self, surface: &Surface, config: &SurfaceConfiguration, provided_old_swapchain: Option<Swapchain>, ) -> Result<Swapchain, SurfaceError>

source

pub unsafe fn texture_from_raw( vk_image: Image, desc: &TextureDescriptor<'_>, drop_callback: Option<DropCallback>, ) -> 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.
source

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
source

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

source

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

source

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

source

pub fn queue_index(&self) -> u32

source

pub fn raw_device(&self) -> &Device

source

pub fn raw_physical_device(&self) -> PhysicalDevice

source

pub fn raw_queue(&self) -> Queue

source

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

source

pub fn shared_instance(&self) -> &InstanceShared

Trait Implementations§

source§

impl Device for Device

§

type A = Api

source§

unsafe fn exit(self, queue: Queue)

Exit connection to this logical device.
source§

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

Creates a new buffer. Read more
source§

unsafe fn destroy_buffer(&self, buffer: Buffer)

Free buffer and any GPU resources it owns. Read more
source§

unsafe fn add_raw_buffer(&self, _buffer: &Buffer)

A hook for when a wgpu-core buffer is created from a raw wgpu-hal buffer.
source§

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

Return a pointer to CPU memory mapping the contents of buffer. Read more
source§

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

Remove the mapping established by the last call to Device::map_buffer. Read more
source§

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. Read more
source§

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. Read more
source§

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

Creates a new texture. Read more
source§

unsafe fn destroy_texture(&self, texture: Texture)

source§

unsafe fn add_raw_texture(&self, _texture: &Texture)

A hook for when a wgpu-core texture is created from a raw wgpu-hal texture.
source§

unsafe fn create_texture_view( &self, texture: &Texture, desc: &TextureViewDescriptor<'_>, ) -> Result<TextureView, DeviceError>

source§

unsafe fn destroy_texture_view(&self, view: TextureView)

source§

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

source§

unsafe fn destroy_sampler(&self, sampler: Sampler)

source§

unsafe fn create_command_encoder( &self, desc: &CommandEncoderDescriptor<'_, Queue>, ) -> Result<CommandEncoder, DeviceError>

Create a fresh CommandEncoder. Read more
source§

unsafe fn destroy_command_encoder(&self, cmd_encoder: CommandEncoder)

source§

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

Creates a bind group layout.
source§

unsafe fn destroy_bind_group_layout(&self, bg_layout: BindGroupLayout)

source§

unsafe fn create_pipeline_layout( &self, desc: &PipelineLayoutDescriptor<'_, BindGroupLayout>, ) -> Result<PipelineLayout, DeviceError>

source§

unsafe fn destroy_pipeline_layout(&self, pipeline_layout: PipelineLayout)

source§

unsafe fn create_bind_group( &self, desc: &BindGroupDescriptor<'_, BindGroupLayout, Buffer, Sampler, TextureView, AccelerationStructure>, ) -> Result<BindGroup, DeviceError>

source§

unsafe fn destroy_bind_group(&self, group: BindGroup)

source§

unsafe fn create_shader_module( &self, desc: &ShaderModuleDescriptor<'_>, shader: ShaderInput<'_>, ) -> Result<ShaderModule, ShaderError>

source§

unsafe fn destroy_shader_module(&self, module: ShaderModule)

source§

unsafe fn create_render_pipeline( &self, desc: &RenderPipelineDescriptor<'_, PipelineLayout, ShaderModule, PipelineCache>, ) -> Result<RenderPipeline, PipelineError>

source§

unsafe fn destroy_render_pipeline(&self, pipeline: RenderPipeline)

source§

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

source§

unsafe fn destroy_compute_pipeline(&self, pipeline: ComputePipeline)

source§

unsafe fn create_pipeline_cache( &self, desc: &PipelineCacheDescriptor<'_>, ) -> Result<PipelineCache, PipelineCacheError>

source§

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

source§

unsafe fn destroy_pipeline_cache(&self, cache: PipelineCache)

source§

unsafe fn create_query_set( &self, desc: &QuerySetDescriptor<Label<'_>>, ) -> Result<QuerySet, DeviceError>

source§

unsafe fn destroy_query_set(&self, set: QuerySet)

source§

unsafe fn create_fence(&self) -> Result<Fence, DeviceError>

source§

unsafe fn destroy_fence(&self, fence: Fence)

source§

unsafe fn get_fence_value( &self, fence: &Fence, ) -> Result<FenceValue, DeviceError>

source§

unsafe fn wait( &self, fence: &Fence, wait_value: FenceValue, timeout_ms: u32, ) -> Result<bool, DeviceError>

Wait for fence to reach value. Read more
source§

unsafe fn start_capture(&self) -> bool

source§

unsafe fn stop_capture(&self)

source§

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

source§

unsafe fn get_acceleration_structure_build_sizes<'a>( &self, desc: &GetAccelerationStructureBuildSizesDescriptor<'a, Buffer>, ) -> AccelerationStructureBuildSizes

source§

unsafe fn get_acceleration_structure_device_address( &self, acceleration_structure: &AccelerationStructure, ) -> BufferAddress

source§

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

source§

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

source§

fn get_internal_counters(&self) -> HalCounters

source§

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

source§

impl DynResource for Device

source§

fn as_any(&self) -> &dyn Any

source§

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

Auto Trait Implementations§

§

impl !Freeze for Device

§

impl !RefUnwindSafe for Device

§

impl Send for Device

§

impl Sync for Device

§

impl Unpin for Device

§

impl !UnwindSafe for Device

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<D> DynDevice for D
where D: Device + DynResource,

source§

unsafe fn exit(self: Box<D>, queue: Box<dyn DynQueue>)

source§

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

source§

unsafe fn destroy_buffer(&self, buffer: Box<dyn DynBuffer>)

source§

unsafe fn add_raw_buffer(&self, buffer: &(dyn DynBuffer + 'static))

source§

unsafe fn map_buffer( &self, buffer: &(dyn DynBuffer + 'static), range: Range<u64>, ) -> Result<BufferMapping, DeviceError>

source§

unsafe fn unmap_buffer(&self, buffer: &(dyn DynBuffer + 'static))

source§

unsafe fn flush_mapped_ranges( &self, buffer: &(dyn DynBuffer + 'static), ranges: &[Range<u64>], )

source§

unsafe fn invalidate_mapped_ranges( &self, buffer: &(dyn DynBuffer + 'static), ranges: &[Range<u64>], )

source§

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

source§

unsafe fn destroy_texture(&self, texture: Box<dyn DynTexture>)

source§

unsafe fn add_raw_texture(&self, texture: &(dyn DynTexture + 'static))

source§

unsafe fn create_texture_view( &self, texture: &(dyn DynTexture + 'static), desc: &TextureViewDescriptor<'_>, ) -> Result<Box<dyn DynTextureView>, DeviceError>

source§

unsafe fn destroy_texture_view(&self, view: Box<dyn DynTextureView>)

source§

unsafe fn create_sampler( &self, desc: &SamplerDescriptor<'_>, ) -> Result<Box<dyn DynSampler>, DeviceError>

source§

unsafe fn destroy_sampler(&self, sampler: Box<dyn DynSampler>)

source§

unsafe fn create_command_encoder( &self, desc: &CommandEncoderDescriptor<'_, dyn DynQueue>, ) -> Result<Box<dyn DynCommandEncoder>, DeviceError>

source§

unsafe fn destroy_command_encoder(&self, encoder: Box<dyn DynCommandEncoder>)

source§

unsafe fn create_bind_group_layout( &self, desc: &BindGroupLayoutDescriptor<'_>, ) -> Result<Box<dyn DynBindGroupLayout>, DeviceError>

source§

unsafe fn destroy_bind_group_layout( &self, bg_layout: Box<dyn DynBindGroupLayout>, )

source§

unsafe fn create_pipeline_layout( &self, desc: &PipelineLayoutDescriptor<'_, dyn DynBindGroupLayout>, ) -> Result<Box<dyn DynPipelineLayout>, DeviceError>

source§

unsafe fn destroy_pipeline_layout( &self, pipeline_layout: Box<dyn DynPipelineLayout>, )

source§

unsafe fn create_bind_group( &self, desc: &BindGroupDescriptor<'_, dyn DynBindGroupLayout, dyn DynBuffer, dyn DynSampler, dyn DynTextureView, dyn DynAccelerationStructure>, ) -> Result<Box<dyn DynBindGroup>, DeviceError>

source§

unsafe fn destroy_bind_group(&self, group: Box<dyn DynBindGroup>)

source§

unsafe fn create_shader_module( &self, desc: &ShaderModuleDescriptor<'_>, shader: ShaderInput<'_>, ) -> Result<Box<dyn DynShaderModule>, ShaderError>

source§

unsafe fn destroy_shader_module(&self, module: Box<dyn DynShaderModule>)

source§

unsafe fn create_render_pipeline( &self, desc: &RenderPipelineDescriptor<'_, dyn DynPipelineLayout, dyn DynShaderModule, dyn DynPipelineCache>, ) -> Result<Box<dyn DynRenderPipeline>, PipelineError>

source§

unsafe fn destroy_render_pipeline(&self, pipeline: Box<dyn DynRenderPipeline>)

source§

unsafe fn create_compute_pipeline( &self, desc: &ComputePipelineDescriptor<'_, dyn DynPipelineLayout, dyn DynShaderModule, dyn DynPipelineCache>, ) -> Result<Box<dyn DynComputePipeline>, PipelineError>

source§

unsafe fn destroy_compute_pipeline(&self, pipeline: Box<dyn DynComputePipeline>)

source§

unsafe fn create_pipeline_cache( &self, desc: &PipelineCacheDescriptor<'_>, ) -> Result<Box<dyn DynPipelineCache>, PipelineCacheError>

source§

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

source§

unsafe fn destroy_pipeline_cache( &self, pipeline_cache: Box<dyn DynPipelineCache>, )

source§

unsafe fn create_query_set( &self, desc: &QuerySetDescriptor<Option<&str>>, ) -> Result<Box<dyn DynQuerySet>, DeviceError>

source§

unsafe fn destroy_query_set(&self, query_set: Box<dyn DynQuerySet>)

source§

unsafe fn create_fence(&self) -> Result<Box<dyn DynFence>, DeviceError>

source§

unsafe fn destroy_fence(&self, fence: Box<dyn DynFence>)

source§

unsafe fn get_fence_value( &self, fence: &(dyn DynFence + 'static), ) -> Result<u64, DeviceError>

source§

unsafe fn wait( &self, fence: &(dyn DynFence + 'static), value: u64, timeout_ms: u32, ) -> Result<bool, DeviceError>

source§

unsafe fn start_capture(&self) -> bool

source§

unsafe fn stop_capture(&self)

source§

unsafe fn pipeline_cache_get_data( &self, cache: &(dyn DynPipelineCache + 'static), ) -> Option<Vec<u8>>

source§

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

source§

unsafe fn get_acceleration_structure_build_sizes( &self, desc: &GetAccelerationStructureBuildSizesDescriptor<'_, dyn DynBuffer>, ) -> AccelerationStructureBuildSizes

source§

unsafe fn get_acceleration_structure_device_address( &self, acceleration_structure: &(dyn DynAccelerationStructure + 'static), ) -> u64

source§

unsafe fn destroy_acceleration_structure( &self, acceleration_structure: Box<dyn DynAccelerationStructure>, )

source§

fn get_internal_counters(&self) -> HalCounters

source§

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

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where 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, U> TryFrom<U> for T
where 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 T
where 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> Upcast<T> for T

source§

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

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,