Realm

vk · Functions · G4

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

FnRustExperimental

Fnvk::get_device_image_sparse_memory_requirements_khr

pub unsafe fn get_device_image_sparse_memory_requirements_khr( device: &Device, p_info: *const DeviceImageMemoryRequirements<'_>, p_sparse_memory_requirement_count: *mut u32, p_sparse_memory_requirements: *mut SparseImageMemoryRequirements2<'_>, ) -> Result<(), CallError>
Call vkGetDeviceImageSparseMemoryRequirementsKHR using this context’s cached function pointer.

Contract

Call vkGetDeviceImageSparseMemoryRequirementsKHR 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 vkGetDeviceImageSparseMemoryRequirementsKHR 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: vkGetDeviceImageSparseMemoryRequirementsKHR

Fnvk::get_device_image_subresource_layout

pub unsafe fn get_device_image_subresource_layout( device: &Device, p_info: *const DeviceImageSubresourceInfo<'_>, p_layout: *mut SubresourceLayout2<'_>, ) -> Result<(), CallError>
Call vkGetDeviceImageSubresourceLayout using this context’s cached function pointer.

Contract

Call vkGetDeviceImageSubresourceLayout 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 vkGetDeviceImageSubresourceLayout 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: vkGetDeviceImageSubresourceLayout

Fnvk::get_device_image_subresource_layout_khr

pub unsafe fn get_device_image_subresource_layout_khr( device: &Device, p_info: *const DeviceImageSubresourceInfo<'_>, p_layout: *mut SubresourceLayout2<'_>, ) -> Result<(), CallError>
Call vkGetDeviceImageSubresourceLayoutKHR using this context’s cached function pointer.

Contract

Call vkGetDeviceImageSubresourceLayoutKHR 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 vkGetDeviceImageSubresourceLayoutKHR 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: vkGetDeviceImageSubresourceLayoutKHR

Fnvk::get_device_memory_commitment

pub unsafe fn get_device_memory_commitment( device: &Device, memory: DeviceMemory, committed_memory_in_bytes: &mut DeviceSize, ) -> Result<(), CallError>
Call vkGetDeviceMemoryCommitment using this context’s cached function pointer.

Contract

Call vkGetDeviceMemoryCommitment 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 vkGetDeviceMemoryCommitment 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: vkGetDeviceMemoryCommitment

Fnvk::get_device_memory_opaque_capture_address

pub unsafe fn get_device_memory_opaque_capture_address( device: &Device, info: &DeviceMemoryOpaqueCaptureAddressInfo<'_>, ) -> Result<u64, CallError>
Call vkGetDeviceMemoryOpaqueCaptureAddress using this context’s cached function pointer.

Contract

Call vkGetDeviceMemoryOpaqueCaptureAddress using this context’s cached function pointer.

Errors

Reports a missing command; the native scalar is never converted to a status.

Safety

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

Returns the native 64-bit value unchanged, including zero. This is not a VkResult status; opaque capture values are tokens, not dereferenceable addresses. This call neither owns memory nor establishes its lifetime or device accessibility.

Khronos reference: vkGetDeviceMemoryOpaqueCaptureAddress

Fnvk::get_device_memory_opaque_capture_address_khr

pub unsafe fn get_device_memory_opaque_capture_address_khr( device: &Device, info: &DeviceMemoryOpaqueCaptureAddressInfo<'_>, ) -> Result<u64, CallError>
Call vkGetDeviceMemoryOpaqueCaptureAddressKHR using this context’s cached function pointer.

Contract

Call vkGetDeviceMemoryOpaqueCaptureAddressKHR using this context’s cached function pointer.

Errors

Reports a missing command; the native scalar is never converted to a status.

Safety

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

Returns the native 64-bit value unchanged, including zero. This is not a VkResult status; opaque capture values are tokens, not dereferenceable addresses. This call neither owns memory nor establishes its lifetime or device accessibility.

Khronos reference: vkGetDeviceMemoryOpaqueCaptureAddressKHR

Fnvk::get_device_micromap_compatibility_ext

pub unsafe fn get_device_micromap_compatibility_ext( device: &Device, p_version_info: *const MicromapVersionInfoEXT<'_>, p_compatibility: *mut AccelerationStructureCompatibilityKHR, ) -> Result<(), CallError>
Call vkGetDeviceMicromapCompatibilityEXT using this context’s cached function pointer.

Contract

Call vkGetDeviceMicromapCompatibilityEXT 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 vkGetDeviceMicromapCompatibilityEXT 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: vkGetDeviceMicromapCompatibilityEXT

Fnvk::get_device_proc_addr

Contract

Resolve a device-specific function by name using this device’s gdpa.

Returns None if the function is not available for this device.

Safety

name must be a valid NUL-terminated command name. The caller must cast and use the returned pointer only while this device is live.

Khronos reference: vkGetDeviceProcAddr

Fnvk::get_device_queue

Contract

Retrieve a queue handle from this device.

Safety

queue_family_index and queue_index must be within the bounds of the queue families requested at device creation.

Khronos reference: vkGetDeviceQueue

Fnvk::get_device_queue2

pub unsafe fn get_device_queue2( device: &Device, queue_info: &DeviceQueueInfo2<'_>, queue: &mut Queue, ) -> Result<(), CallError>
Call vkGetDeviceQueue2 using this context’s cached function pointer.

Contract

Call vkGetDeviceQueue2 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 vkGetDeviceQueue2 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: vkGetDeviceQueue2

Fnvk::get_device_subpass_shading_max_workgroup_size_huawei

pub unsafe fn get_device_subpass_shading_max_workgroup_size_huawei( device: &Device, renderpass: RenderPass, p_max_workgroup_size: *mut Extent2D, ) -> Result<Result, CallError>
Call vkGetDeviceSubpassShadingMaxWorkgroupSizeHUAWEI using this context’s cached function pointer.

Contract

Call vkGetDeviceSubpassShadingMaxWorkgroupSizeHUAWEI 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 vkGetDeviceSubpassShadingMaxWorkgroupSizeHUAWEI 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: vkGetDeviceSubpassShadingMaxWorkgroupSizeHUAWEI

Fnvk::get_device_tensor_memory_requirements_arm

pub unsafe fn get_device_tensor_memory_requirements_arm( device: &Device, p_info: *const DeviceTensorMemoryRequirementsARM<'_>, p_memory_requirements: *mut MemoryRequirements2<'_>, ) -> Result<(), CallError>
Call vkGetDeviceTensorMemoryRequirementsARM using this context’s cached function pointer.

Contract

Call vkGetDeviceTensorMemoryRequirementsARM 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 vkGetDeviceTensorMemoryRequirementsARM 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: vkGetDeviceTensorMemoryRequirementsARM

Fnvk::get_display_mode_properties2_khr

pub unsafe fn get_display_mode_properties2_khr( instance: &Instance, physical_device: PhysicalDevice, display: DisplayKHR, p_property_count: *mut u32, p_properties: *mut DisplayModeProperties2KHR<'_>, ) -> Result<Result, CallError>
Call vkGetDisplayModeProperties2KHR using this context’s cached function pointer.

Contract

Call vkGetDisplayModeProperties2KHR 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 vkGetDisplayModeProperties2KHR 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: vkGetDisplayModeProperties2KHR

Fnvk::get_display_mode_properties_khr

pub unsafe fn get_display_mode_properties_khr( instance: &Instance, physical_device: PhysicalDevice, display: DisplayKHR, p_property_count: *mut u32, p_properties: *mut DisplayModePropertiesKHR, ) -> Result<Result, CallError>
Call vkGetDisplayModePropertiesKHR using this context’s cached function pointer.

Contract

Call vkGetDisplayModePropertiesKHR 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 vkGetDisplayModePropertiesKHR 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: vkGetDisplayModePropertiesKHR

Fnvk::get_display_plane_capabilities2_khr

pub unsafe fn get_display_plane_capabilities2_khr( instance: &Instance, physical_device: PhysicalDevice, p_display_plane_info: *const DisplayPlaneInfo2KHR<'_>, p_capabilities: *mut DisplayPlaneCapabilities2KHR<'_>, ) -> Result<Result, CallError>
Call vkGetDisplayPlaneCapabilities2KHR using this context’s cached function pointer.

Contract

Call vkGetDisplayPlaneCapabilities2KHR 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 vkGetDisplayPlaneCapabilities2KHR 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: vkGetDisplayPlaneCapabilities2KHR

Fnvk::get_display_plane_capabilities_khr

pub unsafe fn get_display_plane_capabilities_khr( instance: &Instance, physical_device: PhysicalDevice, mode: DisplayModeKHR, plane_index: u32, p_capabilities: *mut DisplayPlaneCapabilitiesKHR, ) -> Result<Result, CallError>
Call vkGetDisplayPlaneCapabilitiesKHR using this context’s cached function pointer.

Contract

Call vkGetDisplayPlaneCapabilitiesKHR 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 vkGetDisplayPlaneCapabilitiesKHR 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: vkGetDisplayPlaneCapabilitiesKHR