Function gpa::metrics::PrepareQueryManagerRequiredGraphicsApiCreationNeeds

Function Documentation

Result gpa::metrics::PrepareQueryManagerRequiredGraphicsApiCreationNeeds(gpa::metrics::GraphicsApi const graphicsApi, gpa::metrics::GraphicsApiExtensionType extensionType, void *pCreateData, gpa::metrics::QueryManagerGraphicsApiExtraBuffers *pExtraBuffers)

For the specified graphics API and type of extension object, used to perform required changes to the creation data provided to the graphics API when creating it.

Note

This function is essentially a NOP for D3D11 and D3D12 because no creation data is provided to those APIs for a device.

Parameters

  • graphicsApi -- [in] The graphics API to update and prepare creation data for.

  • extensionType -- [in] The type of graphics API extension object to update and prepare creation data for. All graphics APIs support kDevice. Only Vulkan supports kInstance.

  • pCreateData -- [inout] Pointer to the workload's create info structure ready to be passed to the associated create function. For Vulkan, with kDevice must be a VkDeviceCreateInfo and with kInstance must be a must be a VkInstanceCreateInfo. For D3D12 and D3D11, must be a nullptr.

  • pExtraBuffers -- [inout] Pointer to structure that holds extra graphics API specific creation related data buffers that may be used and linked upon successful return with the provided create data. Only used by Vulkan. For D3D12 and D3D11, must be a nullptr.

Returns

Upon return, the contents of the base create data is updated and the extra create buffers will be setup/linked with the base create data if they are needed. They base create data is expected to be used subsequently by the create function (for example, with vkCreateDevice or vkCreateInstance).