Struct Device

Source

pub struct Device {
    pub physical: Box<PhysicalDevice>,
    /* private fields */
}

Expand description

Opaque handle to a device object.

Fields§

§physical: Box<PhysicalDevice>

The selected physical device.

This contains the physical device’s advertised features, properties, limits, memory properties, queue families, and Vulkan extension support. Extension support is exposed with fields named after the Vulkan extension, for example device.physical.vk_khr_acceleration_structure.is_some().

Note: This field is read-only.

Implementations§

Source §

impl Device

Source

pub fn begin_command_buffer( this: &Self, cmd: CommandBuffer, begin_info: &CommandBufferBeginInfo<'_>, ) -> Result<(), DriverError>

Begins recording a command buffer on this device.

This is a thin wrapper around ash::Device::begin_command_buffer that maps Vulkan errors to DriverError variants.

Source

pub fn begin_debug_utils_label( this: &Self, command_buffer: CommandBuffer, label_name: impl AsRef<str>, ) -> Result<(), DriverError>

Begins a Vulkan debug label region on command_buffer when debug labeling is enabled.

Returns without doing any work if debug mode is false.

Source

pub fn cmd_pipeline_barrier2( this: &Self, command_buffer: CommandBuffer, dependency_info: &DependencyInfo<'_>, )

Records a pipeline barrier using the VK_KHR_synchronization2 extension or the Vulkan 1.3 core vkCmdPipelineBarrier2 path.

See vkCmdPipelineBarrier2 and VK_KHR_synchronization2.

Source

pub fn create(info: impl Into<DeviceInfo>) -> Result<Self, DriverError>

Constructs a new device using the given configuration.

This constructor is intended for headless or manually managed setups. It does not infer or enable display platform surface extensions. Use Self::try_from_display when the resulting device must be capable of later surface creation.

Source

pub fn create_fence(this: &Self, signaled: bool) -> Result<Fence, DriverError>

Creates a Vulkan fence on this device.

Pass true for signaled when the fence should begin in the signaled state.

See vkCreateFence.

Source

pub fn create_semaphore(this: &Self) -> Result<Semaphore, DriverError>

Creates a Vulkan binary semaphore on this device.

See vkCreateSemaphore.

Source

pub fn end_command_buffer( this: &Self, cmd: CommandBuffer, ) -> Result<(), DriverError>

Ends recording a command buffer on this device.

This is a thin wrapper around ash::Device::end_command_buffer that maps Vulkan errors to DriverError variants.

See vkEndCommandBuffer.

Source

pub fn end_debug_utils_label( this: &Self, command_buffer: CommandBuffer, ) -> Result<(), DriverError>

Ends a Vulkan debug label region on command_buffer when debug labeling is enabled.

Returns without doing any work if debug mode is false.

Source

pub fn queue_submit( this: &Self, queue: Queue, submits: &[SubmitInfo<'_>], fence: Fence, ) -> Result<(), DriverError>

Submits command buffers to a queue, optionally signaling a fence.

See vkQueueSubmit.

Source

pub fn queue_submit2( this: &Self, queue: Queue, submits: &[SubmitInfo2<'_>], fence: Fence, ) -> Result<(), DriverError>

Submits command buffers to a queue using the VK_KHR_synchronization2 extension or the Vulkan 1.3 core vkQueueSubmit2 path.

See vkQueueSubmit2 and VK_KHR_synchronization2.

Source

pub fn queue_wait_idle(this: &Self, queue: Queue) -> Result<(), DriverError>

Waits for queue idle.

Source

pub fn reset_fences(this: &Self, fences: &[Fence]) -> Result<(), DriverError>

Resets one or more fences to the unsignaled state.

See vkResetFences.

Source

pub fn set_debug_utils_object_name<T>( this: &Self, object_handle: T, object_name: impl AsRef<str>, ) -> Result<(), DriverError>
where T: Handle + Copy,

Assigns a Vulkan debug-utils name to handle when debug labeling is enabled.

Returns without doing any work if debug mode is false.

Source

pub unsafe fn try_from_ash( device: Device, physical_device: PhysicalDevice, ) -> Result<Self, DriverError>

Loads an existing ash Vulkan device that may have been created by other means.

§Safety

device must have been created from physical_device and must have all queues, extensions, and features expected by vk-graph. The device must not be destroyed outside this wrapper while any cloned Device or resources created from it remain alive.

Struct Device Copy item path

Fields§

Implementations§

impl Device

pub fn begin_command_buffer( this: &Self, cmd: CommandBuffer, begin_info: &CommandBufferBeginInfo<'_>, ) -> Result<(), DriverError>

pub fn begin_debug_utils_label( this: &Self, command_buffer: CommandBuffer, label_name: impl AsRef<str>, ) -> Result<(), DriverError>

pub fn cmd_pipeline_barrier2( this: &Self, command_buffer: CommandBuffer, dependency_info: &DependencyInfo<'_>, )

pub fn create(info: impl Into<DeviceInfo>) -> Result<Self, DriverError>

pub fn create_fence(this: &Self, signaled: bool) -> Result<Fence, DriverError>

pub fn create_semaphore(this: &Self) -> Result<Semaphore, DriverError>

pub fn end_command_buffer( this: &Self, cmd: CommandBuffer, ) -> Result<(), DriverError>

pub fn end_debug_utils_label( this: &Self, command_buffer: CommandBuffer, ) -> Result<(), DriverError>

pub fn queue_submit( this: &Self, queue: Queue, submits: &[SubmitInfo<'_>], fence: Fence, ) -> Result<(), DriverError>

pub fn queue_submit2( this: &Self, queue: Queue, submits: &[SubmitInfo2<'_>], fence: Fence, ) -> Result<(), DriverError>

pub fn queue_wait_idle(this: &Self, queue: Queue) -> Result<(), DriverError>

pub fn reset_fences(this: &Self, fences: &[Fence]) -> Result<(), DriverError>

pub fn set_debug_utils_object_name<T>( this: &Self, object_handle: T, object_name: impl AsRef<str>, ) -> Result<(), DriverError>where T: Handle + Copy,

pub unsafe fn try_from_ash( device: Device, physical_device: PhysicalDevice, ) -> Result<Self, DriverError>

§Safety

pub fn try_from_display( display: impl HasDisplayHandle, info: impl Into<DeviceInfo>, ) -> Result<Self, DriverError>

pub fn try_from_physical_device( physical_device: PhysicalDevice, ) -> Result<Self, DriverError>

pub fn try_set_debug_utils_object_name<T>( this: &Self, object_handle: T, object_name: impl AsRef<str>, )where T: Handle + Copy,

pub fn wait_idle(this: &Self) -> Result<(), DriverError>

pub fn with_queue<R>( this: &Self, queue_family_index: u32, queue_index: u32, f: impl FnOnce(Queue) -> R, ) -> R

§Panics

Methods from Deref<Target = Device>§

pub fn handle(&self) -> Device

pub fn fp_v1_3(&self) -> &DeviceFnV1_3

pub unsafe fn create_private_data_slot( &self, create_info: &PrivateDataSlotCreateInfo<'_>, allocation_callbacks: Option<&AllocationCallbacks<'_>>, ) -> Result<PrivateDataSlot, Result>

pub unsafe fn destroy_private_data_slot( &self, private_data_slot: PrivateDataSlot, allocation_callbacks: Option<&AllocationCallbacks<'_>>, )

pub unsafe fn set_private_data<T>( &self, object: T, private_data_slot: PrivateDataSlot, data: u64, ) -> Result<(), Result>where T: Handle,

pub unsafe fn get_private_data<T>( &self, object: T, private_data_slot: PrivateDataSlot, ) -> u64where T: Handle,

pub unsafe fn cmd_pipeline_barrier2( &self, command_buffer: CommandBuffer, dependency_info: &DependencyInfo<'_>, )

pub unsafe fn cmd_reset_event2( &self, command_buffer: CommandBuffer, event: Event, stage_mask: PipelineStageFlags2, )

pub unsafe fn cmd_set_event2( &self, command_buffer: CommandBuffer, event: Event, dependency_info: &DependencyInfo<'_>, )

pub unsafe fn cmd_wait_events2( &self, command_buffer: CommandBuffer, events: &[Event], dependency_infos: &[DependencyInfo<'_>], )

pub unsafe fn cmd_write_timestamp2( &self, command_buffer: CommandBuffer, stage: PipelineStageFlags2, query_pool: QueryPool, query: u32, )

pub unsafe fn queue_submit2( &self, queue: Queue, submits: &[SubmitInfo2<'_>], fence: Fence, ) -> Result<(), Result>

pub unsafe fn cmd_copy_buffer2( &self, command_buffer: CommandBuffer, copy_buffer_info: &CopyBufferInfo2<'_>, )

pub unsafe fn cmd_copy_image2( &self, command_buffer: CommandBuffer, copy_image_info: &CopyImageInfo2<'_>, )

pub unsafe fn cmd_copy_buffer_to_image2( &self, command_buffer: CommandBuffer, copy_buffer_to_image_info: &CopyBufferToImageInfo2<'_>, )

pub unsafe fn cmd_copy_image_to_buffer2( &self, command_buffer: CommandBuffer, copy_image_to_buffer_info: &CopyImageToBufferInfo2<'_>, )

pub unsafe fn cmd_blit_image2( &self, command_buffer: CommandBuffer, blit_image_info: &BlitImageInfo2<'_>, )

pub unsafe fn cmd_resolve_image2( &self, command_buffer: CommandBuffer, resolve_image_info: &ResolveImageInfo2<'_>, )

pub unsafe fn cmd_begin_rendering( &self, command_buffer: CommandBuffer, rendering_info: &RenderingInfo<'_>, )

pub unsafe fn cmd_end_rendering(&self, command_buffer: CommandBuffer)

pub unsafe fn cmd_set_cull_mode( &self, command_buffer: CommandBuffer, cull_mode: CullModeFlags, )

pub unsafe fn cmd_set_front_face( &self, command_buffer: CommandBuffer, front_face: FrontFace, )

pub unsafe fn cmd_set_primitive_topology( &self, command_buffer: CommandBuffer, primitive_topology: PrimitiveTopology, )

pub unsafe fn cmd_set_viewport_with_count( &self, command_buffer: CommandBuffer, viewports: &[Viewport], )

pub unsafe fn cmd_set_scissor_with_count( &self, command_buffer: CommandBuffer, scissors: &[Rect2D], )

pub unsafe fn cmd_bind_vertex_buffers2( &self, command_buffer: CommandBuffer, first_binding: u32, buffers: &[Buffer], offsets: &[u64], sizes: Option<&[u64]>, strides: Option<&[u64]>, )

pub unsafe fn cmd_set_depth_test_enable( &self, command_buffer: CommandBuffer, depth_test_enable: bool, )

pub unsafe fn cmd_set_depth_write_enable( &self, command_buffer: CommandBuffer, depth_write_enable: bool, )

pub unsafe fn cmd_set_depth_compare_op( &self, command_buffer: CommandBuffer, depth_compare_op: CompareOp, )

pub unsafe fn cmd_set_depth_bounds_test_enable( &self, command_buffer: CommandBuffer, depth_bounds_test_enable: bool, )

pub unsafe fn cmd_set_stencil_test_enable( &self, command_buffer: CommandBuffer, stencil_test_enable: bool, )

pub unsafe fn cmd_set_stencil_op( &self, command_buffer: CommandBuffer, face_mask: StencilFaceFlags, fail_op: StencilOp, pass_op: StencilOp, depth_fail_op: StencilOp, compare_op: CompareOp, )

pub unsafe fn cmd_set_rasterizer_discard_enable( &self, command_buffer: CommandBuffer, rasterizer_discard_enable: bool, )

pub unsafe fn cmd_set_depth_bias_enable( &self, command_buffer: CommandBuffer, depth_bias_enable: bool, )

pub unsafe fn cmd_set_primitive_restart_enable( &self, command_buffer: CommandBuffer, primitive_restart_enable: bool, )

pub unsafe fn get_device_buffer_memory_requirements( &self, memory_requirements: &DeviceBufferMemoryRequirements<'_>, out: &mut MemoryRequirements2<'_>, )

pub unsafe fn get_device_image_memory_requirements( &self, memory_requirements: &DeviceImageMemoryRequirements<'_>, out: &mut MemoryRequirements2<'_>, )

pub unsafe fn get_device_image_sparse_memory_requirements_len( &self, memory_requirements: &DeviceImageMemoryRequirements<'_>, ) -> usize

pub unsafe fn get_device_image_sparse_memory_requirements( &self, memory_requirements: &DeviceImageMemoryRequirements<'_>, out: &mut [SparseImageMemoryRequirements2<'_>], )

pub fn fp_v1_2(&self) -> &DeviceFnV1_2

pub unsafe fn cmd_draw_indirect_count( &self, command_buffer: CommandBuffer, buffer: Buffer, offset: u64, count_buffer: Buffer, count_buffer_offset: u64, max_draw_count: u32, stride: u32, )

pub unsafe fn cmd_draw_indexed_indirect_count( &self, command_buffer: CommandBuffer, buffer: Buffer, offset: u64, count_buffer: Buffer, count_buffer_offset: u64, max_draw_count: u32, stride: u32, )

pub unsafe fn create_render_pass2( &self, create_info: &RenderPassCreateInfo2<'_>, allocation_callbacks: Option<&AllocationCallbacks<'_>>, ) -> Result<RenderPass, Result>

pub unsafe fn cmd_begin_render_pass2( &self, command_buffer: CommandBuffer, render_pass_begin_info: &RenderPassBeginInfo<'_>, subpass_begin_info: &SubpassBeginInfo<'_>, )

pub unsafe fn cmd_next_subpass2( &self, command_buffer: CommandBuffer, subpass_begin_info: &SubpassBeginInfo<'_>, subpass_end_info: &SubpassEndInfo<'_>, )

pub unsafe fn cmd_end_render_pass2( &self, command_buffer: CommandBuffer, subpass_end_info: &SubpassEndInfo<'_>, )

pub unsafe fn reset_query_pool( &self, query_pool: QueryPool, first_query: u32, query_count: u32, )

pub unsafe fn get_semaphore_counter_value( &self, semaphore: Semaphore, ) -> Result<u64, Result>

pub unsafe fn wait_semaphores( &self, wait_info: &SemaphoreWaitInfo<'_>, timeout: u64, ) -> Result<(), Result>

pub unsafe fn signal_semaphore( &self, signal_info: &SemaphoreSignalInfo<'_>, ) -> Result<(), Result>

pub unsafe fn get_buffer_device_address( &self, info: &BufferDeviceAddressInfo<'_>, ) -> u64

pub unsafe fn get_buffer_opaque_capture_address( &self, info: &BufferDeviceAddressInfo<'_>, ) -> u64

pub unsafe fn get_device_memory_opaque_capture_address( &self, info: &DeviceMemoryOpaqueCaptureAddressInfo<'_>, ) -> u64

pub fn fp_v1_1(&self) -> &DeviceFnV1_1

Struct Device

pub fn set_debug_utils_object_name<T>( this: &Self, object_handle: T, object_name: impl AsRef<str>, ) -> Result<(), DriverError>
where T: Handle + Copy,

pub fn try_set_debug_utils_object_name<T>( this: &Self, object_handle: T, object_name: impl AsRef<str>, )
where T: Handle + Copy,

pub unsafe fn set_private_data<T>( &self, object: T, private_data_slot: PrivateDataSlot, data: u64, ) -> Result<(), Result>
where T: Handle,

pub unsafe fn get_private_data<T>( &self, object: T, private_data_slot: PrivateDataSlot, ) -> u64
where T: Handle,