Enum gfx_backend_vulkan::Backend

[−] Show declaration

pub enum Backend {}

Trait Implementations

impl Backend for Backend

type Instance = Instance

The corresponding instance type for this backend.

type PhysicalDevice = PhysicalDevice

The corresponding physical device type for this backend.

type Device = Device

The corresponding logical device type for this backend.

type Surface = Surface

The corresponding surface type for this backend.

type QueueFamily = QueueFamily

The corresponding queue family type for this backend.

type CommandQueue = CommandQueue

The corresponding command queue type for this backend.

type CommandBuffer = CommandBuffer

The corresponding command buffer type for this backend.

type Memory = Memory

The corresponding memory type for this backend.

type CommandPool = RawCommandPool

The corresponding command pool type for this backend.

type ShaderModule = ShaderModule

The corresponding shader module type for this backend.

type RenderPass = RenderPass

The corresponding render pass type for this backend.

type Framebuffer = Framebuffer

The corresponding framebuffer type for this backend.

type Buffer = Buffer

The corresponding buffer type for this backend.

type BufferView = BufferView

The corresponding buffer view type for this backend.

type Image = Image

The corresponding image type for this backend.

type ImageView = ImageView

The corresponding image view type for this backend.

type Sampler = Sampler

The corresponding sampler type for this backend.

type ComputePipeline = ComputePipeline

The corresponding compute pipeline type for this backend.

type GraphicsPipeline = GraphicsPipeline

The corresponding graphics pipeline type for this backend.

type PipelineLayout = PipelineLayout

The corresponding pipeline layout type for this backend.

type PipelineCache = PipelineCache

The corresponding pipeline cache type for this backend.

type DescriptorSetLayout = DescriptorSetLayout

The corresponding descriptor set layout type for this backend.

type DescriptorPool = DescriptorPool

The corresponding descriptor pool type for this backend.

type DescriptorSet = DescriptorSet

The corresponding descriptor set type for this backend.

type Fence = Fence

The corresponding fence type for this backend.

type Semaphore = Semaphore

The corresponding semaphore type for this backend.

type Event = Event

The corresponding event type for this backend.

type QueryPool = QueryPool

The corresponding query pool type for this backend.

impl Clone for Backend[+]

[+] Show hidden undocumented items

fn clone(&self) -> Backend[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl CommandQueue<Backend> for CommandQueue[+]

[+] Show hidden undocumented items

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.

unsafe fn present(
    &mut self,
    surface: &mut Surface,
    image: SurfaceImage,
    wait_semaphore: Option<&Semaphore>
) -> Result<Option<Suboptimal>, PresentError>[−]

Present a swapchain image directly to a surface, after waiting on wait_semaphore.

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

Wait for the queue to be idle.

unsafe fn submit_without_semaphores<'a, T, Ic>(
    &mut self,
    command_buffers: Ic,
    fence: Option<&<B as Backend>::Fence>
) where
    Ic: IntoIterator<Item = &'a T>,
    T: 'a + Borrow<<B as Backend>::CommandBuffer>, [−]

Simplified version of submit that doesn't expect any semaphores.

impl Copy for Backend

impl Debug for Backend[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Device<Backend> for Device[+]

[+] Show hidden undocumented items

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>,
    IA::IntoIter: ExactSizeIterator,
    IS: IntoIterator,
    IS::Item: Borrow<SubpassDesc<'a>>,
    IS::IntoIter: ExactSizeIterator,
    ID: IntoIterator,
    ID::Item: Borrow<SubpassDependency>,
    ID::IntoIter: ExactSizeIterator, [−]

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>,
    IS::IntoIter: ExactSizeIterator,
    IR: IntoIterator,
    IR::Item: Borrow<(ShaderStageFlags, Range<u32>)>,
    IR::IntoIter: ExactSizeIterator, [−]

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>,
    I::IntoIter: ExactSizeIterator, [−]

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

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

Create a graphics pipeline.

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 multiple graphics pipelines.

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

Create a compute pipeline.

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 from the SPIR-V binary data.

unsafe fn create_sampler(
    &self,
    desc: &SamplerDesc
) -> 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(
    &self,
    buffer: &Buffer,
    format: Option<Format>,
    range: SubRange
) -> 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, ViewCreationError>[−]

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>,
    T::IntoIter: ExactSizeIterator, [−]

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>,
    J::IntoIter: ExactSizeIterator, [−]

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>>,
    I::IntoIter: ExactSizeIterator, [−]

Structure specifying a copy descriptor set operation

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,
    ranges: 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,
    ranges: I
) -> Result<(), OutOfMemory> where
    I: IntoIterator,
    I::Item: Borrow<(&'a Memory, Segment)>, [−]

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>,
    I::IntoIter: ExactSizeIterator, [−]

Resets multiple fences to their original states.

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

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 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)[−]

Destroys a render pass created by this device.

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<(), OutOfMemory>[−]

Wait for all queues associated with this device to idle.

unsafe fn set_image_name(&self, image: &mut Image, name: &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, buffer: &mut Buffer, name: &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,
    command_buffer: &mut CommandBuffer,
    name: &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, semaphore: &mut Semaphore, name: &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, fence: &mut Fence, name: &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, framebuffer: &mut Framebuffer, name: &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, render_pass: &mut RenderPass, name: &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,
    descriptor_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,
    descriptor_set_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 PipelineLayout,
    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 set_compute_pipeline_name(
    &self,
    compute_pipeline: &mut ComputePipeline,
    name: &str
)[−]

Associate a name with a compute pipeline, 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_graphics_pipeline_name(
    &self,
    graphics_pipeline: &mut GraphicsPipeline,
    name: &str
)[−]

Associate a name with a graphics pipeline, 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,
    fence: &<B as Backend>::Fence
) -> Result<(), OutOfMemory>[−]

Resets a given fence to its original, unsignaled state.

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 Eq for Backend

impl Hash for Backend[+]

[+] Show hidden undocumented items

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 Instance<Backend> for Instance[+]

[+] Show hidden undocumented items

fn create(name: &str, version: u32) -> Result<Self, UnsupportedBackend>[−]

Create a new instance.

fn enumerate_adapters(&self) -> Vec<Adapter<Backend>>[−]

Return all available graphics adapters.

unsafe fn create_surface(
    &self,
    has_handle: &impl HasRawWindowHandle
) -> Result<Surface, InitError>[−]

Create a new surface.

unsafe fn destroy_surface(&self, surface: Surface)[−]

Destroy a surface, freeing the resources associated with it and releasing it from this graphics API.

impl PartialEq<Backend> for Backend[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

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

This method tests for !=.

impl PhysicalDevice<Backend> for PhysicalDevice[+]

[+] Show hidden undocumented items

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, 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 PhysicalDevice. This usually depends on the graphics API being used.

fn hints(&self) -> Hints[−]

Returns the performance hints of this PhysicalDevice.

fn limits(&self) -> Limits[−]

Returns the resource limits of this PhysicalDevice.

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

Check cache compatibility with the PhysicalDevice.

impl StructuralEq for Backend

impl StructuralPartialEq for Backend