pub struct Device { /* private fields */ }Available on
gles only.Implementations§
Source§impl Device
impl Device
Sourcepub fn context(&self) -> &AdapterContext
Available on neither webgl nor Windows.
pub fn context(&self) -> &AdapterContext
webgl nor Windows.Returns the underlying EGL context.
Source§impl Device
impl Device
Sourcepub fn read_program_links(&self) -> bool
pub fn read_program_links(&self) -> bool
Reads the link of every program whose link no submission read yet, and returns whether there was one. Each read waits for the GPU to reach that program’s link; called once it has, between frames, the reads cost only their replies there instead of in the first frame that draws with the programs. In Chrome on a Huawei Mate 20 X that frame read 22 links built ahead of it in 113 ms.
Sourcepub unsafe fn texture_from_raw(
&self,
name: NonZeroU32,
desc: &TextureDescriptor<'_>,
drop_callback: Option<DropCallback>,
) -> Texture
Available on Emscripten or native only.
pub unsafe fn texture_from_raw( &self, name: NonZeroU32, desc: &TextureDescriptor<'_>, drop_callback: Option<DropCallback>, ) -> Texture
Emscripten or native only.Sourcepub unsafe fn texture_from_raw_renderbuffer(
&self,
name: NonZeroU32,
desc: &TextureDescriptor<'_>,
drop_callback: Option<DropCallback>,
) -> Texture
Available on Emscripten or native only.
pub unsafe fn texture_from_raw_renderbuffer( &self, name: NonZeroU32, desc: &TextureDescriptor<'_>, drop_callback: Option<DropCallback>, ) -> Texture
Emscripten or native only.Sourcepub unsafe fn buffer_from_raw(
&self,
name: NonZeroU32,
desc: &BufferDescriptor<'_>,
drop_callback: Option<DropCallback>,
) -> Buffer
Available on Emscripten or native only.
pub unsafe fn buffer_from_raw( &self, name: NonZeroU32, desc: &BufferDescriptor<'_>, drop_callback: Option<DropCallback>, ) -> Buffer
Emscripten or native only.§Safety
namemust be a non-zero GL buffer name created respectingdesc.- The buffer’s storage size must be at least
desc.size. - If
desc.usageincludesBufferUses::MAP_READorBufferUses::MAP_WRITE, the GL buffer must have been allocated withglBufferStorage(or equivalent) using flags compatible with persistent mapping (GL_MAP_PERSISTENT_BITplus matching read/write/coherent bits). Buffers created with the legacyglBufferDatafamily cannot be mapped through this path. - If
drop_callbackisNone, wgpu-hal will take ownership of the buffer and callglDeleteBufferson it. Ifdrop_callbackisSome, the buffer must remain valid until the callback is invoked.
Trait Implementations§
Source§impl Device for Device
impl Device for Device
type A = Api
Source§unsafe fn create_buffer(
&self,
desc: &BufferDescriptor<'_>,
) -> Result<Buffer, DeviceError>
unsafe fn create_buffer( &self, desc: &BufferDescriptor<'_>, ) -> Result<Buffer, DeviceError>
Creates a new buffer. Read more
Source§unsafe fn destroy_buffer(&self, buffer: Buffer)
unsafe fn destroy_buffer(&self, buffer: Buffer)
Free
buffer and any GPU resources it owns. Read moreSource§unsafe fn add_raw_buffer(&self, _buffer: &Buffer)
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>
unsafe fn map_buffer( &self, buffer: &Buffer, range: MemoryRange, ) -> Result<BufferMapping, DeviceError>
Return a pointer to CPU memory mapping the contents of
buffer. Read moreSource§unsafe fn unmap_buffer(&self, buffer: &Buffer)
unsafe fn unmap_buffer(&self, buffer: &Buffer)
Remove the mapping established by the last call to
Device::map_buffer. Read moreSource§unsafe fn flush_mapped_ranges<I>(&self, buffer: &Buffer, ranges: I)where
I: Iterator<Item = MemoryRange>,
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)
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>
unsafe fn create_texture( &self, desc: &TextureDescriptor<'_>, ) -> Result<Texture, DeviceError>
Creates a new texture. Read more
unsafe fn destroy_texture(&self, texture: Texture)
Source§unsafe fn add_raw_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)
Source§unsafe fn create_command_encoder(
&self,
_desc: &CommandEncoderDescriptor<'_, Queue>,
) -> Result<CommandEncoder, DeviceError>
unsafe fn create_command_encoder( &self, _desc: &CommandEncoderDescriptor<'_, Queue>, ) -> Result<CommandEncoder, DeviceError>
Create a fresh
CommandEncoder. Read moreSource§unsafe fn create_bind_group_layout(
&self,
desc: &BindGroupLayoutDescriptor<'_>,
) -> Result<BindGroupLayout, DeviceError>
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)
Source§unsafe fn get_raytracing_pipeline_group_data(
&self,
_pipeline: &RayTracingPipeline,
_groups: Range<u32>,
) -> Result<Vec<u8>, DeviceError>
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, _: &PipelineCacheDescriptor<'_>, ) -> Result<PipelineCache, PipelineCacheError>
unsafe fn destroy_pipeline_cache(&self, _: 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>
Source§unsafe fn wait(
&self,
fence: &Fence,
wait_value: FenceValue,
timeout: Option<Duration>,
) -> Result<bool, DeviceError>
unsafe fn wait( &self, fence: &Fence, wait_value: FenceValue, timeout: Option<Duration>, ) -> Result<bool, DeviceError>
Source§unsafe fn start_graphics_debugger_capture(&self) -> bool
unsafe fn start_graphics_debugger_capture(&self) -> bool
Start a graphics debugger capture. Read more
Source§unsafe fn stop_graphics_debugger_capture(&self)
unsafe fn stop_graphics_debugger_capture(&self)
Stop a graphics debugger capture. Read more
unsafe fn create_acceleration_structure( &self, _desc: &AccelerationStructureDescriptor<'_>, ) -> Result<AccelerationStructure, DeviceError>
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 destroy_acceleration_structure( &self, _acceleration_structure: AccelerationStructure, )
fn tlas_instance_to_bytes(&self, _instance: TlasInstance) -> Vec<u8> ⓘ
fn get_internal_counters(&self) -> HalCounters
fn check_if_oom(&self) -> Result<(), DeviceError>
fn pipeline_cache_validation_key(&self) -> Option<[u8; 16]>
unsafe fn pipeline_cache_get_data( &self, cache: &<Self::A as Api>::PipelineCache, ) -> Option<Vec<u8>>
fn generate_allocator_report(&self) -> Option<AllocatorReport>
Source§impl DynResource for Device
impl DynResource for Device
impl Send for Device
Available on
send_sync only.impl Sync for Device
Available on
send_sync only.Auto Trait Implementations§
impl !RefUnwindSafe for Device
impl !UnwindSafe for Device
impl Forget for Device
impl Freeze for Device
impl Unpin for Device
impl UnsafeUnpin for Device
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more