Realm

vk · Functions · G13

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

FnRustExperimental

Fnvk::get_pipeline_cache_data

pub unsafe fn get_pipeline_cache_data( device: &Device, pipeline_cache: PipelineCache, ) -> Result<Vec<u8>, CallError>
Call vkGetPipelineCacheData using this context’s cached function pointer.

Contract

Call vkGetPipelineCacheData 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 vkGetPipelineCacheData valid usage, enabled API/extension/feature, pointer-chain lifetime, callback compatibility and host/GPU synchronization requirements. Native resources require explicit destruction after completion.

Retries incomplete/growing results with a bounded budget; returns an error if the query does not stabilize. Allocates the returned vector.

Khronos reference: vkGetPipelineCacheData

Fnvk::get_pipeline_executable_internal_representations_khr

pub unsafe fn get_pipeline_executable_internal_representations_khr( device: &Device, p_executable_info: *const PipelineExecutableInfoKHR<'_>, p_internal_representation_count: *mut u32, p_internal_representations: *mut PipelineExecutableInternalRepresentationKHR<'_>, ) -> Result<Result, CallError>
Call vkGetPipelineExecutableInternalRepresentationsKHR using this context’s cached function pointer.

Contract

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

Fnvk::get_pipeline_executable_properties_khr

pub unsafe fn get_pipeline_executable_properties_khr( device: &Device, p_pipeline_info: *const PipelineInfoKHR<'_>, p_executable_count: *mut u32, p_properties: *mut PipelineExecutablePropertiesKHR<'_>, ) -> Result<Result, CallError>
Call vkGetPipelineExecutablePropertiesKHR using this context’s cached function pointer.

Contract

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

Fnvk::get_pipeline_executable_statistics_khr

pub unsafe fn get_pipeline_executable_statistics_khr( device: &Device, p_executable_info: *const PipelineExecutableInfoKHR<'_>, p_statistic_count: *mut u32, p_statistics: *mut PipelineExecutableStatisticKHR<'_>, ) -> Result<Result, CallError>
Call vkGetPipelineExecutableStatisticsKHR using this context’s cached function pointer.

Contract

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

Fnvk::get_pipeline_indirect_device_address_nv

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

Contract

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

Fnvk::get_pipeline_indirect_memory_requirements_nv

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

Contract

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

Fnvk::get_pipeline_key_khr

pub unsafe fn get_pipeline_key_khr( device: &Device, p_pipeline_create_info: *const PipelineCreateInfoKHR<'_>, p_pipeline_key: *mut PipelineBinaryKeyKHR<'_>, ) -> Result<Result, CallError>
Call vkGetPipelineKeyKHR using this context’s cached function pointer.

Contract

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

Fnvk::get_pipeline_properties_ext

pub unsafe fn get_pipeline_properties_ext( device: &Device, p_pipeline_info: *const PipelineInfoKHR<'_>, p_pipeline_properties: *mut BaseOutStructure<'_>, ) -> Result<Result, CallError>
Call vkGetPipelinePropertiesEXT using this context’s cached function pointer.

Contract

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

Fnvk::get_private_data

pub unsafe fn get_private_data( device: &Device, object_type: ObjectType, object_handle: u64, private_data_slot: PrivateDataSlot, p_data: *mut u64, ) -> Result<(), CallError>
Call vkGetPrivateData using this context’s cached function pointer.

Contract

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

Fnvk::get_private_data_ext

pub unsafe fn get_private_data_ext( device: &Device, object_type: ObjectType, object_handle: u64, private_data_slot: PrivateDataSlot, p_data: *mut u64, ) -> Result<(), CallError>
Call vkGetPrivateDataEXT using this context’s cached function pointer.

Contract

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

Fnvk::get_query_pool_results

pub unsafe fn get_query_pool_results( device: &Device, query_pool: QueryPool, first_query: u32, query_count: u32, data: &mut [u8], stride: DeviceSize, flags: QueryResultFlags, ) -> Result<Result, CallError>
Call vkGetQueryPoolResults using this context’s cached function pointer.

Contract

Call vkGetQueryPoolResults 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 vkGetQueryPoolResults valid usage, enabled API/extension/feature, pointer-chain lifetime, callback compatibility and host/GPU synchronization requirements. Native resources require explicit destruction after completion.

Byte slices determine native byte counts. The caller must also satisfy the command’s data alignment, format, size-multiple and stride requirements; a byte slice alone does not establish those properties.

Khronos reference: vkGetQueryPoolResults

Fnvk::get_queue_checkpoint_data2_nv

pub unsafe fn get_queue_checkpoint_data2_nv( device: &Device, queue: Queue, p_checkpoint_data_count: *mut u32, p_checkpoint_data: *mut CheckpointData2NV<'_>, ) -> Result<(), CallError>
Call vkGetQueueCheckpointData2NV using this context’s cached function pointer.

Contract

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

Fnvk::get_queue_checkpoint_data_nv

pub unsafe fn get_queue_checkpoint_data_nv( device: &Device, queue: Queue, p_checkpoint_data_count: *mut u32, p_checkpoint_data: *mut CheckpointDataNV<'_>, ) -> Result<(), CallError>
Call vkGetQueueCheckpointDataNV using this context’s cached function pointer.

Contract

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

Fnvk::get_rand_r_output_display_ext

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

Contract

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

Fnvk::get_ray_tracing_capture_replay_shader_group_handles_khr

pub unsafe fn get_ray_tracing_capture_replay_shader_group_handles_khr( device: &Device, pipeline: Pipeline, first_group: u32, group_count: u32, data_size: usize, p_data: *mut c_void, ) -> Result<Result, CallError>
Call vkGetRayTracingCaptureReplayShaderGroupHandlesKHR using this context’s cached function pointer.

Contract

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

Fnvk::get_ray_tracing_shader_group_handles_khr

pub unsafe fn get_ray_tracing_shader_group_handles_khr( device: &Device, pipeline: Pipeline, first_group: u32, group_count: u32, data_size: usize, p_data: *mut c_void, ) -> Result<Result, CallError>
Call vkGetRayTracingShaderGroupHandlesKHR using this context’s cached function pointer.

Contract

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