Enum gfx_backend_vulkan::Backend

pub enum Backend {}

Trait Implementations

impl PartialEq<Backend> for Backend

fn eq(&self, other: &Backend) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Clone for Backend

fn clone(&self) -> Backend

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Eq for Backend

impl Copy for Backend

impl Debug for Backend

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

Formats the value using the given formatter.

impl Hash for Backend

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PhysicalDevice<Backend> for PhysicalDevice

unsafe fn open(
    &self,
    families: &[(&QueueFamily, &[QueuePriority])],
    requested_features: Features
) -> Result<Gpu<Backend>, DeviceCreationError>

Create a new logical device with the requested features. If requested_features is empty (e.g. through Features::empty()) then only the core features are supported.

fn format_properties(&self, format: Option<Format>) -> Properties

Fetch details for a particular format.

fn image_format_properties(
    &self,
    format: Format,
    dimensions: u8,
    tiling: Tiling,
    usage: Usage,
    view_caps: ViewCapabilities
) -> Option<FormatProperties>

Fetch details for a particular image format.

fn memory_properties(&self) -> MemoryProperties

Fetch details for the memory regions provided by the device.

fn features(&self) -> Features

Returns the features of this Device. This usually depends on the graphics API being used.

fn limits(&self) -> Limits

Returns the resource limits of this Device.

fn is_valid_cache(&self, cache: &[u8]) -> bool

Check cache compatibility with the Device.

impl Device<Backend> for Device

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

Allocates a memory segment of a specified type.

unsafe fn create_command_pool(
    &self,
    family: QueueFamilyId,
    create_flags: CommandPoolCreateFlags
) -> Result<RawCommandPool, OutOfMemory>

Create a new command pool for a given queue family.

unsafe fn destroy_command_pool(&self, pool: RawCommandPool)

Destroy a command pool.

unsafe fn create_render_pass<'a, IA, IS, ID>(
    &self,
    attachments: IA,
    subpasses: IS,
    dependencies: ID
) -> Result<RenderPass, 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,
    sets: IS,
    push_constant_ranges: IR
) -> Result<PipelineLayout, 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<PipelineCache, OutOfMemory>

Create a pipeline cache object.

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

Retrieve data from pipeline cache object.

unsafe fn destroy_pipeline_cache(&self, cache: PipelineCache)

Destroy a pipeline cache object.

unsafe fn merge_pipeline_caches<I>(
    &self,
    target: &PipelineCache,
    sources: I
) -> Result<(), OutOfMemory> where
    I: IntoIterator,
    I::Item: Borrow<PipelineCache>, 

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

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

Create graphics pipelines.

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

Create compute pipelines.

unsafe fn create_framebuffer<T>(
    &self,
    renderpass: &RenderPass,
    attachments: T,
    extent: Extent
) -> Result<Framebuffer, OutOfMemory> where
    T: IntoIterator,
    T::Item: Borrow<ImageView>, 

Create a new framebuffer object.

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

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

unsafe fn create_sampler(
    &self,
    sampler_info: SamplerInfo
) -> Result<Sampler, AllocationError>

Create a new sampler object

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

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

Get memory requirements for the buffer

unsafe fn bind_buffer_memory(
    &self,
    memory: &Memory,
    offset: u64,
    buffer: &mut Buffer
) -> Result<(), BindError>

Bind memory to a buffer.

unsafe fn create_buffer_view<R: RangeArg<u64>>(
    &self,
    buffer: &Buffer,
    format: Option<Format>,
    range: R
) -> Result<BufferView, ViewCreationError>

Create a new buffer view object

unsafe fn create_image(
    &self,
    kind: Kind,
    mip_levels: Level,
    format: Format,
    tiling: Tiling,
    usage: Usage,
    view_caps: 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: &Image,
    subresource: Subresource
) -> SubresourceFootprint

unsafe fn bind_image_memory(
    &self,
    memory: &Memory,
    offset: u64,
    image: &mut Image
) -> Result<(), BindError>

Bind device memory to an image object

unsafe fn create_image_view(
    &self,
    image: &Image,
    kind: ViewKind,
    format: Format,
    swizzle: Swizzle,
    range: SubresourceRange
) -> Result<ImageView, ViewError>

Create an image view from an existing image

unsafe fn create_descriptor_pool<T>(
    &self,
    max_sets: usize,
    descriptor_pools: T,
    flags: DescriptorPoolCreateFlags
) -> Result<DescriptorPool, OutOfMemory> where
    T: IntoIterator,
    T::Item: Borrow<DescriptorRangeDesc>, 

Create a descriptor pool.

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

Create a descriptor set layout.

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

Specifying the parameters of a descriptor set write operation

unsafe fn copy_descriptor_sets<'a, I>(&self, copies: I) where
    I: IntoIterator,
    I::Item: Borrow<DescriptorSetCopy<'a, B>>, 

Structure specifying a copy descriptor set operation

unsafe fn map_memory<R>(
    &self,
    memory: &Memory,
    range: R
) -> Result<*mut u8, Error> where
    R: RangeArg<u64>, 

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, R>(
    &self,
    ranges: I
) -> Result<(), OutOfMemory> where
    I: IntoIterator,
    I::Item: Borrow<(&'a Memory, R)>,
    R: RangeArg<u64>, 

Flush mapped memory ranges

unsafe fn invalidate_mapped_memory_ranges<'a, I, R>(
    &self,
    ranges: I
) -> Result<(), OutOfMemory> where
    I: IntoIterator,
    I::Item: Borrow<(&'a Memory, R)>,
    R: RangeArg<u64>, 

Invalidate ranges of non-coherent memory from the host caches

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

Create a new semaphore object

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

Create a new fence object

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

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

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

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

true for signaled, false for not ready

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

Create an event object.

unsafe fn get_event_status(
    &self,
    event: &Event
) -> Result<bool, OomOrDeviceLost>

Query the status of an event.

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

Sets an event.

unsafe fn reset_event(&self, event: &Event) -> Result<(), OutOfMemory>

Resets an event.

unsafe fn free_memory(&self, memory: Memory)

Free device memory

unsafe fn create_query_pool(
    &self,
    ty: Type,
    query_count: Id
) -> Result<QueryPool, CreationError>

Create a new query pool object

unsafe fn get_query_pool_results(
    &self,
    pool: &QueryPool,
    queries: Range<Id>,
    data: &mut [u8],
    stride: Offset,
    flags: 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 create_swapchain(
    &self,
    surface: &mut Surface,
    config: SwapchainConfig,
    provided_old_swapchain: 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: Swapchain)

unsafe fn destroy_query_pool(&self, pool: QueryPool)

Destroy a query pool object

unsafe fn destroy_shader_module(&self, module: ShaderModule)

Destroy a shader module module

unsafe fn destroy_render_pass(&self, rp: RenderPass)

Destroy a RenderPass.

unsafe fn destroy_pipeline_layout(&self, pl: PipelineLayout)

Destroy a pipeline layout object

unsafe fn destroy_graphics_pipeline(&self, pipeline: GraphicsPipeline)

Destroy a graphics pipeline.

unsafe fn destroy_compute_pipeline(&self, pipeline: ComputePipeline)

Destroy a compute pipeline.

unsafe fn destroy_framebuffer(&self, fb: Framebuffer)

Destroy a framebuffer.

unsafe fn destroy_buffer(&self, buffer: Buffer)

Destroy a buffer.

unsafe fn destroy_buffer_view(&self, view: BufferView)

Destroy a buffer view object

unsafe fn destroy_image(&self, image: Image)

Destroy an image.

unsafe fn destroy_image_view(&self, view: ImageView)

Destroy an image view object

unsafe fn destroy_sampler(&self, sampler: Sampler)

Destroy a sampler object

unsafe fn destroy_descriptor_pool(&self, pool: DescriptorPool)

Destroy a descriptor pool object

unsafe fn destroy_descriptor_set_layout(&self, layout: DescriptorSetLayout)

Destroy a descriptor set layout object

unsafe fn destroy_fence(&self, fence: Fence)

Destroy a fence object

unsafe fn destroy_semaphore(&self, semaphore: Semaphore)

Destroy a semaphore object

unsafe fn destroy_event(&self, event: Event)

Destroy an event object.

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

Wait for all queues associated with this device to idle.

unsafe fn create_command_pool_typed<C>(
    &self,
    group: &QueueGroup<B, C>,
    flags: CommandPoolCreateFlags
) -> Result<CommandPool<B, C>, OutOfMemory>

Create a strongly typed command pool wrapper.

unsafe fn create_graphics_pipeline(
    &self,
    desc: &GraphicsPipelineDesc<'a, B>,
    cache: Option<&<B as Backend>::PipelineCache>
) -> Result<<B as Backend>::GraphicsPipeline, CreationError>

Create a graphics pipeline.

unsafe fn create_compute_pipeline(
    &self,
    desc: &ComputePipelineDesc<'a, B>,
    cache: Option<&<B as Backend>::PipelineCache>
) -> Result<<B as Backend>::ComputePipeline, CreationError>

Create a compute pipeline.

unsafe fn acquire_mapping_reader<T>(
    &self,
    memory: &'a <B as Backend>::Memory,
    range: Range<u64>
) -> Result<Reader<'a, B, T>, Error> where
    T: Copy, 

Acquire a mapping Reader.

unsafe fn release_mapping_reader<T>(&self, reader: Reader<'a, B, T>)

Release a mapping Reader.

unsafe fn acquire_mapping_writer<T>(
    &self,
    memory: &'a <B as Backend>::Memory,
    range: Range<u64>
) -> Result<Writer<'a, B, T>, Error> where
    T: Copy, 

Acquire a mapping Writer.

unsafe fn release_mapping_writer<T>(
    &self,
    writer: Writer<'a, B, T>
) -> Result<(), OutOfMemory>

Release a mapping Writer.

unsafe fn reset_fence(
    &self,
    fence: &<B as Backend>::Fence
) -> Result<(), OutOfMemory>

unsafe fn wait_for_fence(
    &self,
    fence: &<B as Backend>::Fence,
    timeout_ns: u64
) -> Result<bool, OomOrDeviceLost>

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

impl Backend for Backend

type PhysicalDevice = PhysicalDevice

type Device = Device

type Surface = Surface

type Swapchain = Swapchain

type QueueFamily = QueueFamily

type CommandQueue = CommandQueue

type CommandBuffer = CommandBuffer

type Memory = Memory

type CommandPool = RawCommandPool

type ShaderModule = ShaderModule

type RenderPass = RenderPass

type Framebuffer = Framebuffer

type Buffer = Buffer

type BufferView = BufferView

type Image = Image

type ImageView = ImageView

type Sampler = Sampler

type ComputePipeline = ComputePipeline

type GraphicsPipeline = GraphicsPipeline

type PipelineLayout = PipelineLayout

type PipelineCache = PipelineCache

type DescriptorSetLayout = DescriptorSetLayout

type DescriptorPool = DescriptorPool

type DescriptorSet = DescriptorSet

type Fence = Fence

type Semaphore = Semaphore

type Event = Event

type QueryPool = QueryPool

impl RawCommandQueue<Backend> for CommandQueue

unsafe fn submit<'a, T, Ic, S, Iw, Is>(
    &mut self,
    submission: Submission<Ic, Iw, Is>,
    fence: Option<&Fence>
) where
    T: 'a + Borrow<CommandBuffer>,
    Ic: IntoIterator<Item = &'a T>,
    S: 'a + Borrow<Semaphore>,
    Iw: IntoIterator<Item = (&'a S, PipelineStage)>,
    Is: IntoIterator<Item = &'a S>, 

Submit command buffers to queue for execution. fence must be in unsignalled state, and will be signalled after all command buffers in the submission have finished execution.

unsafe fn present<'a, W, Is, S, Iw>(
    &mut self,
    swapchains: Is,
    wait_semaphores: Iw
) -> Result<Option<Suboptimal>, PresentError> where
    W: 'a + Borrow<Swapchain>,
    Is: IntoIterator<Item = (&'a W, SwapImageIndex)>,
    S: 'a + Borrow<Semaphore>,
    Iw: IntoIterator<Item = &'a S>, 

Presents the result of the queue to the given swapchains, after waiting on all the semaphores given in wait_semaphores. A given swapchain must not appear in this list more than once.

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

Wait for the queue to idle.