Skip to main content

Device

Struct Device 

Source
pub struct Device {
    shared: Arc<AdapterShared>,
    main_vao: VertexArray,
    render_doc: RenderDoc,
    counters: Arc<HalCounters>,
}
Available on gles only.

Fields§

§shared: Arc<AdapterShared>§main_vao: VertexArray§render_doc: RenderDoc
Available on native and crate feature renderdoc only.
§counters: Arc<HalCounters>

Implementations§

Source§

impl Device

Source

pub unsafe fn texture_from_raw( &self, name: NonZeroU32, desc: &TextureDescriptor<'_>, drop_callback: Option<DropCallback>, ) -> Texture

Available on native or Emscripten only.
§Safety
  • name must be created respecting desc
  • name must be a texture
  • If drop_callback is None, wgpu-hal will take ownership of the texture. If drop_callback is Some, the texture must be valid until the callback is called.
Source

pub unsafe fn texture_from_raw_renderbuffer( &self, name: NonZeroU32, desc: &TextureDescriptor<'_>, drop_callback: Option<DropCallback>, ) -> Texture

Available on native or Emscripten only.
§Safety
  • name must be created respecting desc
  • name must be a renderbuffer
  • If drop_callback is None, wgpu-hal will take ownership of the renderbuffer. If drop_callback is Some, the renderbuffer must be valid until the callback is called.
Source

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

Available on Unix and native only.

Imports a single-plane DMA-BUF as a GLES GL_TEXTURE_2D without copying. None for drm_modifier requests an implicit layout. The supplied FD is closed on both success and failure. The EGL image is destroyed after binding; the GL texture retains the imported storage.

§Errors

Returns ImportTextureError if the texture configuration is unsupported, an import parameter does not fit EGLint, required EGL resources, extensions or entry points are unavailable, or a GL or EGL operation fails.

§Safety
  • fd, drm_format, stride, offset and drm_modifier must describe the same DMA-BUF allocation.
  • desc must be valid (consider calling wgpu_core::Device::validate_texture_descriptor) and must accurately describe the texture being imported (including drm_format)
  • Only one 2D plane, one array layer, one mip level and one sample are currently supported.
  • Synchronization with the DMA-BUF producer must be handled separately.
Source

pub unsafe fn buffer_from_raw( &self, name: NonZeroU32, desc: &BufferDescriptor<'_>, drop_callback: Option<DropCallback>, ) -> Buffer

Available on native or Emscripten only.
§Safety
  • name must be a non-zero GL buffer name created respecting desc.
  • The buffer’s storage size must be at least desc.size.
  • If desc.usage includes BufferUses::MAP_READ or BufferUses::MAP_WRITE, the GL buffer must have been allocated with glBufferStorage (or equivalent) using flags compatible with persistent mapping (GL_MAP_PERSISTENT_BIT plus matching read/write/coherent bits). Buffers created with the legacy glBufferData family cannot be mapped through this path.
  • If drop_callback is None, wgpu-hal will take ownership of the buffer and call glDeleteBuffers on it. If drop_callback is Some, the buffer must remain valid until the callback is invoked.
Source

unsafe fn compile_shader( gl: &Context, shader: &str, naga_stage: ShaderStage, label: Option<&str>, ) -> Result<Shader, PipelineError>

Source

fn create_shader( gl: &Context, naga_stage: ShaderStage, stage: &ProgrammableStage<'_, ShaderModule>, context: CompilationContext<'_>, program: Program, ) -> Result<Shader, PipelineError>

Source

unsafe fn create_pipeline<'a>( &self, gl: &Context, shaders: ArrayVec<(ShaderStage, &'a ProgrammableStage<'a, ShaderModule>), { crate::MAX_CONCURRENT_SHADER_STAGES }>, layout: &PipelineLayout, label: Option<&str>, multiview_mask: Option<NonZeroU32>, ) -> Result<Arc<PipelineInner>, PipelineError>

Source

fn create_constant_hash(stage: &ProgrammableStage<'_, ShaderModule>) -> Vec<u8> ⓘ

Source

unsafe fn create_program<'a>( gl: &Context, shaders: ArrayVec<(ShaderStage, &'a ProgrammableStage<'a, ShaderModule>), { crate::MAX_CONCURRENT_SHADER_STAGES }>, layout: &PipelineLayout, label: Option<&str>, multiview_mask: Option<NonZeroU32>, glsl_version: Version, private_caps: PrivateCapabilities, ) -> Result<Arc<PipelineInner>, PipelineError>

Source§

impl Device

Source

pub fn context(&self) -> &AdapterContext

Available on non-webgl and (non-Windows or windows_angle) only.

Returns the underlying EGL context.

Trait Implementations§

Source§

impl Debug for Device

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Device for Device

Source§

type A = Api

Source§

unsafe fn create_buffer( &self, desc: &BufferDescriptor<'_>, ) -> Result<(Buffer, BufferAddress), 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)

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

Create a render pipeline according to desc. Read more
Source§

unsafe fn destroy_render_pipeline(&self, pipeline: RenderPipeline)

Source§

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

Create a compute pipeline according to desc. Read more
Source§

unsafe fn destroy_compute_pipeline(&self, pipeline: ComputePipeline)

Source§

unsafe fn create_ray_tracing_pipeline( &self, _desc: &RayTracingPipelineDescriptor<'_, PipelineLayout, ShaderModule, PipelineCache>, ) -> Result<RayTracingPipeline, PipelineError>

Create a ray tracing pipeline according to desc. Read more
Source§

unsafe fn destroy_ray_tracing_pipeline(&self, _pipeline: RayTracingPipeline)

Source§

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.
Source§

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

Source§

unsafe fn destroy_pipeline_cache(&self, _: 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: Option<Duration>, ) -> Result<bool, DeviceError>

Wait for fence to reach value. Read more
Source§

unsafe fn start_graphics_debugger_capture(&self) -> bool

Start a graphics debugger capture. Read more
Source§

unsafe fn stop_graphics_debugger_capture(&self)

Stop a graphics debugger capture. Read more
Source§

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

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 destroy_acceleration_structure( &self, _acceleration_structure: AccelerationStructure, )

Source§

fn tlas_instance_to_bytes( &self, _instance: TlasInstance, _to_extend: &mut Vec<u8>, )

Converts the TlasInstance into a implementation defined format, appending it to to_extend. The vector must be have a length exactly the old length plus Alignments::raw_tlas_instance_size
Source§

fn get_internal_counters(&self) -> HalCounters

Source§

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

Source§

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

Source§

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

Source§

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

Source§

impl Drop for Device

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl DynResource for Device

Source§

fn as_any(&self) -> &dyn Any

Source§

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

Source§

impl Send for Device

Available on send_sync only.
Source§

impl Sync for Device

Available on send_sync only.

Auto Trait Implementations§

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

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

Source§

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

Dynamic version of Device::create_buffer
Source§

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

Dynamic version of Device::destroy_buffer
Source§

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

Dynamic version of Device::add_raw_buffer
Source§

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

Dynamic version of Device::map_buffer
Source§

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

Dynamic version of Device::unmap_buffer
Source§

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

Dynamic version of Device::flush_mapped_ranges
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>

Dynamic version of Device::create_texture
Source§

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

Dynamic version of Device::destroy_texture
Source§

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

Dynamic version of Device::add_raw_texture
Source§

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

Dynamic version of Device::create_texture_view
Source§

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

Dynamic version of Device::destroy_texture_view
Source§

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

Dynamic version of Device::create_sampler
Source§

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

Dynamic version of Device::destroy_sampler
Source§

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

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>

Dynamic version of Device::create_bind_group
Source§

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

Dynamic version of Device::destroy_bind_group
Source§

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

Dynamic version of Device::create_shader_module
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_ray_tracing_pipeline( &self, desc: &RayTracingPipelineDescriptor<'_, dyn DynPipelineLayout, dyn DynShaderModule, dyn DynPipelineCache>, ) -> Result<Box<dyn DynRayTracingPipeline>, PipelineError>

Source§

unsafe fn destroy_ray_tracing_pipeline( &self, pipeline: Box<dyn DynRayTracingPipeline>, )

Source§

unsafe fn get_raytracing_pipeline_group_data( &self, pipeline: &(dyn DynRayTracingPipeline + 'static), groups: Range<u32>, ) -> Result<Vec<u8>, DeviceError>

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>

Dynamic version of Device::create_query_set
Source§

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

Dynamic version of Device::destroy_query_set
Source§

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

Dynamic version of Device::create_fence
Source§

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

Dynamic version of Device::destroy_fence
Source§

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

Dynamic version of Device::get_fence_value
Source§

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

Dynamic version of Device::wait
Source§

unsafe fn start_graphics_debugger_capture(&self) -> bool

Source§

unsafe fn stop_graphics_debugger_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 tlas_instance_to_bytes( &self, instance: TlasInstance, to_extend: &mut Vec<u8>, )

Source§

fn get_internal_counters(&self) -> HalCounters

Source§

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

Source§

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

Dynamic version of Device::check_if_oom
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> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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

Source§

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

impl<T> Upcast<T> for T

§

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

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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