Struct Device

pub struct Device;

Dummy device doing nothing.

Trait Implementations

impl Debug for Device

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

Formats the value using the given formatter.

impl Device<Backend> for Device

unsafe fn create_command_pool( &self, _: QueueFamilyId, _: CommandPoolCreateFlags, ) -> Result<CommandPool, OutOfMemory>

Create a new command pool for a given queue family.

unsafe fn destroy_command_pool(&self, _: CommandPool)

Destroy a command pool.

unsafe fn allocate_memory( &self, memory_type: MemoryTypeId, size: u64, ) -> Result<Memory, AllocationError>

Allocates a memory segment of a specified type.

unsafe fn create_render_pass<'a, Ia, Is, Id>( &self, _: Ia, _: Is, _: Id, ) -> Result<(), OutOfMemory>

where Is: Iterator<Item = SubpassDesc<'a>>,

Create a render pass with the given attachments and subpasses.

unsafe fn create_pipeline_layout<'a, Is, Ic>( &self, _: Is, _: Ic, ) -> Result<(), OutOfMemory>

where Is: Iterator<Item = &'a DescriptorSetLayout>,

Create a new pipeline layout object.

unsafe fn create_pipeline_cache( &self, _data: Option<&[u8]>, ) -> Result<(), OutOfMemory>

Create a pipeline cache object.

unsafe fn get_pipeline_cache_data( &self, _cache: &(), ) -> Result<Vec<u8>, OutOfMemory>

Retrieve data from pipeline cache object.

unsafe fn destroy_pipeline_cache(&self, _: ())

Destroy a pipeline cache object.

unsafe fn create_graphics_pipeline<'a>( &self, _: &GraphicsPipelineDesc<'a, Backend>, _: Option<&()>, ) -> Result<(), CreationError>

Create a graphics pipeline.

unsafe fn create_compute_pipeline<'a>( &self, _: &ComputePipelineDesc<'a, Backend>, _: Option<&()>, ) -> Result<(), CreationError>

Create a compute pipeline.

unsafe fn merge_pipeline_caches<'a, I>( &self, _: &mut (), _: I, ) -> Result<(), OutOfMemory>

where I: Iterator<Item = &'a ()>,

Merge a number of source pipeline caches into the target one.

unsafe fn create_framebuffer<I>( &self, _: &(), _: I, _: Extent, ) -> Result<(), OutOfMemory>

Create a new framebuffer object.

unsafe fn create_shader_module(&self, _: &[u32]) -> Result<(), ShaderError>

Create a new shader module object from the SPIR-V binary data.

unsafe fn create_sampler(&self, _: &SamplerDesc) -> Result<(), AllocationError>

Create a new sampler object

unsafe fn create_buffer( &self, size: u64, _: Usage, _: SparseFlags, ) -> Result<Buffer, CreationError>

Create a new buffer (unbound).

unsafe fn get_buffer_requirements(&self, buffer: &Buffer) -> Requirements

Get memory requirements for the buffer

unsafe fn bind_buffer_memory( &self, _memory: &Memory, _: u64, _: &mut Buffer, ) -> Result<(), BindError>

Bind memory to a buffer.

unsafe fn create_buffer_view( &self, _: &Buffer, _: Option<Format>, _: SubRange, ) -> Result<(), ViewCreationError>

Create a new buffer view object

unsafe fn create_image( &self, kind: Kind, _: Level, _: Format, _: Tiling, _: Usage, _: SparseFlags, _: ViewCapabilities, ) -> Result<Image, CreationError>

Create a new image object

unsafe fn get_image_requirements(&self, image: &Image) -> Requirements

Get memory requirements for the Image

unsafe fn get_image_subresource_footprint( &self, _: &Image, _: Subresource, ) -> SubresourceFootprint

unsafe fn bind_image_memory( &self, _memory: &Memory, _: u64, _: &mut Image, ) -> Result<(), BindError>

Bind device memory to an image object

unsafe fn create_image_view( &self, _: &Image, _: ViewKind, _: Format, _: Swizzle, _: Usage, _: SubresourceRange, ) -> Result<(), ViewCreationError>

Create an image view from an existing image

unsafe fn create_descriptor_pool<I>( &self, _: usize, _: I, _: DescriptorPoolCreateFlags, ) -> Result<DescriptorPool, OutOfMemory>

Create a descriptor pool.

unsafe fn create_descriptor_set_layout<'a, I, J>( &self, _bindings: I, _samplers: J, ) -> Result<DescriptorSetLayout, OutOfMemory>

where J: Iterator<Item = &'a ()>,

Create a descriptor set layout.

unsafe fn write_descriptor_set<'a, I>( &self, _: DescriptorSetWrite<'a, Backend, I>, )

where I: Iterator<Item = Descriptor<'a, Backend>>,

Specifying the parameters of a descriptor set write operation.

unsafe fn copy_descriptor_set<'a>(&self, _: DescriptorSetCopy<'a, Backend>)

Structure specifying a copy descriptor set operation.

fn create_semaphore(&self) -> Result<(), OutOfMemory>

Create a new semaphore object.

fn create_fence(&self, _: bool) -> Result<(), OutOfMemory>

Create a new fence object.

unsafe fn get_fence_status(&self, _: &()) -> Result<bool, DeviceLost>

true for signaled, false for not ready

fn create_event(&self) -> Result<(), OutOfMemory>

Create an event object.

unsafe fn get_event_status(&self, _: &()) -> Result<bool, WaitError>

Query the status of an event.

unsafe fn set_event(&self, _: &mut ()) -> Result<(), OutOfMemory>

Sets an event.

unsafe fn reset_event(&self, _: &mut ()) -> Result<(), OutOfMemory>

Resets an event.

unsafe fn create_query_pool(&self, _: Type, _: u32) -> Result<(), CreationError>

Create a new query pool object

unsafe fn destroy_query_pool(&self, _: ())

Destroy a query pool object

unsafe fn get_query_pool_results( &self, _: &(), _: Range<Id>, _: &mut [u8], _: Stride, _: ResultFlags, ) -> Result<bool, WaitError>

Get query pool results into the specified CPU memory. Returns Ok(false) if the results are not ready yet and neither of WAIT or PARTIAL flags are set.

unsafe fn map_memory( &self, memory: &mut Memory, segment: Segment, ) -> Result<*mut u8, MapError>

Map a memory object into application address space

unsafe fn unmap_memory(&self, _memory: &mut Memory)

Unmap a memory object once host access to it is no longer needed by the application

unsafe fn flush_mapped_memory_ranges<'a, I>( &self, _: I, ) -> Result<(), OutOfMemory>

where I: Iterator<Item = (&'a Memory, Segment)>,

Flush mapped memory ranges

unsafe fn invalidate_mapped_memory_ranges<'a, I>( &self, _: I, ) -> Result<(), OutOfMemory>

where I: Iterator<Item = (&'a Memory, Segment)>,

Invalidate ranges of non-coherent memory from the host caches

unsafe fn free_memory(&self, _memory: Memory)

Free device memory

unsafe fn destroy_shader_module(&self, _: ())

Destroy a shader module module

unsafe fn destroy_render_pass(&self, _: ())

Destroys a render pass created by this device.

unsafe fn destroy_pipeline_layout(&self, _: ())

Destroy a pipeline layout object

unsafe fn destroy_graphics_pipeline(&self, _: ())

Destroy a graphics pipeline.

unsafe fn destroy_compute_pipeline(&self, _: ())

Destroy a compute pipeline.

unsafe fn destroy_framebuffer(&self, _: ())

Destroy a framebuffer.

unsafe fn destroy_buffer(&self, _: Buffer)

Destroy a buffer.

unsafe fn destroy_buffer_view(&self, _: ())

Destroy a buffer view object

unsafe fn destroy_image(&self, _: Image)

Destroy an image.

unsafe fn destroy_image_view(&self, _: ())

Destroy an image view object

unsafe fn destroy_sampler(&self, _: ())

Destroy a sampler object

unsafe fn destroy_descriptor_pool(&self, _: DescriptorPool)

Destroy a descriptor pool object

unsafe fn destroy_descriptor_set_layout(&self, _: DescriptorSetLayout)

Destroy a descriptor set layout object

unsafe fn destroy_fence(&self, _: ())

Destroy a fence object

unsafe fn destroy_semaphore(&self, _: ())

Destroy a semaphore object.

unsafe fn destroy_event(&self, _: ())

Destroy an event object.

fn wait_idle(&self) -> Result<(), OutOfMemory>

Wait for all queues associated with this device to idle.

unsafe fn set_image_name(&self, _: &mut Image, _: &str)

Associate a name with an image, for easier debugging in external tools or with validation layers that can print a friendly name when referring to objects in error messages

unsafe fn set_buffer_name(&self, _: &mut Buffer, _: &str)

Associate a name with a buffer, for easier debugging in external tools or with validation layers that can print a friendly name when referring to objects in error messages

unsafe fn set_command_buffer_name(&self, _: &mut CommandBuffer, _: &str)

Associate a name with a command buffer, for easier debugging in external tools or with validation layers that can print a friendly name when referring to objects in error messages

unsafe fn set_semaphore_name(&self, _: &mut (), _: &str)

Associate a name with a semaphore, for easier debugging in external tools or with validation layers that can print a friendly name when referring to objects in error messages

unsafe fn set_fence_name(&self, _: &mut (), _: &str)

Associate a name with a fence, for easier debugging in external tools or with validation layers that can print a friendly name when referring to objects in error messages

unsafe fn set_framebuffer_name(&self, _: &mut (), _: &str)

Associate a name with a framebuffer, for easier debugging in external tools or with validation layers that can print a friendly name when referring to objects in error messages

unsafe fn set_render_pass_name(&self, _: &mut (), _: &str)

Associate a name with a render pass, for easier debugging in external tools or with validation layers that can print a friendly name when referring to objects in error messages

unsafe fn set_descriptor_set_name(&self, set: &mut DescriptorSet, name: &str)

Associate a name with a descriptor set, for easier debugging in external tools or with validation layers that can print a friendly name when referring to objects in error messages

unsafe fn set_descriptor_set_layout_name( &self, layout: &mut DescriptorSetLayout, name: &str, )

Associate a name with a descriptor set layout, for easier debugging in external tools or with validation layers that can print a friendly name when referring to objects in error messages

unsafe fn set_pipeline_layout_name( &self, _pipeline_layout: &mut (), _name: &str, )

Associate a name with a pipeline layout, for easier debugging in external tools or with validation layers that can print a friendly name when referring to objects in error messages

unsafe fn create_allocate_external_buffer( &self, _external_memory_type: ExternalBufferMemoryType, _usage: Usage, _sparse: SparseFlags, _type_mask: u32, _size: u64, ) -> Result<(<Backend as Backend>::Buffer, <Backend as Backend>::Memory), ExternalResourceError>

Create, allocate and bind a buffer that can be exported.

unsafe fn import_external_buffer( &self, _external_memory: ExternalBufferMemory, _usage: Usage, _sparse: SparseFlags, _type_mask: u32, _size: u64, ) -> Result<(<Backend as Backend>::Buffer, <Backend as Backend>::Memory), ExternalResourceError>

Import external memory as binded buffer and memory.

unsafe fn create_allocate_external_image( &self, _external_memory_type: ExternalImageMemoryType, _kind: Kind, _num_levels: Level, _format: Format, _tiling: Tiling, _usage: Usage, _sparse: SparseFlags, _view_caps: ViewCapabilities, _type_mask: u32, ) -> Result<(<Backend as Backend>::Image, <Backend as Backend>::Memory), ExternalResourceError>

Create, allocate and bind an image that can be exported.

unsafe fn import_external_image( &self, _external_memory: ExternalImageMemory, _kind: Kind, _num_levels: Level, _format: Format, _tiling: Tiling, _usage: Usage, _sparse: SparseFlags, _view_caps: ViewCapabilities, _type_mask: u32, ) -> Result<(<Backend as Backend>::Image, <Backend as Backend>::Memory), ExternalResourceError>

Import external memory as binded image and memory.

unsafe fn export_memory( &self, _external_memory_type: ExternalMemoryType, _memory: &<Backend as Backend>::Memory, ) -> Result<PlatformMemory, ExternalMemoryExportError>

Export memory as os type (Fd, Handle or Ptr) based on the requested external memory type.

unsafe fn drm_format_modifier( &self, _image: &<Backend as Backend>::Image, ) -> Option<DrmModifier>

Retrieve the underlying drm format modifier from an image, if any.

unsafe fn reset_fence(&self, _: &mut ()) -> Result<(), OutOfMemory>

Resets a given fence to its original, unsignaled state.

unsafe fn wait_for_fence(&self, _: &(), _: u64) -> Result<bool, WaitError>

Blocks until the given fence is signaled. Returns true if the fence was signaled before the timeout.

unsafe fn set_display_power_state( &self, _display: &Display<Backend>, _power_state: &PowerState, ) -> Result<(), DisplayControlError>

Control the power state of the provided display

unsafe fn register_device_event( &self, _device_event: &DeviceEvent, _fence: &mut <Backend as Backend>::Fence, ) -> Result<(), DisplayControlError>

Register device event

unsafe fn register_display_event( &self, _display: &Display<Backend>, _display_event: &DisplayEvent, _fence: &mut <Backend as Backend>::Fence, ) -> Result<(), DisplayControlError>

Register display event

fn start_capture(&self)

Starts frame capture.

fn stop_capture(&self)

Stops frame capture.

unsafe fn create_shader_module_from_naga( &self, shader: NagaShader, ) -> Result<<B as Backend>::ShaderModule, (ShaderError, NagaShader)>

Create a new shader module from the naga module.

unsafe fn wait_for_fences<'a, I>( &self, fences: I, wait: WaitFor, timeout_ns: u64, ) -> Result<bool, WaitError>

where I: Iterator<Item = &'a <B as Backend>::Fence>,

Blocks until all or one of the given fences are signaled. Returns true if fences were signaled before the timeout.