top logo menu kitty mascot
AROS.ORG Developers Localization Bounties

vulkan_hidd

Index


--background_vulkan_hidd-- moHidd_Vulkan_AllocateCommandBuffers moHidd_Vulkan_AllocateDescriptorSets moHidd_Vulkan_AllocateMemory
moHidd_Vulkan_BeginCommandBuffer moHidd_Vulkan_BindBufferMemory moHidd_Vulkan_CmdBindDescriptorSets moHidd_Vulkan_CmdBindPipeline
moHidd_Vulkan_CmdCopyBuffer moHidd_Vulkan_CmdDispatch moHidd_Vulkan_CmdFillBuffer moHidd_Vulkan_CmdPipelineBarrier
moHidd_Vulkan_CmdPushConstants moHidd_Vulkan_CmdResetEvent moHidd_Vulkan_CmdResetQueryPool moHidd_Vulkan_CmdSetEvent
moHidd_Vulkan_CmdWaitEvents moHidd_Vulkan_CmdWriteTimestamp moHidd_Vulkan_CreateBuffer moHidd_Vulkan_CreateCommandPool
moHidd_Vulkan_CreateComputePipelines moHidd_Vulkan_CreateDescriptorPool moHidd_Vulkan_CreateDescriptorSetLayout moHidd_Vulkan_CreateDevice
moHidd_Vulkan_CreateEvent moHidd_Vulkan_CreateFence moHidd_Vulkan_CreateInstance moHidd_Vulkan_CreatePipelineLayout
moHidd_Vulkan_CreateQueryPool moHidd_Vulkan_CreateSemaphore moHidd_Vulkan_CreateShaderModule moHidd_Vulkan_DestroyBuffer
moHidd_Vulkan_DestroyCommandPool moHidd_Vulkan_DestroyDescriptorPool moHidd_Vulkan_DestroyDescriptorSetLayout moHidd_Vulkan_DestroyDevice
moHidd_Vulkan_DestroyEvent moHidd_Vulkan_DestroyFence moHidd_Vulkan_DestroyInstance moHidd_Vulkan_DestroyPipeline
moHidd_Vulkan_DestroyPipelineLayout moHidd_Vulkan_DestroyQueryPool moHidd_Vulkan_DestroySemaphore moHidd_Vulkan_DestroyShaderModule
moHidd_Vulkan_DeviceWaitIdle moHidd_Vulkan_DisplayResource moHidd_Vulkan_EndCommandBuffer moHidd_Vulkan_EnumerateDeviceExtensionProperties
moHidd_Vulkan_EnumerateInstanceExtensionProperties moHidd_Vulkan_EnumerateInstanceVersion moHidd_Vulkan_EnumeratePhysicalDevices moHidd_Vulkan_FreeCommandBuffers
moHidd_Vulkan_FreeMemory moHidd_Vulkan_GetBufferDeviceAddress moHidd_Vulkan_GetBufferMemoryRequirements moHidd_Vulkan_GetDeviceProcAddr
moHidd_Vulkan_GetDeviceQueue moHidd_Vulkan_GetFenceStatus moHidd_Vulkan_GetInstanceProcAddr moHidd_Vulkan_GetMemoryHostPointerPropertiesEXT
moHidd_Vulkan_GetPhysicalDeviceFeatures moHidd_Vulkan_GetPhysicalDeviceFeatures2 moHidd_Vulkan_GetPhysicalDeviceMemoryProperties moHidd_Vulkan_GetPhysicalDeviceProperties
moHidd_Vulkan_GetPhysicalDeviceProperties2 moHidd_Vulkan_GetPhysicalDeviceQueueFamilyProperties moHidd_Vulkan_GetQueryPoolResults moHidd_Vulkan_MapMemory
moHidd_Vulkan_QueueSubmit moHidd_Vulkan_QueueWaitIdle moHidd_Vulkan_ResetCommandPool moHidd_Vulkan_ResetEvent
moHidd_Vulkan_ResetFences moHidd_Vulkan_ResetQueryPool moHidd_Vulkan_SetEvent moHidd_Vulkan_UnmapMemory
moHidd_Vulkan_UpdateDescriptorSets moHidd_Vulkan_WaitForFences    

--background_vulkan_hidd--

Function

Provides OOP methods that dispatch Vulkan requests through a
driver-supplied Vulkan ICD. Driver subclasses supply
GetInstanceProcAddr; the base implementation of that method
returns NULL.

Notes

A Vulkan HIDD object requires the
aHidd_Vulkan_InterfaceVersion creation tag set to
VULKAN_INTERFACE_VERSION. Root.New rejects missing and mismatched
values. Method messages and IDs are defined in vulkan_hidd.h.

The base class caches the ICD's vkGetInstanceProcAddr pointer
and remembers the first successfully created VkInstance for
subsequent command lookup. It clears that instance pointer
when the same instance is destroyed.

Methods with a VkResult return expose it as IPTR. If an entry
point is unavailable, methods returning VkResult normally
return VK_ERROR_INITIALIZATION_FAILED. Methods returning
VOID normally skip an unavailable entry point. Individual
methods document exceptions to these defaults.

moHidd_Vulkan_AllocateCommandBuffers

Synopsis

struct pHidd_Vulkan_AllocateCommandBuffers

Function

Allocates command buffers from a command pool.

Inputs

device - Vulkan logical-device handle.
commandPool - Vulkan command-pool handle.
level - Command-buffer level.
count - Number of command buffers.
pCommandBuffers - Array of command-buffer handles.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_AllocateDescriptorSets

Synopsis

struct pHidd_Vulkan_AllocateDescriptorSets

Function

Allocates descriptor sets from a descriptor pool.

Inputs

device - Vulkan logical-device handle.
pAllocateInfo - Vulkan allocation parameters.
pDescriptorSets - Caller-provided descriptor-set handle array.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_AllocateMemory

Synopsis

struct pHidd_Vulkan_AllocateMemory

Function

Allocates device memory of the requested size and memory type.

Inputs

device - Vulkan logical-device handle.
allocationSize - Number of bytes to allocate.
memoryTypeIndex - Vulkan memory-type index.
pMemory - Required output pointer for a device-memory handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED when the
entry point is absent.

Notes

If the ICD entry point is unavailable, the base method returns
VK_ERROR_INITIALIZATION_FAILED without writing its output handle.
When the ICD entry point is called, the returned handle is written
even if the ICD reports a failure; the local handle starts as NULL.

moHidd_Vulkan_BeginCommandBuffer

Synopsis

struct pHidd_Vulkan_BeginCommandBuffer

Function

Begins recording commands in a command buffer.

Inputs

commandBuffer - Vulkan command-buffer handle.
flags - Operation-specific Vulkan flag bits.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_BindBufferMemory

Synopsis

struct pHidd_Vulkan_BindBufferMemory

Function

Binds a device-memory allocation to a buffer.

Inputs

device - Vulkan logical-device handle.
buffer - Vulkan buffer handle.
memory - Vulkan device-memory handle.
memoryOffset - Offset into the bound device-memory allocation.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_CmdBindDescriptorSets

Synopsis

struct pHidd_Vulkan_CmdBindDescriptorSets

Function

Records descriptor-set bindings.

Inputs

commandBuffer - Vulkan command-buffer handle.
pipelineBindPoint - Vulkan pipeline bind point.
layout - Vulkan pipeline-layout handle.
firstSet - Index of the first descriptor set.
descriptorSetCount - Number of descriptor sets.
pDescriptorSets - Caller-provided descriptor-set handle array.
dynamicOffsetCount - Number of dynamic offsets.
pDynamicOffsets - Array of dynamic offsets.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_CmdBindPipeline

Synopsis

struct pHidd_Vulkan_CmdBindPipeline

Function

Records a pipeline-binding command.

Inputs

commandBuffer - Vulkan command-buffer handle.
pipelineBindPoint - Vulkan pipeline bind point.
pipeline - Vulkan pipeline handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_CmdCopyBuffer

Synopsis

struct pHidd_Vulkan_CmdCopyBuffer

Function

Records a buffer-to-buffer copy.

Inputs

commandBuffer - Vulkan command-buffer handle.
srcBuffer - Source Vulkan buffer.
dstBuffer - Destination Vulkan buffer.
regionCount - Number of copy regions.
pRegions - Array of Vulkan buffer-copy regions.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_CmdDispatch

Synopsis

struct pHidd_Vulkan_CmdDispatch

Function

Records a compute-workgroup dispatch.

Inputs

commandBuffer - Vulkan command-buffer handle.
groupCountX - Number of workgroups along the x axis.
groupCountY - Number of workgroups along the y axis.
groupCountZ - Number of workgroups along the z axis.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_CmdFillBuffer

Synopsis

struct pHidd_Vulkan_CmdFillBuffer

Function

Records a buffer-fill operation.

Inputs

commandBuffer - Vulkan command-buffer handle.
dstBuffer - Destination Vulkan buffer.
dstOffset - Destination offset in bytes.
size - Size of the requested range in bytes.
data - 32-bit fill value.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_CmdPipelineBarrier

Synopsis

struct pHidd_Vulkan_CmdPipelineBarrier

Function

Records execution and memory dependencies.

Inputs

commandBuffer - Vulkan command-buffer handle.
srcStageMask - Source pipeline-stage mask.
dstStageMask - Destination pipeline-stage mask.
dependencyFlags - Vulkan dependency flags.
memoryBarrierCount - Number of memory barriers.
pMemoryBarriers - Array of memory barriers.
bufferMemoryBarrierCount - Number of buffer-memory barriers.
pBufferMemoryBarriers - Array of buffer-memory barriers.
imageMemoryBarrierCount - Number of image-memory barriers.
pImageMemoryBarriers - Array of image-memory barriers.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_CmdPushConstants

Synopsis

struct pHidd_Vulkan_CmdPushConstants

Function

Records an update to push-constant values.

Inputs

commandBuffer - Vulkan command-buffer handle.
layout - Vulkan pipeline-layout handle.
stageFlags - Shader-stage selection flags.
offset - Byte offset in the specified memory or command range.
size - Size of the requested range in bytes.
pValues - Push-constant data.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_CmdResetEvent

Synopsis

struct pHidd_Vulkan_CmdResetEvent

Function

Records a command that resets an event.

Inputs

commandBuffer - Vulkan command-buffer handle.
event - Vulkan event handle.
stageMask - Pipeline-stage mask.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_CmdResetQueryPool

Synopsis

struct pHidd_Vulkan_CmdResetQueryPool

Function

Records a command that resets queries.

Inputs

commandBuffer - Vulkan command-buffer handle.
queryPool - Vulkan query-pool handle.
firstQuery - Index of the first query.
queryCount - Number of queries.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_CmdSetEvent

Synopsis

struct pHidd_Vulkan_CmdSetEvent

Function

Records a command that sets an event.

Inputs

commandBuffer - Vulkan command-buffer handle.
event - Vulkan event handle.
stageMask - Pipeline-stage mask.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_CmdWaitEvents

Synopsis

struct pHidd_Vulkan_CmdWaitEvents

Function

Records a command that waits for events.

Inputs

commandBuffer - Vulkan command-buffer handle.
eventCount - Number of events.
pEvents - Array of event handles.
srcStageMask - Source pipeline-stage mask.
dstStageMask - Destination pipeline-stage mask.
memoryBarrierCount - Number of memory barriers.
pMemoryBarriers - Array of memory barriers.
bufferMemoryBarrierCount - Number of buffer-memory barriers.
pBufferMemoryBarriers - Array of buffer-memory barriers.
imageMemoryBarrierCount - Number of image-memory barriers.
pImageMemoryBarriers - Array of image-memory barriers.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_CmdWriteTimestamp

Synopsis

struct pHidd_Vulkan_CmdWriteTimestamp

Function

Records a timestamp write to a query pool.

Inputs

commandBuffer - Vulkan command-buffer handle.
pipelineStage - Pipeline stage for the timestamp.
queryPool - Vulkan query-pool handle.
query - Index of the destination query.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_CreateBuffer

Synopsis

struct pHidd_Vulkan_CreateBuffer

Function

Creates a buffer with the requested size and usage.

Inputs

device - Vulkan logical-device handle.
size - Size of the requested range in bytes.
usage - Vulkan buffer-usage flag bits.
sharingMode - Buffer-sharing mode.
pBuffer - Required output pointer for a buffer handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED when the
entry point is absent.

Notes

The base method sets size, usage, and sharingMode in
VkBufferCreateInfo. It does not supply queueFamilyIndexCount or
pQueueFamilyIndices, including for concurrent sharing mode.

If the ICD entry point is unavailable, the base method returns
VK_ERROR_INITIALIZATION_FAILED without writing its output handle.
When the ICD entry point is called, the returned handle is written
even if the ICD reports a failure; the local handle starts as NULL.

moHidd_Vulkan_CreateCommandPool

Synopsis

struct pHidd_Vulkan_CreateCommandPool

Function

Creates a command pool for a queue family.

Inputs

device - Vulkan logical-device handle.
queueFamilyIndex - Index of a queue family.
flags - Operation-specific Vulkan flag bits.
pCommandPool - Required output pointer for a command-pool handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED when the
entry point is absent.

Notes

If the ICD entry point is unavailable, the base method returns
VK_ERROR_INITIALIZATION_FAILED without writing its output handle.
When the ICD entry point is called, the returned handle is written
even if the ICD reports a failure; the local handle starts as NULL.

moHidd_Vulkan_CreateComputePipelines

Synopsis

struct pHidd_Vulkan_CreateComputePipelines

Function

Creates compute pipelines from Vulkan create-info structures.

Inputs

device - Vulkan logical-device handle.
createInfoCount - Number of pipeline create-info structures.
pCreateInfos - Array of pipeline create-info structures.
pPipelines - Caller-provided output array of pipeline handles.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

Notes

The base implementation passes VK_NULL_HANDLE as the pipeline cache.

moHidd_Vulkan_CreateDescriptorPool

Synopsis

struct pHidd_Vulkan_CreateDescriptorPool

Function

Creates a pool used to allocate descriptor sets.

Inputs

device - Vulkan logical-device handle.
pCreateInfo - Pointer to the operation's Vulkan create-info
    structure.
pDescriptorPool - Required output pointer for a descriptor-pool
    handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED when the
entry point is absent.

Notes

If the ICD entry point is unavailable, the base method returns
VK_ERROR_INITIALIZATION_FAILED without writing its output handle.
When the ICD entry point is called, the returned handle is written
even if the ICD reports a failure; the local handle starts as NULL.

moHidd_Vulkan_CreateDescriptorSetLayout

Synopsis

struct pHidd_Vulkan_CreateDescriptorSetLayout

Function

Creates a layout describing descriptor-set bindings.

Inputs

device - Vulkan logical-device handle.
pCreateInfo - Pointer to the operation's Vulkan create-info
    structure.
pSetLayout - Required output pointer for a descriptor-set layout.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED when the
entry point is absent.

Notes

If the ICD entry point is unavailable, the base method returns
VK_ERROR_INITIALIZATION_FAILED without writing its output handle.
When the ICD entry point is called, the returned handle is written
even if the ICD reports a failure; the local handle starts as NULL.

moHidd_Vulkan_CreateDevice

Synopsis

struct pHidd_Vulkan_CreateDevice

Function

Creates a logical Vulkan device for the selected physical device.

Inputs

physicalDevice - Vulkan physical-device handle.
pCreateInfo - Pointer to the operation's Vulkan create-info
    structure.

Result

Vulkan object handle, or NULL if creation fails or the entry point is
absent.

moHidd_Vulkan_CreateEvent

Synopsis

struct pHidd_Vulkan_CreateEvent

Function

Creates a Vulkan event.

Inputs

device - Vulkan logical-device handle.
pEvent - Required output pointer for an event handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED when the
entry point is absent.

Notes

The base implementation passes a VkEventCreateInfo with sType set to
VK_STRUCTURE_TYPE_EVENT_CREATE_INFO.

If the ICD entry point is unavailable, the base method returns
VK_ERROR_INITIALIZATION_FAILED without writing its output handle.
When the ICD entry point is called, the returned handle is written
even if the ICD reports a failure; the local handle starts as NULL.

moHidd_Vulkan_CreateFence

Synopsis

struct pHidd_Vulkan_CreateFence

Function

Creates a fence used for synchronization.

Inputs

device - Vulkan logical-device handle.
flags - Operation-specific Vulkan flag bits.
pFence - Required output pointer for a fence handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED when the
entry point is absent.

Notes

If the ICD entry point is unavailable, the base method returns
VK_ERROR_INITIALIZATION_FAILED without writing its output handle.
When the ICD entry point is called, the returned handle is written
even if the ICD reports a failure; the local handle starts as NULL.

moHidd_Vulkan_CreateInstance

Synopsis

struct pHidd_Vulkan_CreateInstance

Function

Creates a Vulkan instance using the driver's ICD entry point.

Inputs

applicationName - Application name passed to VkApplicationInfo.
applicationVersion - Application version passed to
    VkApplicationInfo.

Result

Vulkan object handle, or NULL if creation fails or the entry point is
absent.

Notes

The base implementation creates a Vulkan 1.2 VkApplicationInfo and
retains the first successfully created instance for subsequent command
resolution. It does not keep a list of instances. DestroyInstance
clears that pointer only when destroying the retained instance.

The base method supplies VkInstanceCreateInfo with no instance
extensions or layers enabled and passes NULL allocation callbacks.
The message provides no extension or layer lists.

moHidd_Vulkan_CreatePipelineLayout

Synopsis

struct pHidd_Vulkan_CreatePipelineLayout

Function

Creates a layout for descriptor sets and push constants.

Inputs

device - Vulkan logical-device handle.
setLayoutCount - Number of descriptor-set layouts.
pSetLayouts - Array of descriptor-set layouts.
pushConstantRangeCount - Number of push-constant ranges.
pPushConstantRanges - Array of push-constant ranges.
pPipelineLayout - Required output pointer for a pipeline-layout
    handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED when the
entry point is absent.

Notes

If the ICD entry point is unavailable, the base method returns
VK_ERROR_INITIALIZATION_FAILED without writing its output handle.
When the ICD entry point is called, the returned handle is written
even if the ICD reports a failure; the local handle starts as NULL.

moHidd_Vulkan_CreateQueryPool

Synopsis

struct pHidd_Vulkan_CreateQueryPool

Function

Creates a query pool.

Inputs

device - Vulkan logical-device handle.
pCreateInfo - Pointer to the operation's Vulkan create-info
    structure.
pQueryPool - Required output pointer for a query-pool handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED when the
entry point is absent.

Notes

If the ICD entry point is unavailable, the base method returns
VK_ERROR_INITIALIZATION_FAILED without writing its output handle.
When the ICD entry point is called, the returned handle is written
even if the ICD reports a failure; the local handle starts as NULL.

moHidd_Vulkan_CreateSemaphore

Synopsis

struct pHidd_Vulkan_CreateSemaphore

Function

Creates a semaphore used for queue synchronization.

Inputs

device - Vulkan logical-device handle.
pCreateInfo - Pointer to the operation's Vulkan create-info
    structure.
pSemaphore - Required output pointer for a semaphore handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED when the
entry point is absent.

Notes

If pCreateInfo is NULL, the base implementation supplies a
VkSemaphoreCreateInfo containing sType and no explicit flags.

If the ICD entry point is unavailable, the base method returns
VK_ERROR_INITIALIZATION_FAILED without writing its output handle.
When the ICD entry point is called, the returned handle is written
even if the ICD reports a failure; the local handle starts as NULL.

moHidd_Vulkan_CreateShaderModule

Synopsis

struct pHidd_Vulkan_CreateShaderModule

Function

Creates a shader module from SPIR-V code.

Inputs

device - Vulkan logical-device handle.
pCode - Pointer to SPIR-V code words.
codeSize - SPIR-V code size in bytes.
pShaderModule - Required output pointer for a shader-module
    handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED when the
entry point is absent.

Notes

The method constructs VkShaderModuleCreateInfo with the supplied code
and codeSize before invoking the ICD.

If the ICD entry point is unavailable, the base method returns
VK_ERROR_INITIALIZATION_FAILED without writing its output handle.
When the ICD entry point is called, the returned handle is written
even if the ICD reports a failure; the local handle starts as NULL.

moHidd_Vulkan_DestroyBuffer

Synopsis

struct pHidd_Vulkan_DestroyBuffer

Function

Destroys a Vulkan buffer.

Inputs

device - Vulkan logical-device handle.
buffer - Vulkan buffer handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_DestroyCommandPool

Synopsis

struct pHidd_Vulkan_DestroyCommandPool

Function

Destroys a command pool.

Inputs

device - Vulkan logical-device handle.
commandPool - Vulkan command-pool handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_DestroyDescriptorPool

Synopsis

struct pHidd_Vulkan_DestroyDescriptorPool

Function

Destroys a descriptor pool.

Inputs

device - Vulkan logical-device handle.
descriptorPool - Descriptor-pool handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_DestroyDescriptorSetLayout

Synopsis

struct pHidd_Vulkan_DestroyDescriptorSetLayout

Function

Destroys a descriptor-set layout.

Inputs

device - Vulkan logical-device handle.
descriptorSetLayout - Descriptor-set layout handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_DestroyDevice

Synopsis

struct pHidd_Vulkan_DestroyDevice

Function

Destroys a logical Vulkan device.

Inputs

device - Vulkan logical-device handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_DestroyEvent

Synopsis

struct pHidd_Vulkan_DestroyEvent

Function

Destroys a Vulkan event.

Inputs

device - Vulkan logical-device handle.
event - Vulkan event handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_DestroyFence

Synopsis

struct pHidd_Vulkan_DestroyFence

Function

Destroys a fence.

Inputs

device - Vulkan logical-device handle.
fence - Vulkan fence handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_DestroyInstance

Synopsis

struct pHidd_Vulkan_DestroyInstance

Function

Releases a Vulkan instance through the driver's ICD.

Inputs

instance - Vulkan instance handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

Notes

Destroying the retained instance clears the base class's instance
pointer. Other instances do not replace that pointer.

The base method clears its cached instance pointer for a matching
handle even when the ICD destroy entry point is unavailable.

moHidd_Vulkan_DestroyPipeline

Synopsis

struct pHidd_Vulkan_DestroyPipeline

Function

Destroys a Vulkan pipeline.

Inputs

device - Vulkan logical-device handle.
pipeline - Vulkan pipeline handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_DestroyPipelineLayout

Synopsis

struct pHidd_Vulkan_DestroyPipelineLayout

Function

Destroys a pipeline layout.

Inputs

device - Vulkan logical-device handle.
pipelineLayout - Vulkan pipeline-layout handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_DestroyQueryPool

Synopsis

struct pHidd_Vulkan_DestroyQueryPool

Function

Destroys a query pool.

Inputs

device - Vulkan logical-device handle.
queryPool - Vulkan query-pool handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_DestroySemaphore

Synopsis

struct pHidd_Vulkan_DestroySemaphore

Function

Destroys a semaphore.

Inputs

device - Vulkan logical-device handle.
semaphore - Vulkan semaphore handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_DestroyShaderModule

Synopsis

struct pHidd_Vulkan_DestroyShaderModule

Function

Destroys a shader module.

Inputs

device - Vulkan logical-device handle.
shaderModule - Vulkan shader-module handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_DeviceWaitIdle

Synopsis

struct pHidd_Vulkan_DeviceWaitIdle

Function

Waits for outstanding operations on a logical device to finish.

Inputs

device - Vulkan logical-device handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_DisplayResource

Synopsis

struct pHidd_Vulkan_DisplayResource

Function

Provides an optional driver-specific path for presenting an image.

Inputs

image - Driver-owned image or resource handle.
srcx - Source x coordinate.
srcy - Source y coordinate.
rastPort - Destination RastPort.
dstx - Destination x coordinate.
dsty - Destination y coordinate.
width - Width of the requested region.
height - Height of the requested region.

Result

No value. The base class performs no presentation.

Notes

The base implementation has an empty method body. A display-capable
driver must provide the presentation behavior.

moHidd_Vulkan_EndCommandBuffer

Synopsis

struct pHidd_Vulkan_EndCommandBuffer

Function

Ends command-buffer recording.

Inputs

commandBuffer - Vulkan command-buffer handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_EnumerateDeviceExtensionProperties

Synopsis

struct pHidd_Vulkan_EnumerateDeviceExtensionProperties

Function

Enumerates the extensions exposed by a physical device.

Inputs

physicalDevice - Vulkan physical-device handle.
pLayerName - Optional layer name passed to the ICD.
pPropertyCount - Pointer to the property count.
pProperties - Caller-provided output properties structure or
    array.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_EnumerateInstanceExtensionProperties

Synopsis

struct pHidd_Vulkan_EnumerateInstanceExtensionProperties

Function

Enumerates the ICD's instance extensions.

Inputs

pLayerName - Optional layer name passed to the ICD.
pPropertyCount - Pointer to the property count.
pProperties - Caller-provided output properties structure or
    array.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_EnumerateInstanceVersion

Synopsis

struct pHidd_Vulkan_EnumerateInstanceVersion

Function

Reads the Vulkan API version exposed by the ICD.

Inputs

pApiVersion - Required output pointer for the Vulkan API version.

Result

VkResult converted to IPTR. If the entry point is absent, the method
writes Vulkan 1.0 and returns VK_SUCCESS.

Notes

If the ICD lacks vkEnumerateInstanceVersion, the base implementation
writes VK_API_VERSION_1_0 and returns VK_SUCCESS.

moHidd_Vulkan_EnumeratePhysicalDevices

Synopsis

struct pHidd_Vulkan_EnumeratePhysicalDevices

Function

Enumerates physical devices associated with an instance.

Inputs

instance - Vulkan instance handle.
pPhysicalDeviceCount - Pointer to the physical-device count.
pPhysicalDevices - Optional output array of physical-device
    handles.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_FreeCommandBuffers

Synopsis

struct pHidd_Vulkan_FreeCommandBuffers

Function

Frees command buffers allocated from a command pool.

Inputs

device - Vulkan logical-device handle.
commandPool - Vulkan command-pool handle.
count - Number of command buffers.
pCommandBuffers - Array of command-buffer handles.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_FreeMemory

Synopsis

struct pHidd_Vulkan_FreeMemory

Function

Frees a Vulkan device-memory allocation.

Inputs

device - Vulkan logical-device handle.
memory - Vulkan device-memory handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_GetBufferDeviceAddress

Synopsis

struct pHidd_Vulkan_GetBufferDeviceAddress

Function

Queries a buffer's Vulkan device address.

Inputs

device - Vulkan logical-device handle.
pInfo - Pointer to the Vulkan query-info structure.

Result

Device address converted to IPTR, or zero when the entry point is
unavailable.

Notes

The base method returns IPTR, while vkGetBufferDeviceAddress returns a
Vulkan device address. On a target where IPTR is narrower than that
address, the conversion cannot represent all possible values.

moHidd_Vulkan_GetBufferMemoryRequirements

Synopsis

struct pHidd_Vulkan_GetBufferMemoryRequirements

Function

Queries the memory requirements of a buffer.

Inputs

device - Vulkan logical-device handle.
buffer - Vulkan buffer handle.
pMemoryRequirements - Required output memory-requirements
    structure.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_GetDeviceProcAddr

Synopsis

struct pHidd_Vulkan_GetDeviceProcAddr

Function

Resolves a device-level Vulkan function by name.

Inputs

device - Vulkan logical-device handle.
pName - NUL-terminated Vulkan entry-point name.

Result

ICD function pointer, or NULL if the required entry point is
unavailable.

Notes

The base implementation looks up vkGetDeviceProcAddr through the
instance dispatch path retained by CreateInstance. A missing entry
point returns NULL.

moHidd_Vulkan_GetDeviceQueue

Synopsis

struct pHidd_Vulkan_GetDeviceQueue

Function

Retrieves a queue handle from a logical device.

Inputs

device - Vulkan logical-device handle.
queueFamilyIndex - Index of a queue family.
queueIndex - Index of a queue within that family.
pQueue - Required output pointer for a queue handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

Notes

The base implementation initializes a local queue handle to NULL and
writes it to pQueue after attempting vkGetDeviceQueue.

moHidd_Vulkan_GetFenceStatus

Synopsis

struct pHidd_Vulkan_GetFenceStatus

Function

Queries whether a fence is signaled.

Inputs

device - Vulkan logical-device handle.
fence - Vulkan fence handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_GetInstanceProcAddr

Synopsis

struct pHidd_Vulkan_GetInstanceProcAddr

Function

Resolves an instance-level Vulkan function by name.

Inputs

instance - Vulkan instance handle.
pName - NUL-terminated Vulkan entry-point name.

Result

NULL from the base class. A subclass can return an ICD function
pointer.

Notes

The base implementation always returns NULL. Driver subclasses must
override this method to supply their Vulkan ICD entry points.

moHidd_Vulkan_GetMemoryHostPointerPropertiesEXT

Synopsis

struct pHidd_Vulkan_GetMemoryHostPointerPropertiesEXT

Function

Queries external-memory properties for a host pointer.

Inputs

device - Vulkan logical-device handle.
handleType - External-memory handle type.
pHostPointer - Host pointer to query.
pMemoryHostPointerProperties - Required output properties
    structure.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_GetPhysicalDeviceFeatures

Synopsis

struct pHidd_Vulkan_GetPhysicalDeviceFeatures

Function

Reads the supported features of a physical device.

Inputs

physicalDevice - Vulkan physical-device handle.
pFeatures - Caller-provided output features structure.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_GetPhysicalDeviceFeatures2

Synopsis

struct pHidd_Vulkan_GetPhysicalDeviceFeatures2

Function

Reads extended physical-device features.

Inputs

physicalDevice - Vulkan physical-device handle.
pFeatures - Caller-provided output features structure.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_GetPhysicalDeviceMemoryProperties

Synopsis

struct pHidd_Vulkan_GetPhysicalDeviceMemoryProperties

Function

Reads the memory heaps and types of a physical device.

Inputs

physicalDevice - Vulkan physical-device handle.
pMemoryProperties - Caller-provided memory-properties structure.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_GetPhysicalDeviceProperties

Synopsis

struct pHidd_Vulkan_GetPhysicalDeviceProperties

Function

Reads the properties of a physical device.

Inputs

physicalDevice - Vulkan physical-device handle.
pProperties - Caller-provided output properties structure or
    array.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_GetPhysicalDeviceProperties2

Synopsis

struct pHidd_Vulkan_GetPhysicalDeviceProperties2

Function

Reads extended physical-device properties.

Inputs

physicalDevice - Vulkan physical-device handle.
pProperties - Caller-provided output properties structure or
    array.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_GetPhysicalDeviceQueueFamilyProperties

Synopsis

struct pHidd_Vulkan_GetPhysicalDeviceQueueFamilyProperties

Function

Enumerates the queue families of a physical device.

Inputs

physicalDevice - Vulkan physical-device handle.
pQueueFamilyPropertyCount - Pointer to the queue-family count.
pQueueFamilyProperties - Optional output array of queue-family
    properties.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_GetQueryPoolResults

Synopsis

struct pHidd_Vulkan_GetQueryPoolResults

Function

Retrieves data from queries in a query pool.

Inputs

device - Vulkan logical-device handle.
queryPool - Vulkan query-pool handle.
firstQuery - Index of the first query.
queryCount - Number of queries.
dataSize - Size of the destination buffer in bytes.
pData - Destination buffer for query results.
stride - Byte stride between query results.
flags - Operation-specific Vulkan flag bits.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_MapMemory

Synopsis

struct pHidd_Vulkan_MapMemory

Function

Maps an allocation into the host address space.

Inputs

device - Vulkan logical-device handle.
memory - Vulkan device-memory handle.
offset - Byte offset in the specified memory or command range.
size - Size of the requested range in bytes.
flags - Operation-specific Vulkan flag bits.
ppData - Required output pointer for the mapped host address.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_QueueSubmit

Synopsis

struct pHidd_Vulkan_QueueSubmit

Function

Submits command buffers to a Vulkan queue.

Inputs

queue - Vulkan queue handle.
submitCount - Number of queue submissions.
pSubmits - Array of Vulkan submit descriptions.
fence - Vulkan fence handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_QueueWaitIdle

Synopsis

struct pHidd_Vulkan_QueueWaitIdle

Function

Waits until a Vulkan queue is idle.

Inputs

queue - Vulkan queue handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_ResetCommandPool

Synopsis

struct pHidd_Vulkan_ResetCommandPool

Function

Resets a command pool and its allocated command buffers.

Inputs

device - Vulkan logical-device handle.
commandPool - Vulkan command-pool handle.
flags - Operation-specific Vulkan flag bits.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_ResetEvent

Synopsis

struct pHidd_Vulkan_ResetEvent

Function

Clears the signaled state of an event.

Inputs

device - Vulkan logical-device handle.
event - Vulkan event handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_ResetFences

Synopsis

struct pHidd_Vulkan_ResetFences

Function

Resets one or more fences.

Inputs

device - Vulkan logical-device handle.
fenceCount - Number of fence handles.
pFences - Array of Vulkan fence handles.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_ResetQueryPool

Synopsis

struct pHidd_Vulkan_ResetQueryPool

Function

Resets a range of queries.

Inputs

device - Vulkan logical-device handle.
queryPool - Vulkan query-pool handle.
firstQuery - Index of the first query.
queryCount - Number of queries.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_SetEvent

Synopsis

struct pHidd_Vulkan_SetEvent

Function

Sets the signaled state of an event.

Inputs

device - Vulkan logical-device handle.
event - Vulkan event handle.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.

moHidd_Vulkan_UnmapMemory

Synopsis

struct pHidd_Vulkan_UnmapMemory

Function

Unmaps a device-memory allocation.

Inputs

device - Vulkan logical-device handle.
memory - Vulkan device-memory handle.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_UpdateDescriptorSets

Synopsis

struct pHidd_Vulkan_UpdateDescriptorSets

Function

Updates the descriptors referenced by descriptor sets.

Inputs

device - Vulkan logical-device handle.
descriptorWriteCount - Number of descriptor write operations.
pDescriptorWrites - Array of descriptor write descriptions.
descriptorCopyCount - Number of descriptor copy operations.
pDescriptorCopies - Array of descriptor copy descriptions.

Result

No return value. If the Vulkan entry point is absent, the base method
does not invoke it.

moHidd_Vulkan_WaitForFences

Synopsis

struct pHidd_Vulkan_WaitForFences

Function

Waits for the specified fences.

Inputs

device - Vulkan logical-device handle.
fenceCount - Number of fence handles.
pFences - Array of Vulkan fence handles.
waitAll - Whether all fences must be signaled.
timeout - Timeout in nanoseconds.

Result

VkResult converted to IPTR, or VK_ERROR_INITIALIZATION_FAILED if the
requested Vulkan entry point is unavailable.