VKCREATEQUERYPOOL(3)

NAME
vkCreateQueryPool - Create a new query pool object.

C SPECIFICATION

    VkResult vkCreateQueryPool(
        VkDevice                                    device,
        const VkQueryPoolCreateInfo*                pCreateInfo,
        const VkAllocationCallbacks*                pAllocator,
        VkQueryPool*                                pQueryPool);

PARAMETERS

device
    The device with which to create the query pool object.

pCreateInfo
    A pointer to a structure containing information to be placed in the object.

pQueryPool
    A pointer to a variable which will receive the handle to the new object.

DESCRIPTION

vkCreateQueryPool creates a new query pool object using the information contained in pCreateInfo and the device specified in device. Upon success, a handle to the new query pool object is deposited in the variable pointed to by pQueryPool. pCreateInfo should point to an instance of the VkQueryPoolCreateInfo structure, the definition of which is:

    typedef struct VkQueryPoolCreateInfo {
        VkStructureType                  sType;
        const void*                      pNext;
        VkQueryPoolCreateFlags           flags;
        VkQueryType                      queryType;
        uint32_t                         queryCount;
        VkQueryPipelineStatisticFlags    pipelineStatistics;
    } VkQueryPoolCreateInfo;

VALID USAGE

    • device must be a valid VkDevice handle

    • pCreateInfo must be a pointer to a valid VkQueryPoolCreateInfo structure

    • If pAllocator is not NULL, pAllocator must be a pointer to a valid VkAllocationCallbacks structure

    • pQueryPool must be a pointer to a VkQueryPool handle

RETURN CODES

On success, this command returns

        • VK_SUCCESS

On failure, this command returns

        • VK_ERROR_OUT_OF_HOST_MEMORY

        • VK_ERROR_OUT_OF_DEVICE_MEMORY

RETURN VALUE

Upon success, vkCreateQueryPool returns VK_SUCCESS and deposits the resulting query pool handle in the variable pointed to by pQueryPool. Upon failure, a descriptive error code is returned.

SEE ALSO

vkCmdResetQueryPool, vkCmdBeginQuery, vkCmdEndQuery, vkDestroyQueryPool, vkGetQueryPoolResults, vkCmdCopyQueryPoolResults

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.