Realm

vk · Functions · A1

16 public declarations with native signatures and source-owned contracts.

FnRustExperimental

Fnvk::acquire_drm_display_ext

pub unsafe fn acquire_drm_display_ext( instance: &Instance, physical_device: PhysicalDevice, drm_fd: i32, display: DisplayKHR, ) -> Result<Result, CallError>
Call vkAcquireDrmDisplayEXT using this context’s cached function pointer.

Contract

Call vkAcquireDrmDisplayEXT using this context’s cached function pointer.

Errors

Reports a missing command or a negative native VkResult; non-error results are preserved.

Safety

The context and all handles must be live and belong to the same Vulkan implementation/device. Meet vkAcquireDrmDisplayEXT valid usage, enabled API/extension/feature, pointer-chain lifetime, callback compatibility and host/GPU synchronization requirements. Native resources require explicit destruction after completion.

Preserves native raw pointers, explicit counts, optional nulls and return values. The caller supplies correctly aligned live storage, initialized output-chain headers and every extent implied by native counts, strides or nested records. No allocation, retry, output initialization, ownership transfer or alias fallback occurs in this wrapper. Outputs, including partial outputs on native failure, remain caller-owned and must be inspected/cleaned up according to Vulkan.

Khronos reference: vkAcquireDrmDisplayEXT

Fnvk::acquire_full_screen_exclusive_mode_ext

pub unsafe fn acquire_full_screen_exclusive_mode_ext( device: &Device, swapchain: SwapchainKHR, ) -> Result<Result, CallError>
Call vkAcquireFullScreenExclusiveModeEXT using this context’s cached function pointer.

Contract

Call vkAcquireFullScreenExclusiveModeEXT using this context’s cached function pointer.

Errors

Reports a missing command or a negative native VkResult; non-error results are preserved.

Safety

The context and all handles must be live and belong to the same Vulkan implementation/device. Meet vkAcquireFullScreenExclusiveModeEXT valid usage, enabled API/extension/feature, pointer-chain lifetime, callback compatibility and host/GPU synchronization requirements. Native resources require explicit destruction after completion.

Preserves native raw pointers, explicit counts, optional nulls and return values. The caller supplies correctly aligned live storage, initialized output-chain headers and every extent implied by native counts, strides or nested records. No allocation, retry, output initialization, ownership transfer or alias fallback occurs in this wrapper. Outputs, including partial outputs on native failure, remain caller-owned and must be inspected/cleaned up according to Vulkan.

Khronos reference: vkAcquireFullScreenExclusiveModeEXT

Fnvk::acquire_next_image2_khr

pub unsafe fn acquire_next_image2_khr( device: &Device, p_acquire_info: *const AcquireNextImageInfoKHR<'_>, p_image_index: *mut u32, ) -> Result<Result, CallError>
Call vkAcquireNextImage2KHR using this context’s cached function pointer.

Contract

Call vkAcquireNextImage2KHR using this context’s cached function pointer.

Errors

Reports a missing command or a negative native VkResult; non-error results are preserved.

Safety

The context and all handles must be live and belong to the same Vulkan implementation/device. Meet vkAcquireNextImage2KHR valid usage, enabled API/extension/feature, pointer-chain lifetime, callback compatibility and host/GPU synchronization requirements. Native resources require explicit destruction after completion.

Preserves native raw pointers, explicit counts, optional nulls and return values. The caller supplies correctly aligned live storage, initialized output-chain headers and every extent implied by native counts, strides or nested records. No allocation, retry, output initialization, ownership transfer or alias fallback occurs in this wrapper. Outputs, including partial outputs on native failure, remain caller-owned and must be inspected/cleaned up according to Vulkan.

Khronos reference: vkAcquireNextImage2KHR

Fnvk::acquire_next_image_khr

pub unsafe fn acquire_next_image_khr( device: &Device, swapchain: SwapchainKHR, timeout: u64, semaphore: Semaphore, fence: Fence, p_image_index: *mut u32, ) -> Result<Result, CallError>
Call vkAcquireNextImageKHR using this context’s cached function pointer.

Contract

Call vkAcquireNextImageKHR using this context’s cached function pointer.

Errors

Reports a missing command or a negative native VkResult; non-error results are preserved.

Safety

The context and all handles must be live and belong to the same Vulkan implementation/device. Meet vkAcquireNextImageKHR valid usage, enabled API/extension/feature, pointer-chain lifetime, callback compatibility and host/GPU synchronization requirements. Native resources require explicit destruction after completion.

Preserves native raw pointers, explicit counts, optional nulls and return values. The caller supplies correctly aligned live storage, initialized output-chain headers and every extent implied by native counts, strides or nested records. No allocation, retry, output initialization, ownership transfer or alias fallback occurs in this wrapper. Outputs, including partial outputs on native failure, remain caller-owned and must be inspected/cleaned up according to Vulkan.

Khronos reference: vkAcquireNextImageKHR

Fnvk::acquire_performance_configuration_intel

pub unsafe fn acquire_performance_configuration_intel( device: &Device, p_acquire_info: *const PerformanceConfigurationAcquireInfoINTEL<'_>, p_configuration: *mut PerformanceConfigurationINTEL, ) -> Result<Result, CallError>
Call vkAcquirePerformanceConfigurationINTEL using this context’s cached function pointer.

Contract

Call vkAcquirePerformanceConfigurationINTEL using this context’s cached function pointer.

Errors

Reports a missing command or a negative native VkResult; non-error results are preserved.

Safety

The context and all handles must be live and belong to the same Vulkan implementation/device. Meet vkAcquirePerformanceConfigurationINTEL valid usage, enabled API/extension/feature, pointer-chain lifetime, callback compatibility and host/GPU synchronization requirements. Native resources require explicit destruction after completion.

Preserves native raw pointers, explicit counts, optional nulls and return values. The caller supplies correctly aligned live storage, initialized output-chain headers and every extent implied by native counts, strides or nested records. No allocation, retry, output initialization, ownership transfer or alias fallback occurs in this wrapper. Outputs, including partial outputs on native failure, remain caller-owned and must be inspected/cleaned up according to Vulkan.

Khronos reference: vkAcquirePerformanceConfigurationINTEL

Fnvk::acquire_profiling_lock_khr

pub unsafe fn acquire_profiling_lock_khr( device: &Device, p_info: *const AcquireProfilingLockInfoKHR<'_>, ) -> Result<Result, CallError>
Call vkAcquireProfilingLockKHR using this context’s cached function pointer.

Contract

Call vkAcquireProfilingLockKHR using this context’s cached function pointer.

Errors

Reports a missing command or a negative native VkResult; non-error results are preserved.

Safety

The context and all handles must be live and belong to the same Vulkan implementation/device. Meet vkAcquireProfilingLockKHR valid usage, enabled API/extension/feature, pointer-chain lifetime, callback compatibility and host/GPU synchronization requirements. Native resources require explicit destruction after completion.

Preserves native raw pointers, explicit counts, optional nulls and return values. The caller supplies correctly aligned live storage, initialized output-chain headers and every extent implied by native counts, strides or nested records. No allocation, retry, output initialization, ownership transfer or alias fallback occurs in this wrapper. Outputs, including partial outputs on native failure, remain caller-owned and must be inspected/cleaned up according to Vulkan.

Khronos reference: vkAcquireProfilingLockKHR

Fnvk::acquire_winrt_display_nv

pub unsafe fn acquire_winrt_display_nv( instance: &Instance, physical_device: PhysicalDevice, display: DisplayKHR, ) -> Result<Result, CallError>
Call vkAcquireWinrtDisplayNV using this context’s cached function pointer.

Contract

Call vkAcquireWinrtDisplayNV using this context’s cached function pointer.

Errors

Reports a missing command or a negative native VkResult; non-error results are preserved.

Safety

The context and all handles must be live and belong to the same Vulkan implementation/device. Meet vkAcquireWinrtDisplayNV valid usage, enabled API/extension/feature, pointer-chain lifetime, callback compatibility and host/GPU synchronization requirements. Native resources require explicit destruction after completion.

Preserves native raw pointers, explicit counts, optional nulls and return values. The caller supplies correctly aligned live storage, initialized output-chain headers and every extent implied by native counts, strides or nested records. No allocation, retry, output initialization, ownership transfer or alias fallback occurs in this wrapper. Outputs, including partial outputs on native failure, remain caller-owned and must be inspected/cleaned up according to Vulkan.

Khronos reference: vkAcquireWinrtDisplayNV

Fnvk::acquire_xlib_display_ext

pub unsafe fn acquire_xlib_display_ext( instance: &Instance, physical_device: PhysicalDevice, dpy: *mut Display, display: DisplayKHR, ) -> Result<Result, CallError>
Call vkAcquireXlibDisplayEXT using this context’s cached function pointer.

Contract

Call vkAcquireXlibDisplayEXT using this context’s cached function pointer.

Errors

Reports a missing command or a negative native VkResult; non-error results are preserved.

Safety

The context and all handles must be live and belong to the same Vulkan implementation/device. Meet vkAcquireXlibDisplayEXT valid usage, enabled API/extension/feature, pointer-chain lifetime, callback compatibility and host/GPU synchronization requirements. Native resources require explicit destruction after completion.

Preserves native raw pointers, explicit counts, optional nulls and return values. The caller supplies correctly aligned live storage, initialized output-chain headers and every extent implied by native counts, strides or nested records. No allocation, retry, output initialization, ownership transfer or alias fallback occurs in this wrapper. Outputs, including partial outputs on native failure, remain caller-owned and must be inspected/cleaned up according to Vulkan.

Khronos reference: vkAcquireXlibDisplayEXT

Fnvk::allocate_command_buffers

Contract

Allocate command buffers from a pool.

Safety

allocate_info.command_pool must be a live pool from this device.

Khronos reference: vkAllocateCommandBuffers

Fnvk::allocate_descriptor_sets

pub unsafe fn allocate_descriptor_sets( device: &Device, allocate_info: &DescriptorSetAllocateInfo<'_>, descriptor_sets: &mut [DescriptorSet], ) -> Result<(), CallError>
Call vkAllocateDescriptorSets using this context’s cached function pointer.

Contract

Call vkAllocateDescriptorSets using this context’s cached function pointer.

Errors

Reports a missing command, invalid slice lengths/counts or a native error.

Safety

The context and all handles must be live and belong to the same Vulkan implementation/device. Meet vkAllocateDescriptorSets valid usage, enabled API/extension/feature, pointer-chain lifetime, callback compatibility and host/GPU synchronization requirements. Native resources require explicit destruction after completion.

Khronos reference: vkAllocateDescriptorSets

Fnvk::allocate_memory

pub unsafe fn allocate_memory( device: &Device, allocate_info: &MemoryAllocateInfo<'_>, allocator: Option<&AllocationCallbacks>, ) -> Result<DeviceMemory, CallError>
Allocate device memory.

Contract

Allocate device memory.

Errors

CallError::MissingCommand if unavailable; CallError::Vulkan on failure.

Safety

The allocate_info must be valid and reference a legal memory type index. The allocation must be freed exactly once via Device::free_memory.

Khronos reference: vkAllocateMemory

Fnvk::anti_lag_update_amd

pub unsafe fn anti_lag_update_amd( device: &Device, p_data: *const AntiLagDataAMD<'_>, ) -> Result<(), CallError>
Call vkAntiLagUpdateAMD using this context’s cached function pointer.

Contract

Call vkAntiLagUpdateAMD using this context’s cached function pointer.

Errors

Reports a missing command or a negative native VkResult; non-error results are preserved.

Safety

The context and all handles must be live and belong to the same Vulkan implementation/device. Meet vkAntiLagUpdateAMD valid usage, enabled API/extension/feature, pointer-chain lifetime, callback compatibility and host/GPU synchronization requirements. Native resources require explicit destruction after completion.

Preserves native raw pointers, explicit counts, optional nulls and return values. The caller supplies correctly aligned live storage, initialized output-chain headers and every extent implied by native counts, strides or nested records. No allocation, retry, output initialization, ownership transfer or alias fallback occurs in this wrapper. Outputs, including partial outputs on native failure, remain caller-owned and must be inspected/cleaned up according to Vulkan.

Khronos reference: vkAntiLagUpdateAMD

Fnvk::api_version_major

Contract

Extract the major version, excluding the variant.

Khronos reference: VK_API_VERSION_MAJOR

Fnvk::api_version_minor

Contract

Extract the minor version.

Khronos reference: VK_API_VERSION_MINOR

Fnvk::api_version_patch

Contract

Extract the patch version.

Khronos reference: VK_API_VERSION_PATCH

Fnvk::api_version_variant

Contract