VKGETDEVICEPROCADDR(3)

NAME
vkGetDeviceProcAddr - Return a function pointer for a command

C SPECIFICATION

    PFN_vkVoidFunction vkGetDeviceProcAddr(
        VkDevice                                    device,
        const char*                                 pName);

PARAMETERS

device
    The VkDevice whose function pointer to query.

pName
    The name of the command.

DESCRIPTION

vkGetDeviceProcAddr returns a function pointer for the command specified in pName as it corresponds to device. Depending on the operating system, supporting components, software environment and hardware topology, the function pointer returned for a single command name may be different for different values of device.

Device-specific function pointers only exist for commands that take a device-child object as their first parameter. In the core API these are VkDevice, VkQueue, and VkCommandBuffer, though extensions may introduce additional dispatchable device-child object types. vkGetDeviceProcAddr will return NULL when pName is not one of these commands.

VALID USAGE

    • device must be a valid VkDevice handle

    • pName must be a null-terminated string

    • pName must be the name of a supported command that has a first parameter of type VkDevice, VkQueue or VkCommandBuffer, either in the core API or an enabled extension

RETURN VALUE

Upon success, vkGetDeviceProcAddr returns a function pointer (PFN_vkVoidFunction) for the command specified in pName. If pName is not supported by the device or has no corresponding device, then vkGetDeviceProcAddr returns NULL.

SEE ALSO

vkGetInstanceProcAddr, vkCreateDevice

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.