Struct gfx_backend_vulkan::Device

pub struct Device { /* fields omitted */ }

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 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: Iterator<Item = Attachment>,
    Is: Iterator<Item = SubpassDesc<'a>>,
    Id: Iterator<Item = SubpassDependency>, 

Create a render pass with the given attachments and subpasses.

unsafe fn create_pipeline_layout<'a, Is, Ic>(
    &self,
    set_layouts: Is,
    push_constant_ranges: Ic
) -> Result<PipelineLayout, OutOfMemory> where
    Is: Iterator<Item = &'a DescriptorSetLayout>,
    Ic: Iterator<Item = (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<'a, I>(
    &self,
    target: &mut PipelineCache,
    sources: I
) -> Result<(), OutOfMemory> where
    I: Iterator<Item = &'a PipelineCache>, 

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_compute_pipeline<'a>(
    &self,
    desc: &ComputePipelineDesc<'a, B>,
    cache: Option<&PipelineCache>
) -> Result<ComputePipeline, CreationError>

Create a compute pipeline.

unsafe fn create_framebuffer<T>(
    &self,
    renderpass: &RenderPass,
    attachments: T,
    extent: Extent
) -> Result<Framebuffer, OutOfMemory> where
    T: Iterator<Item = FramebufferAttachment>, 

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,
    sparse: 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,
    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,
    sparse: SparseFlags,
    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,
    usage: Usage,
    range: SubresourceRange
) -> Result<ImageView, ViewCreationError>

Create an image view from an existing image

unsafe fn create_descriptor_pool<T>(
    &self,
    max_sets: usize,
    descriptor_ranges: T,
    flags: DescriptorPoolCreateFlags
) -> Result<DescriptorPool, OutOfMemory> where
    T: Iterator<Item = DescriptorRangeDesc>, 

Create a descriptor pool.

unsafe fn create_descriptor_set_layout<'a, I, J>(
    &self,
    binding_iter: I,
    immutable_samplers: J
) -> Result<DescriptorSetLayout, OutOfMemory> where
    I: Iterator<Item = DescriptorSetLayoutBinding>,
    J: Iterator<Item = &'a Sampler>, 

Create a descriptor set layout.

unsafe fn write_descriptor_set<'a, I>(&self, op: DescriptorSetWrite<'a, B, I>) where
    I: Iterator<Item = Descriptor<'a, B>>, 

Specifying the parameters of a descriptor set write operation.

unsafe fn copy_descriptor_set<'a>(&self, op: DescriptorSetCopy<'a, B>)

Structure specifying a copy descriptor set operation.

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,
    ranges: I
) -> Result<(), OutOfMemory> where
    I: Iterator<Item = (&'a Memory, Segment)>, 

Flush mapped memory ranges

unsafe fn invalidate_mapped_memory_ranges<'a, I>(
    &self,
    ranges: I
) -> Result<(), OutOfMemory> where
    I: Iterator<Item = (&'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_fence(&self, fence: &mut Fence) -> Result<(), OutOfMemory>

Resets a given fence to its original, unsignaled state.

unsafe fn wait_for_fences<'a, I>(
    &self,
    fences_iter: I,
    wait: WaitFor,
    timeout_ns: u64
) -> Result<bool, WaitError> where
    I: Iterator<Item = &'a 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, WaitError>

Query the status of an event.

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

Sets an event.

unsafe fn reset_event(&self, event: &mut 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: Stride,
    flags: 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 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

fn start_capture(&self)

Starts frame capture.

fn stop_capture(&self)

Stops frame capture.

pub 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.

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

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