Struct gfx_backend_empty::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
    IA: IntoIterator,
    IA::Item: Borrow<Attachment>,
    IS: IntoIterator,
    IS::Item: Borrow<SubpassDesc<'a>>,
    ID: IntoIterator,
    ID::Item: Borrow<SubpassDependency>, 

Create a render pass with the given attachments and subpasses.

unsafe fn create_pipeline_layout<IS, IR>(
    &self,
    _: IS,
    _: IR
) -> Result<(), OutOfMemory> where
    IS: IntoIterator,
    IS::Item: Borrow<DescriptorSetLayout>,
    IR: IntoIterator,
    IR::Item: Borrow<(ShaderStageFlags, Range<u32>)>, 

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<I>(
    &self,
    _: &(),
    _: I
) -> Result<(), OutOfMemory> where
    I: IntoIterator,
    I::Item: Borrow<()>, 

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

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

Create a new framebuffer object.

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

Create a new shader module object through 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
) -> 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,
    _: 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,
    _: SubresourceRange
) -> Result<(), ViewCreationError>

Create an image view from an existing image

unsafe fn create_descriptor_pool<I>(
    &self,
    _: usize,
    _: I,
    _: DescriptorPoolCreateFlags
) -> Result<DescriptorPool, OutOfMemory> where
    I: IntoIterator,
    I::Item: Borrow<DescriptorRangeDesc>, 

Create a descriptor pool.

unsafe fn create_descriptor_set_layout<I, J>(
    &self,
    _bindings: I,
    _samplers: J
) -> Result<DescriptorSetLayout, OutOfMemory> where
    I: IntoIterator,
    I::Item: Borrow<DescriptorSetLayoutBinding>,
    J: IntoIterator,
    J::Item: Borrow<()>, 

Create a descriptor set layout.

unsafe fn write_descriptor_sets<'a, I, J>(&self, _: I) where
    I: IntoIterator<Item = DescriptorSetWrite<'a, Backend, J>>,
    J: IntoIterator,
    J::Item: Borrow<Descriptor<'a, Backend>>, 

Specifying the parameters of a descriptor set write operation

unsafe fn copy_descriptor_sets<'a, I>(&self, _: I) where
    I: IntoIterator,
    I::Item: Borrow<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, OomOrDeviceLost>

Query the status of an event.

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

Sets an event.

unsafe fn reset_event(&self, _: &()) -> 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],
    _: Offset,
    _: ResultFlags
) -> Result<bool, OomOrDeviceLost>

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: &Memory,
    segment: Segment
) -> Result<*mut u8, MapError>

Map a memory object into application address space

unsafe fn unmap_memory(&self, _memory: &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: IntoIterator,
    I::Item: Borrow<(&'a Memory, Segment)>, 

Flush mapped memory ranges

unsafe fn invalidate_mapped_memory_ranges<'a, I>(
    &self,
    _: I
) -> Result<(), OutOfMemory> where
    I: IntoIterator,
    I::Item: Borrow<(&'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, _: ())

Destroy a RenderPass.

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.

unsafe fn create_swapchain(
    &self,
    _: &mut Surface,
    _: SwapchainConfig,
    _: Option<Swapchain>
) -> Result<(Swapchain, Vec<Image>), CreationError>

Create a new swapchain from a surface and a queue family, optionally providing the old swapchain to aid in resource reuse and rendering continuity.

unsafe fn destroy_swapchain(&self, _: Swapchain)

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 reset_fence(&self, _: &()) -> Result<(), OutOfMemory>

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

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

unsafe fn create_graphics_pipelines<'a, I>(
    &self,
    descs: I,
    cache: Option<&<B as Backend>::PipelineCache>
) -> Vec<Result<<B as Backend>::GraphicsPipeline, CreationError>> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Borrow<GraphicsPipelineDesc<'a, B>>, 

Create graphics pipelines.

unsafe fn create_compute_pipelines<'a, I>(
    &self,
    descs: I,
    cache: Option<&<B as Backend>::PipelineCache>
) -> Vec<Result<<B as Backend>::ComputePipeline, CreationError>> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Borrow<ComputePipelineDesc<'a, B>>, 

Create compute pipelines.

unsafe fn reset_fences<I>(&self, fences: I) -> Result<(), OutOfMemory> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Borrow<<B as Backend>::Fence>, 

unsafe fn wait_for_fences<I>(
    &self,
    fences: I,
    wait: WaitFor,
    timeout_ns: u64
) -> Result<bool, OomOrDeviceLost> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Borrow<<B as Backend>::Fence>, 

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