Ash

https://docs.rs/ash/latest/
Admin
Ash is a Rust library that provides safe bindings to the Vulkan API, enabling developers to create...
Tokens:1,134,443
Snippets:4,733
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### VK_EXT_acquire_drm_display extension implementation

Source: https://docs.rs/ash/latest/src/ash/extensions/ext/acquire_drm_display.rs.html?search=std%3A%3Avec

Provides unsafe methods to acquire a DRM display and get a DRM display from a physical device and DRM file descriptor. Requires the VK_EXT_acquire_drm_display extension to be enabled.

```rust
//! <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_acquire_drm_display.html>

use crate::prelude::*;
use crate::vk;
use core::mem;

impl crate::ext::acquire_drm_display::Instance {
    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkAcquireDrmDisplayEXT.html>
    #[inline]
    pub unsafe fn acquire_drm_display(
        &self,
        physical_device: vk::PhysicalDevice,
        drm_fd: i32,
        display: vk::DisplayKHR,
    ) -> VkResult<()> {
        (self.fp.acquire_drm_display_ext)(physical_device, drm_fd, display).result()
    }

    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetDrmDisplayEXT.html>
    #[inline]
    pub unsafe fn get_drm_display(
        &self,
        physical_device: vk::PhysicalDevice,
        drm_fd: i32,
        connector_id: u32,
    ) -> VkResult<vk::DisplayKHR> {
        let mut display = mem::MaybeUninit::uninit();
        (self.fp.get_drm_display_ext)(physical_device, drm_fd, connector_id, display.as_mut_ptr())
            .assume_init_on_success(display)
    }
}
```

--------------------------------

### Device::cmd_begin_rendering

Source: https://docs.rs/ash/latest/ash/struct.Device.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Begins rendering with rendering info.

```APIDOC
## Device::cmd_begin_rendering

### Description
Begins rendering with rendering info.

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

### Parameters
- **command_buffer** (CommandBuffer) - Required - The command buffer to record into.
- **rendering_info** (&RenderingInfo<'_>) - Required - The rendering info.
```

--------------------------------

### get_buffer_device_address

Source: https://docs.rs/ash/latest/ash/struct.Device.html?search=

Gets the device address of a buffer.

```APIDOC
## `get_buffer_device_address`

### Description
Gets the device address of a buffer. This is the Vulkan 1.2 version of `vkGetBufferDeviceAddress`.

### Method
`get_buffer_device_address`

### Signature
`pub unsafe fn get_buffer_device_address(&self, info: &BufferDeviceAddressInfo<'_>) -> DeviceAddress`

### Parameters
- `info` (`&BufferDeviceAddressInfo<'_>`) - Structure specifying buffer device address info.

### Returns
- `DeviceAddress` - The device address of the buffer.
```

--------------------------------

### cmd_begin_rendering

Source: https://docs.rs/ash/latest/src/ash/extensions/khr/dynamic_rendering.rs.html?search=

Rust method to begin dynamic rendering on a command buffer.

```APIDOC
## [Rust] cmd_begin_rendering

### Description
Begins a dynamic rendering instance on a command buffer using the VK_KHR_dynamic_rendering extension. This method wraps the Vulkan function `vkCmdBeginRenderingKHR` and is unsafe because it requires the caller to ensure the command buffer is in a valid recording state and the rendering info is valid.

### Method
Rust method call

### Endpoint
`Device::cmd_begin_rendering`

### Parameters
- **command_buffer** (`vk::CommandBuffer`) - Required - The command buffer in which to record the begin rendering command.
- **rendering_info** (`&vk::RenderingInfoKHR<'_>`) - Required - A reference to the rendering info structure describing the rendering parameters.

### Request Example
```rust
let rendering_info = vk::RenderingInfoKHR::default();
unsafe { device.cmd_begin_rendering(command_buffer, &rendering_info) };
```

### Response
No return value. The command is recorded into the command buffer.
```

--------------------------------

### get_private_data

Source: https://docs.rs/ash/latest/ash/struct.Device.html?search=

Gets private data from an object.

```APIDOC
## [Device] [get_private_data]

### Description
Gets private data from an object.

### Method
get_private_data

### Parameters
- **object** (T: Handle) - Required - The object to get private data from.
- **private_data_slot** (PrivateDataSlot) - Required - The private data slot to use.

### Returns
u64 - The private data value.
```

--------------------------------

### vkGetAccelerationStructureBuildSizesKHR

Source: https://docs.rs/ash/latest/src/ash/vk/extensions.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets the build sizes for an acceleration structure.

```APIDOC
## vkGetAccelerationStructureBuildSizesKHR

### Description
Gets the build sizes for an acceleration structure.

### Parameters
- **device** (crate::vk::Device) - The logical device.
- **build_type** (AccelerationStructureBuildTypeKHR) - The type of build (host or device).
- **p_build_info** (*const AccelerationStructureBuildGeometryInfoKHR) - Pointer to an AccelerationStructureBuildGeometryInfoKHR structure specifying the build.
- **p_max_primitive_counts** (*const u32) - Pointer to an array of maximum primitive counts.
- **p_size_info** (*mut AccelerationStructureBuildSizesInfoKHR) - Pointer to an AccelerationStructureBuildSizesInfoKHR structure that will receive the sizes.

```

--------------------------------

### instance

Source: https://docs.rs/ash/latest/ash/khr/display/struct.Instance.html?search=

Returns the underlying Vulkan instance handle.

```APIDOC
## instance

### Description
Returns the underlying Vulkan instance handle.

### Method
Getter

### Signature
```rust
pub fn instance(&self) -> Instance
```

### Parameters
- **self** (&Instance) - Required - The Instance.

### Returns
- **Instance** - The Vulkan instance handle.
```

--------------------------------

### vkGetAccelerationStructureDeviceAddressKHR

Source: https://docs.rs/ash/latest/src/ash/vk/extensions.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets the device address of an acceleration structure.

```APIDOC
## vkGetAccelerationStructureDeviceAddressKHR

### Description
Gets the device address of an acceleration structure.

### Parameters
- **device** (crate::vk::Device) - The logical device that owns the acceleration structure.
- **p_info** (*const AccelerationStructureDeviceAddressInfoKHR) - Pointer to an AccelerationStructureDeviceAddressInfoKHR structure specifying the acceleration structure.

### Returns
- **DeviceAddress** - The device address of the acceleration structure.

```

--------------------------------

### Create Win32 Surface and Check Presentation Support

Source: https://docs.rs/ash/latest/src/ash/extensions/khr/win32_surface.rs.html?search=

Provides the implementation for creating a Win32 surface and querying physical device presentation support via the VK_KHR_win32_surface extension.

```rust
//! <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_win32_surface.html>

use crate::prelude::*;
use crate::vk;
use crate::RawPtr;
use core::mem;

impl crate::khr::win32_surface::Instance {
    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCreateWin32SurfaceKHR.html>
    #[inline]
    pub unsafe fn create_win32_surface(
        &self,
        create_info: &vk::Win32SurfaceCreateInfoKHR<'_>,
        allocation_callbacks: Option<&vk::AllocationCallbacks<'_>>,
    ) -> VkResult<vk::SurfaceKHR> {
        let mut surface = mem::MaybeUninit::uninit();
        (self.fp.create_win32_surface_khr)(
            self.handle,
            create_info,
            allocation_callbacks.as_raw_ptr(),
            surface.as_mut_ptr(),
        )
        .assume_init_on_success(surface)
    }

    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceWin32PresentationSupportKHR.html>
    #[inline]
    pub unsafe fn get_physical_device_win32_presentation_support(
        &self,
        physical_device: vk::PhysicalDevice,
        queue_family_index: u32,
    ) -> bool {
        let b = (self.fp.get_physical_device_win32_presentation_support_khr)(
            physical_device,
            queue_family_index,
        );

        b > 0
    }
}
```

--------------------------------

### get_buffer_opaque_capture_address

Source: https://docs.rs/ash/latest/ash/struct.Device.html?search=

Gets the opaque capture address of a buffer.

```APIDOC
## `get_buffer_opaque_capture_address`

### Description
Gets the opaque capture address of a buffer. This is the Vulkan 1.2 version of `vkGetBufferOpaqueCaptureAddress`.

### Method
`get_buffer_opaque_capture_address`

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

### Parameters
- `info` (`&BufferDeviceAddressInfo<'_>`) - Structure specifying buffer device address info.

### Returns
- `u64` - The opaque capture address of the buffer.
```

--------------------------------

### cmd_begin_render_pass2

Source: https://docs.rs/ash/latest/ash/struct.Device.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Begins a render pass instance using the VK_KHR_create_renderpass2 extension.

```APIDOC
## cmd_begin_render_pass2

### Description
Begins a render pass instance using the VK_KHR_create_renderpass2 extension.

### Method
Vulkan Command

### Parameters
- **command_buffer** (CommandBuffer) - The command buffer into which the command will be recorded.
- **render_pass_begin_info** (RenderPassBeginInfo) - The structure describing the render pass begin information.
- **subpass_begin_info** (SubpassBeginInfo) - The structure describing the subpass begin information.

### Returns
Void
```

--------------------------------

### new

Source: https://docs.rs/ash/latest/ash/khr/display/struct.Instance.html?search=

Creates a new Instance for the VK_KHR_display extension.

```APIDOC
## new

### Description
Creates a new Instance for the VK_KHR_display extension.

### Method
Constructor

### Signature
```rust
pub fn new(entry: &Entry, instance: &Instance) -> Self
```

### Parameters
- **entry** (&Entry) - Required - The Vulkan entry point.
- **instance** (&Instance) - Required - The parent Vulkan instance.

### Returns
- **Self** - The new Instance.
```

--------------------------------

### get_semaphore_counter_value

Source: https://docs.rs/ash/latest/ash/struct.Device.html?search=

Gets the current value of a semaphore counter.

```APIDOC
## `get_semaphore_counter_value`

### Description
Gets the current value of a semaphore counter. This is the Vulkan 1.2 version of `vkGetSemaphoreCounterValue`.

### Method
`get_semaphore_counter_value`

### Signature
`pub unsafe fn get_semaphore_counter_value(&self, semaphore: Semaphore) -> VkResult<u64>`

### Parameters
- `semaphore` (Semaphore) - The semaphore whose counter value is queried.

### Returns
- `VkResult<u64>` - The current counter value or an error.
```

--------------------------------

### cmd_begin_rendering

Source: https://docs.rs/ash/latest/ash/struct.Device.html?search=

Begins a rendering pass.

```APIDOC
## [Device] [cmd_begin_rendering]

### Description
Begins a rendering pass.

### Method
cmd_begin_rendering

### Parameters
- **command_buffer** (CommandBuffer) - Required - The command buffer to record the begin.
- **rendering_info** (&RenderingInfo<'_>) - Required - The rendering information.
```

--------------------------------

### get_acceleration_structure_build_sizes

Source: https://docs.rs/ash/latest/ash/khr/acceleration_structure/struct.Device.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets the build sizes for an acceleration structure.

```APIDOC
## get_acceleration_structure_build_sizes

### Description
Gets the build sizes for an acceleration structure.

### Method
unsafe fn

### Signature
pub unsafe fn get_acceleration_structure_build_sizes(
    &self,
    build_type: AccelerationStructureBuildTypeKHR,
    build_info: &AccelerationStructureBuildGeometryInfoKHR<'_>,
    max_primitive_counts: &[u32],
    size_info: &mut AccelerationStructureBuildSizesInfoKHR<'_>,
)

### Parameters
- **build_type** (AccelerationStructureBuildTypeKHR) - Required - The build type.
- **build_info** (&AccelerationStructureBuildGeometryInfoKHR) - Required - Pointer to a structure describing the build.
- **max_primitive_counts** (&[u32]) - Required - Array of maximum primitive counts.
- **size_info** (&mut AccelerationStructureBuildSizesInfoKHR) - Required - Pointer to a structure that receives the sizes.
```

--------------------------------

### get_acceleration_structure_device_address

Source: https://docs.rs/ash/latest/ash/khr/acceleration_structure/struct.Device.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets the device address of an acceleration structure.

```APIDOC
## get_acceleration_structure_device_address

### Description
Gets the device address of an acceleration structure.

### Method
unsafe fn

### Signature
pub unsafe fn get_acceleration_structure_device_address(
    &self,
    info: &AccelerationStructureDeviceAddressInfoKHR<'_>,
) -> DeviceAddress

### Parameters
- **info** (&AccelerationStructureDeviceAddressInfoKHR) - Required - Pointer to a structure describing the acceleration structure.

### Returns
- **DeviceAddress** - The device address of the acceleration structure.
```

--------------------------------

### ash xlib_surface.rs: VK_KHR_xlib_surface Instance methods

Source: https://docs.rs/ash/latest/src/ash/extensions/khr/xlib_surface.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

This is the full source of the ash-0.38.0+1.3.281 xlib_surface.rs file. It implements the VK_KHR_xlib_surface extension's Instance methods: create_xlib_surface and get_physical_device_xlib_presentation_support. Both methods are unsafe and call the corresponding Vulkan function pointers from self.fp. The create_xlib_surface method uses mem::MaybeUninit and assume_init_on_success to handle the output surface. The get_physical_device_xlib_presentation_support method returns a bool by checking if the Vulkan function's return value is greater than 0.

```rust
1//! <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_xlib_surface.html>
2
3use crate::prelude::*;
4use crate::vk;
5use crate::RawPtr;
6use core::mem;
7
8impl crate::khr::xlib_surface::Instance {
9    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCreateXlibSurfaceKHR.html>
10    #[inline]
11    pub unsafe fn create_xlib_surface(
12        &self,
13        create_info: &vk::XlibSurfaceCreateInfoKHR<'_>,
14        allocation_callbacks: Option<&vk::AllocationCallbacks<'_>>,
15    ) -> VkResult<vk::SurfaceKHR> {
16        let mut surface = mem::MaybeUninit::uninit();
17        (self.fp.create_xlib_surface_khr)(
18            self.handle,
19            create_info,
20            allocation_callbacks.as_raw_ptr(),
21            surface.as_mut_ptr(),
22        )
23        .assume_init_on_success(surface)
24    }
25
26    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceXlibPresentationSupportKHR.html>
27    #[inline]
28    pub unsafe fn get_physical_device_xlib_presentation_support(
29        &self,
30        physical_device: vk::PhysicalDevice,
31        queue_family_index: u32,
32        display: *mut vk::Display,
33        visual_id: vk::VisualID,
34    ) -> bool {
35        let b = (self.fp.get_physical_device_xlib_presentation_support_khr)(
36            physical_device,
37            queue_family_index,
38            display,
39            visual_id,
40        );
41
42        b > 0
43    }
44}

```

--------------------------------

### PFN_vkGetPrivateData

Source: https://docs.rs/ash/latest/src/ash/vk/extensions.rs.html?search=u32+-%3E+bool

Function pointer type for getting private data.

```APIDOC
## PFN_vkGetPrivateData

### Description
Function pointer type for getting private data. It retrieves private data from an object.

### Signature
```rust
pub type PFN_vkGetPrivateData = unsafe extern "system" fn(
    device: crate::vk::Device,
    object_type: ObjectType,
    object_handle: u64,
    private_data_slot: PrivateDataSlot,
    p_data: *mut u64,
);
```

### Parameters
- **device** (crate::vk::Device) - The device that owns the object.
- **object_type** (ObjectType) - The type of the object.
- **object_handle** (u64) - The handle of the object.
- **private_data_slot** (PrivateDataSlot) - The private data slot to get data from.
- **p_data** (*mut u64) - Pointer to a u64 to receive the data.
```

--------------------------------

### Implement VK_KHR_win32_surface extension wrappers

Source: https://docs.rs/ash/latest/src/ash/extensions/khr/win32_surface.rs.html

The full source of the win32_surface.rs module. It implements the VK_KHR_win32_surface extension for the ash crate, providing unsafe wrappers for vkCreateWin32SurfaceKHR and vkGetPhysicalDeviceWin32PresentationSupportKHR. The create_win32_surface function initializes a SurfaceKHR via MaybeUninit and assumes success, while the presentation support function returns true when the native call returns a non-zero value.

```rust
1//! <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_win32_surface.html>
2
3use crate::prelude::*;
4use crate::vk;
5use crate::RawPtr;
6use core::mem;
7
8impl crate::khr::win32_surface::Instance {
9    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCreateWin32SurfaceKHR.html>
10    #[inline]
11    pub unsafe fn create_win32_surface(
12        &self,
13        create_info: &vk::Win32SurfaceCreateInfoKHR<'_>,
14        allocation_callbacks: Option<&vk::AllocationCallbacks<'_>>,
15    ) -> VkResult<vk::SurfaceKHR> {
16        let mut surface = mem::MaybeUninit::uninit();
17        (self.fp.create_win32_surface_khr)(
18            self.handle,
19            create_info,
20            allocation_callbacks.as_raw_ptr(),
21            surface.as_mut_ptr(),
22        )
23        .assume_init_on_success(surface)
24    }
25
26    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceWin32PresentationSupportKHR.html>
27    #[inline]
28    pub unsafe fn get_physical_device_win32_presentation_support(
29        &self,
30        physical_device: vk::PhysicalDevice,
31        queue_family_index: u32,
32    ) -> bool {
33        let b = (self.fp.get_physical_device_win32_presentation_support_khr)(
34            physical_device,
35            queue_family_index,
36        );
37
38        b > 0
39    }
40}
```

--------------------------------

### vkGetDeviceAccelerationStructureCompatibilityKHR

Source: https://docs.rs/ash/latest/src/ash/vk/extensions.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets the acceleration structure compatibility for a given version.

```APIDOC
## vkGetDeviceAccelerationStructureCompatibilityKHR

### Description
Gets the acceleration structure compatibility for a given version.

### Parameters
- **device** (crate::vk::Device) - The logical device.
- **p_version_info** (*const AccelerationStructureVersionInfoKHR) - Pointer to an AccelerationStructureVersionInfoKHR structure specifying the version.
- **p_compatibility** (*mut AccelerationStructureCompatibilityKHR) - Pointer to a value that will receive the compatibility result.

```

--------------------------------

### Device::from_parts_1_3

Source: https://docs.rs/ash/latest/src/ash/device.rs.html

Constructs a Device from pre-loaded function tables for Vulkan 1.0 through 1.3.

```APIDOC
## Device::from_parts_1_3

### Description
Constructs a Device from pre-loaded function tables for Vulkan 1.0 through 1.3.

### Method
pub fn from_parts_1_3(handle: vk::Device, device_fn_1_0: crate::DeviceFnV1_0, device_fn_1_1: crate::DeviceFnV1_1, device_fn_1_2: crate::DeviceFnV1_2, device_fn_1_3: crate::DeviceFnV1_3) -> Self

### Parameters
- **handle** (vk::Device) - Required - The Vulkan device handle.
- **device_fn_1_0** (crate::DeviceFnV1_0) - Required - Function table for Vulkan 1.0.
- **device_fn_1_1** (crate::DeviceFnV1_1) - Required - Function table for Vulkan 1.1.
- **device_fn_1_2** (crate::DeviceFnV1_2) - Required - Function table for Vulkan 1.2.
- **device_fn_1_3** (crate::DeviceFnV1_3) - Required - Function table for Vulkan 1.3.

### Returns
- **Self** - A new Device instance.
```

--------------------------------

### get_fence_win32_handle

Source: https://docs.rs/ash/latest/src/ash/extensions/khr/external_fence_win32.rs.html

Gets a Win32 handle for a fence. This corresponds to vkGetFenceWin32HandleKHR.

```APIDOC
## get_fence_win32_handle

### Description
Gets a Win32 handle for a fence. This corresponds to vkGetFenceWin32HandleKHR.

### Method
unsafe fn get_fence_win32_handle(&self, get_info: &vk::FenceGetWin32HandleInfoKHR<'_>) -> VkResult<vk::HANDLE>

### Parameters
- **get_info** (&vk::FenceGetWin32HandleInfoKHR<'_>) - Required - Structure specifying the fence handle export operation.

### Returns
VkResult<vk::HANDLE> - Result containing the Win32 handle.
```

--------------------------------

### begin_command_buffer

Source: https://docs.rs/ash/latest/ash/struct.Device.html?search=

Begins recording a command buffer.

```APIDOC
## begin_command_buffer

### Description
Begins recording a command buffer.

### Method
unsafe fn

### Signature
pub unsafe fn begin_command_buffer(&self, command_buffer: CommandBuffer, begin_info: &CommandBufferBeginInfo<'_>) -> VkResult<()>

### Parameters
- **command_buffer** (CommandBuffer) - Required - The command buffer to begin.
- **begin_info** (&CommandBufferBeginInfo<'_>) - Required - The structure specifying the begin parameters.

### Returns
- **VkResult<()>** - Success or an error.
```

--------------------------------

### get_physical_device_surface_present_modes2

Source: https://docs.rs/ash/latest/src/ash/extensions/ext/full_screen_exclusive.rs.html

Gets the present modes for a physical device surface.

```APIDOC
## get_physical_device_surface_present_modes2

### Description
Gets the present modes for a physical device surface. This is a Vulkan extension function.

### Method
unsafe fn get_physical_device_surface_present_modes2(&self, physical_device: vk::PhysicalDevice, surface_info: &vk::PhysicalDeviceSurfaceInfo2KHR<'_>) -> VkResult<Vec<vk::PresentModeKHR>>

### Parameters
- **physical_device** (vk::PhysicalDevice) - Required - The physical device to query.
- **surface_info** (vk::PhysicalDeviceSurfaceInfo2KHR) - Required - The surface info to query.

### Returns
- **VkResult<Vec<vk::PresentModeKHR>>** - A vector of present modes.

```

--------------------------------

### cmd_begin_render_pass2

Source: https://docs.rs/ash/latest/ash/struct.Device.html?search=

Begins a render pass with Vulkan 1.2 extended info.

```APIDOC
## `cmd_begin_render_pass2`

### Description
Begins a render pass with Vulkan 1.2 extended subpass begin info. This is the Vulkan 1.2 version of `vkCmdBeginRenderPass2`.

### Method
`cmd_begin_render_pass2`

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

### Parameters
- `command_buffer` (CommandBuffer) - The command buffer into which the command is recorded.
- `render_pass_begin_info` (`&RenderPassBeginInfo<'_>`) - Structure specifying the render pass begin info.
- `subpass_begin_info` (`&SubpassBeginInfo<'_>`) - Structure specifying subpass begin info.

### Returns
None.
```

--------------------------------

### get_device_group_surface_present_modes2

Source: https://docs.rs/ash/latest/src/ash/extensions/ext/full_screen_exclusive.rs.html

Gets the present modes for a surface in a device group.

```APIDOC
## get_device_group_surface_present_modes2

### Description
Gets the present modes for a surface in a device group. This is a Vulkan extension function.

### Method
unsafe fn get_device_group_surface_present_modes2(&self, surface_info: &vk::PhysicalDeviceSurfaceInfo2KHR<'_>) -> VkResult<vk::DeviceGroupPresentModeFlagsKHR>

### Parameters
- **surface_info** (vk::PhysicalDeviceSurfaceInfo2KHR) - Required - The surface info to query.

### Returns
- **VkResult<vk::DeviceGroupPresentModeFlagsKHR>** - The present mode flags.

```

--------------------------------

### Device::from_parts_1_3

Source: https://docs.rs/ash/latest/src/ash/device.rs.html?search=

Constructs a Device from pre-loaded function pointer tables.

```APIDOC
## Device::from_parts_1_3

### Description
Constructs a Device from pre-loaded function pointer tables for Vulkan 1.0, 1.1, 1.2, and 1.3.

### Method
pub fn from_parts_1_3(handle: vk::Device, device_fn_1_0: crate::DeviceFnV1_0, device_fn_1_1: crate::DeviceFnV1_1, device_fn_1_2: crate::DeviceFnV1_2, device_fn_1_3: crate::DeviceFnV1_3) -> Self

### Parameters
- **handle** (vk::Device) - Required - The Vulkan device handle.
- **device_fn_1_0** (crate::DeviceFnV1_0) - Required - Function pointers for Vulkan 1.0.
- **device_fn_1_1** (crate::DeviceFnV1_1) - Required - Function pointers for Vulkan 1.1.
- **device_fn_1_2** (crate::DeviceFnV1_2) - Required - Function pointers for Vulkan 1.2.
- **device_fn_1_3** (crate::DeviceFnV1_3) - Required - Function pointers for Vulkan 1.3.

### Returns
- **Self** - A new Device instance.

### Example
```rust
let device = Device::from_parts_1_3(handle, fn_1_0, fn_1_1, fn_1_2, fn_1_3);
```
```

--------------------------------

### ash khr::xcb_surface Instance methods

Source: https://docs.rs/ash/latest/src/ash/extensions/khr/xcb_surface.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

The full source of the xcb_surface.rs file, containing two unsafe methods for the VK_KHR_xcb_surface extension. create_xcb_surface wraps vkCreateXcbSurfaceKHR and returns a VkResult<SurfaceKHR>, while get_physical_device_xcb_presentation_support wraps vkGetPhysicalDeviceXcbPresentationSupportKHR and returns a bool indicating support.

```rust
//! <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_xcb_surface.html>

use crate::prelude::*;
use crate::vk;
use crate::RawPtr;
use core::mem;

impl crate::khr::xcb_surface::Instance {
    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCreateXcbSurfaceKHR.html>
    #[inline]
    pub unsafe fn create_xcb_surface(
        &self,
        create_info: &vk::XcbSurfaceCreateInfoKHR<'_>,
        allocation_callbacks: Option<&vk::AllocationCallbacks<'_>>,
    ) -> VkResult<vk::SurfaceKHR> {
        let mut surface = mem::MaybeUninit::uninit();
        (self.fp.create_xcb_surface_khr)(
            self.handle,
            create_info,
            allocation_callbacks.as_raw_ptr(),
            surface.as_mut_ptr(),
        )
        .assume_init_on_success(surface)
    }

    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceXcbPresentationSupportKHR.html>
    #[inline]
    pub unsafe fn get_physical_device_xcb_presentation_support(
        &self,
        physical_device: vk::PhysicalDevice,
        queue_family_index: u32,
        connection: &mut vk::xcb_connection_t,
        visual_id: vk::xcb_visualid_t,
    ) -> bool {
        let b = (self.fp.get_physical_device_xcb_presentation_support_khr)(
            physical_device,
            queue_family_index,
            connection,
            visual_id,
        );

        b > 0
    }
}

```

--------------------------------

### get_device_group_peer_memory_features

Source: https://docs.rs/ash/latest/src/ash/device.rs.html

Gets the peer memory features for a device group.

```APIDOC
## get_device_group_peer_memory_features

### Description
Gets the peer memory features for a device group.

### Method
unsafe fn

### Signature
`pub unsafe fn get_device_group_peer_memory_features(&self, heap_index: u32, local_device_index: u32, remote_device_index: u32) -> vk::PeerMemoryFeatureFlags`

### Parameters
- **heap_index** (u32) - Required - The heap index.
- **local_device_index** (u32) - Required - The local device index.
- **remote_device_index** (u32) - Required - The remote device index.

### Returns
- **vk::PeerMemoryFeatureFlags** - The peer memory feature flags.
```

--------------------------------

### Device::get_private_data

Source: https://docs.rs/ash/latest/ash/struct.Device.html?search=u32+-%3E+bool

Gets private data from a Vulkan object.

```APIDOC
## Device::get_private_data

### Description
Gets private data from a Vulkan object. This is an unsafe function that must be called with a valid device.

### Method
unsafe fn

### Signature
```rust
pub unsafe fn get_private_data<T: Handle>(&self, object: T, private_data_slot: PrivateDataSlot) -> u64
```

### Parameters
- **object** (`T`) - Required - The Vulkan object to get private data from.
- **private_data_slot** (`PrivateDataSlot`) - Required - The private data slot.

### Returns
- **u64** - The private data value.
```

--------------------------------

### create_ios_surface

Source: https://docs.rs/ash/latest/src/ash/extensions/mvk/ios_surface.rs.html

Documentation for the `create_ios_surface` method of the `Instance` struct in the `ash` crate's `mvk::ios_surface` module.

```APIDOC
## create_ios_surface

### Description
Creates a Vulkan surface for an iOS view. This function is part of the VK_MVK_ios_surface extension and is used to integrate Vulkan rendering with iOS applications.

### Method
unsafe fn create_ios_surface

### Signature
```rust
pub unsafe fn create_ios_surface(
    &self,
    create_info: &vk::IOSSurfaceCreateInfoMVK<'_>,
    allocation_callbacks: Option<&vk::AllocationCallbacks<'_>>,
) -> VkResult<vk::SurfaceKHR>
```

### Parameters
- **create_info** (`&vk::IOSSurfaceCreateInfoMVK<'_>`) - Required - Pointer to a structure containing information about the iOS surface to be created.
- **allocation_callbacks** (`Option<&vk::AllocationCallbacks<'_>>`) - Optional - Pointer to allocation callbacks that control host memory allocation.

### Returns
- **VkResult<vk::SurfaceKHR>** - A Vulkan result indicating success or failure, and on success, the handle to the created surface.

### Safety
This function is unsafe because it dereferences raw pointers and requires that the provided `create_info` and `allocation_callbacks` are valid and point to valid Vulkan objects.
```

--------------------------------

### get_device_acceleration_structure_compatibility

Source: https://docs.rs/ash/latest/ash/khr/acceleration_structure/struct.Device.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets the compatibility of an acceleration structure version with the device.

```APIDOC
## get_device_acceleration_structure_compatibility

### Description
Gets the compatibility of an acceleration structure version with the device.

### Method
unsafe fn

### Signature
pub unsafe fn get_device_acceleration_structure_compatibility(
    &self,
    version: &AccelerationStructureVersionInfoKHR<'_>,
) -> AccelerationStructureCompatibilityKHR

### Parameters
- **version** (&AccelerationStructureVersionInfoKHR) - Required - Pointer to a structure describing the version.

### Returns
- **AccelerationStructureCompatibilityKHR** - The compatibility result.
```

--------------------------------

### cmd_begin_query

Source: https://docs.rs/ash/latest/ash/struct.Device.html?search=

Begins a query.

```APIDOC
## cmd_begin_query

### Description
Begins a query.

### Method
unsafe fn

### Signature
pub unsafe fn cmd_begin_query(&self, command_buffer: CommandBuffer, query_pool: QueryPool, query: u32, flags: QueryControlFlags)

### Parameters
- **command_buffer** (CommandBuffer) - The command buffer to record the command into.
- **query_pool** (QueryPool) - The query pool that the query belongs to.
- **query** (u32) - The query index.
- **flags** (QueryControlFlags) - Flags controlling query behavior.

### Vulkan Reference
https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdBeginQuery.html
```

--------------------------------

### vkGetRayTracingShaderGroupHandlesKHR

Source: https://docs.rs/ash/latest/src/ash/vk/extensions.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets the shader group handles for a ray tracing pipeline.

```APIDOC
## vkGetRayTracingShaderGroupHandlesKHR

### Description
Gets the shader group handles for a ray tracing pipeline.

### Parameters
- **device** (crate::vk::Device) - The logical device.
- **pipeline** (Pipeline) - The ray tracing pipeline.
- **first_group** (u32) - The first group index.
- **group_count** (u32) - The number of groups.
- **data_size** (usize) - The size of the data buffer.
- **p_data** (*mut c_void) - Pointer to a buffer that will receive the handles.

### Returns
- **Result** - The result of the operation.

```

--------------------------------

### create_mac_os_surface

Source: https://docs.rs/ash/latest/src/ash/extensions/mvk/macos_surface.rs.html?search=std%3A%3Avec

Documentation for the `create_mac_os_surface` method of the `Instance` struct in the `ash` crate's `mvk::macos_surface` module, which creates a macOS surface for a Vulkan instance.

```APIDOC
## create_mac_os_surface

### Description
Creates a macOS surface for a Vulkan instance, as specified by the VK_MVK_macos_surface extension. This function is unsafe and must be called with valid pointers and a valid instance handle.

### Method
unsafe fn create_mac_os_surface

### Signature
```rust
pub unsafe fn create_mac_os_surface(
    &self,
    create_info: &vk::MacOSSurfaceCreateInfoMVK<'_>,
    allocation_callbacks: Option<&vk::AllocationCallbacks<'_>>,
) -> VkResult<vk::SurfaceKHR>
```

### Parameters
- **create_info** (`&vk::MacOSSurfaceCreateInfoMVK<'_>`) - Required - Pointer to a structure containing information about the macOS surface to create.
- **allocation_callbacks** (`Option<&vk::AllocationCallbacks<'_>>`) - Optional - Pointer to allocation callbacks to use for host memory allocation, or `None` to use default allocation.

### Returns
- **VkResult<vk::SurfaceKHR>** - On success, returns `VkResult::Ok` containing the created `SurfaceKHR` handle. On failure, returns a Vulkan error code.

### Safety
This function is unsafe because it dereferences raw pointers and requires the caller to ensure that the instance handle and the provided structures are valid and that the Vulkan instance is properly initialized.
```

--------------------------------

### vkGetFenceFdKHR

Source: https://docs.rs/ash/latest/src/ash/vk/extensions.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets a file descriptor for a fence as part of the VK_KHR_external_fence_fd extension.

```APIDOC
## vkGetFenceFdKHR

### Description
Gets a file descriptor for a fence. This is part of the VK_KHR_external_fence_fd extension.

### Function Signature
```rust
pub type PFN_vkGetFenceFdKHR = unsafe extern "system" fn(
    device: crate::vk::Device,
    p_get_fd_info: *const FenceGetFdInfoKHR<'_>,
    p_fd: *mut c_int,
) -> Result;
```

### Parameters
- **device** (crate::vk::Device) - Required - The logical device that owns the fence.
- **p_get_fd_info** (*const FenceGetFdInfoKHR<'_>) - Required - Pointer to a structure describing the file descriptor to get.
- **p_fd** (*mut c_int) - Required - Pointer to an integer in which the file descriptor is returned.

### Return Value
- **Result** - Returns VkResult indicating success or failure.

```

--------------------------------

### Device::from_parts_1_3

Source: https://docs.rs/ash/latest/ash/struct.Device.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Constructs a Device from its handle and function tables for Vulkan 1.0 through 1.3.

```APIDOC
## Device::from_parts_1_3

### Description
Constructs a Device from its handle and function tables for Vulkan 1.0 through 1.3.

### Method
pub fn from_parts_1_3(handle: Device, device_fn_1_0: DeviceFnV1_0, device_fn_1_1: DeviceFnV1_1, device_fn_1_2: DeviceFnV1_2, device_fn_1_3: DeviceFnV1_3) -> Self

### Parameters
- **handle** (Device) - Required - The Vulkan device handle.
- **device_fn_1_0** (DeviceFnV1_0) - Required - Function table for Vulkan 1.0.
- **device_fn_1_1** (DeviceFnV1_1) - Required - Function table for Vulkan 1.1.
- **device_fn_1_2** (DeviceFnV1_2) - Required - Function table for Vulkan 1.2.
- **device_fn_1_3** (DeviceFnV1_3) - Required - Function table for Vulkan 1.3.

### Returns
- **Self** - The constructed Device instance.
```

--------------------------------

### PFN_vkGetPipelineCacheData

Source: https://docs.rs/ash/latest/src/ash/vk/features.rs.html

Function pointer type for getting the data from a pipeline cache.

```APIDOC
## PFN_vkGetPipelineCacheData

### Description
Function pointer type for getting the data from a pipeline cache.

### Signature
```rust
pub type PFN_vkGetPipelineCacheData = unsafe extern "system" fn(
    device: crate::vk::Device,
    pipeline_cache: PipelineCache,
    p_data_size: *mut usize,
    p_data: *mut c_void,
) -> Result;
```

### Parameters
- **device** (crate::vk::Device) - The logical device that owns the pipeline cache.
- **pipeline_cache** (PipelineCache) - The pipeline cache to retrieve data from.
- **p_data_size** (*mut usize) - Pointer to a size value, in/out.
- **p_data** (*mut c_void) - Pointer to a buffer to receive the cache data.

### Return
Result
```

--------------------------------

### Rust: khr::dynamic_rendering::Device impl with cmd_begin_rendering and cmd_end_rendering

Source: https://docs.rs/ash/latest/src/ash/extensions/khr/dynamic_rendering.rs.html?search=u32+-%3E+bool

Defines the Device implementation for the KHR dynamic rendering extension. Provides unsafe wrappers around vkCmdBeginRenderingKHR and vkCmdEndRenderingKHR that call through the stored function pointers. Use these methods to begin and end dynamic rendering on a command buffer.

```rust
//! <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_dynamic_rendering.html>

use crate::vk;

impl crate::khr::dynamic_rendering::Device {
    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdBeginRenderingKHR.html>
    #[inline]
    pub unsafe fn cmd_begin_rendering(
        &self,
        command_buffer: vk::CommandBuffer,
        rendering_info: &vk::RenderingInfoKHR<'_>,
    ) {
        (self.fp.cmd_begin_rendering_khr)(command_buffer, rendering_info)
    }

    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdEndRenderingKHR.html>
    #[inline]
    pub unsafe fn cmd_end_rendering(&self, command_buffer: vk::CommandBuffer) {
        (self.fp.cmd_end_rendering_khr)(command_buffer)
   { 
```

--------------------------------

### begin_command_buffer

Source: https://docs.rs/ash/latest/src/ash/device.rs.html

Begins recording a command buffer. This is a direct wrapper around the Vulkan function vkBeginCommandBuffer.

```APIDOC
## begin_command_buffer

### Description
Begins recording a command buffer. This is a direct wrapper around the Vulkan function vkBeginCommandBuffer.

### Method
unsafe fn

### Signature
pub unsafe fn begin_command_buffer(&self, command_buffer: vk::CommandBuffer, begin_info: &vk::CommandBufferBeginInfo<'_>) -> VkResult<()>

### Parameters
- **command_buffer** (vk::CommandBuffer) - Required - The command buffer to begin recording.
- **begin_info** (vk::CommandBufferBeginInfo<'_>) - Required - Describes the initial state of the command buffer.

### Returns
- **VkResult<()>** - Success or an error code.

### Reference
<https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkBeginCommandBuffer.html>
```

--------------------------------

### get_acceleration_structure_memory_requirements

Source: https://docs.rs/ash/latest/src/ash/extensions/nv/ray_tracing.rs.html?search=u32+-%3E+bool

Gets the memory requirements for an acceleration structure as defined by vkGetAccelerationStructureMemoryRequirementsNV.

```APIDOC
## get_acceleration_structure_memory_requirements

### Description
Retrieves the memory requirements for a given acceleration structure.

### Method
unsafe fn get_acceleration_structure_memory_requirements

### Parameters
- **info** (vk::AccelerationStructureMemoryRequirementsInfoNV<'_>) - Required - The information specifying the acceleration structure and type of memory requirements.

### Returns
vk::MemoryRequirements2KHR<'_> - The memory requirements.
```

--------------------------------

### create_vi_surface

Source: https://docs.rs/ash/latest/src/ash/extensions/nn/vi_surface.rs.html?search=std%3A%3Avec

Documentation for the `create_vi_surface` method of the `Instance` struct in the `ash` crate's `nn::vi_surface` module.

```APIDOC
## create_vi_surface

### Description
Creates a Vulkan surface for the NN platform using the VK_NN_vi_surface extension. This method wraps the `vkCreateViSurfaceNN` Vulkan function.

### Method
unsafe fn create_vi_surface

### Signature
```rust
pub unsafe fn create_vi_surface(
    &self,
    create_info: &vk::ViSurfaceCreateInfoNN<'_>,
    allocation_callbacks: Option<&vk::AllocationCallbacks<'_>>,
) -> VkResult<vk::SurfaceKHR>
```

### Parameters
- **create_info** (`&vk::ViSurfaceCreateInfoNN<'_>`) - Required - Pointer to a structure containing information about the surface to create.
- **allocation_callbacks** (`Option<&vk::AllocationCallbacks<'_>>`) - Optional - Pointer to allocation callbacks for host memory allocation.

### Returns
- **VkResult<vk::SurfaceKHR>** - Result containing the created surface handle on success, or a Vulkan error code on failure.
```

--------------------------------

### get_semaphore_win32_handle

Source: https://docs.rs/ash/latest/src/ash/extensions/khr/external_semaphore_win32.rs.html

Gets a Win32 handle for a semaphore, as defined by the VK_KHR_external_semaphore_win32 extension.

```APIDOC
## get_semaphore_win32_handle

### Description
Gets a Win32 handle for a semaphore, as defined by the VK_KHR_external_semaphore_win32 extension.

### Method
unsafe fn

### Signature
pub unsafe fn get_semaphore_win32_handle(&self, get_info: &vk::SemaphoreGetWin32HandleInfoKHR<'_>) -> VkResult<vk::HANDLE>

### Parameters
- **get_info** (`&vk::SemaphoreGetWin32HandleInfoKHR<'_>`) - Required - Structure specifying the parameters of the export operation.

### Return Value
`VkResult<vk::HANDLE>` - Returns the Win32 handle on success, or an error code on failure.

### Vulkan Specification
<https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetSemaphoreWin32HandleKHR.html>
```

--------------------------------

### get_deferred_operation_result

Source: https://docs.rs/ash/latest/src/ash/extensions/khr/deferred_host_operations.rs.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Gets the result of a deferred operation. This method wraps vkGetDeferredOperationResultKHR.

```APIDOC
## get_deferred_operation_result

### Description
Gets the result of a deferred operation. This method wraps vkGetDeferredOperationResultKHR.

### Method
unsafe fn get_deferred_operation_result(&self, operation: vk::DeferredOperationKHR) -> VkResult<()>

### Parameters
- **operation** (vk::DeferredOperationKHR) - The deferred operation to query.

### Returns
- **VkResult<()>** - Success or an error.
```

--------------------------------

### PhysicalDeviceShaderCorePropertiesAMD

Source: https://docs.rs/ash/latest/src/ash/vk/definitions.rs.html?search=std%3A%3Avec

Builder methods for the PhysicalDeviceShaderCorePropertiesAMD Vulkan structure.

```APIDOC
## PhysicalDeviceShaderCorePropertiesAMD

### Description
Builder methods for configuring the `PhysicalDeviceShaderCorePropertiesAMD` Vulkan structure, which describes shader core properties for AMD devices.

### Methods
- **shader_engine_count** (u32) - Sets the number of shader engines.
- **shader_arrays_per_engine_count** (u32) - Sets the number of shader arrays per engine.
- **compute_units_per_shader_array** (u32) - Sets the number of compute units per shader array.
- **simd_per_compute_unit** (u32) - Sets the number of SIMD per compute unit.
- **wavefronts_per_simd** (u32) - Sets the number of wavefronts per SIMD.
- **wavefront_size** (u32) - Sets the wavefront size.
- **sgprs_per_simd** (u32) - Sets the number of SGPRs per SIMD.
- **min_sgpr_allocation** (u32) - Sets the minimum SGPR allocation.
- **max_sgpr_allocation** (u32) - Sets the maximum SGPR allocation.
- **sgpr_allocation_granularity** (u32) - Sets the SGPR allocation granularity.
- **vgprs_per_simd** (u32) - Sets the number of VGPRs per SIMD.
- **min_vgpr_allocation** (u32) - Sets the minimum VGPR allocation.
- **max_vgpr_allocation** (u32) - Sets the maximum VGPR allocation.
- **vgpr_allocation_granularity** (u32) - Sets the VGPR allocation granularity.

Each method consumes the builder and returns the modified builder for chaining.
```

--------------------------------

### get_memory_android_hardware_buffer

Source: https://docs.rs/ash/latest/src/ash/extensions/android/external_memory_android_hardware_buffer.rs.html?search=

Gets an Android hardware buffer from a Vulkan memory object.

```APIDOC
## get_memory_android_hardware_buffer

### Description
Gets an Android hardware buffer from a Vulkan memory object.

### Method
unsafe fn

### Signature
```rust
pub unsafe fn get_memory_android_hardware_buffer(
    &self,
    info: &vk::MemoryGetAndroidHardwareBufferInfoANDROID<'_>,
) -> VkResult<*mut vk::AHardwareBuffer>
```

### Parameters
- **info** (&vk::MemoryGetAndroidHardwareBufferInfoANDROID<'_>) - Required - Structure specifying the memory object to get the hardware buffer from.

### Returns
- **VkResult<*mut vk::AHardwareBuffer>** - Result containing a pointer to the Android hardware buffer.
```
Tokens:
Raw