Function gpa::metrics::GetQueryManagerRequiredGraphicsApiExtensions

Function Documentation

Result gpa::metrics::GetQueryManagerRequiredGraphicsApiExtensions(gpa::metrics::GraphicsApi const graphicsApi, GraphicsApiExtensionType const extensionType, uint32_t *pExtensionCount, GraphicsApiExtension *pExtensions)

Used to determine, for the specified graphics API, if there are any required device extensions/features that must be supported and enabled on the specified instance and device when IQueryManager::Initialize is called. Has similar usage behavior to the Vulkan vkEnumerateInstanceExtensionProperties and vkEnumerateDeviceExtensionProperties functions.

Note

Upon success, if pExtensions is null, the value pointed to by pExtensionCount is set to the number of required extensions for the specific graphics API extension type and kSuccess is returned. Otherwise, the value pointed to by pExtensionCount must equal the number of elements in the pExtensions array and upon return it is set to the number of required extensions copied to pExtensions for the specified graphics API and extension type. When the array is not large enough to copy all of them, kIncomplete is returned instead of kSuccess.

Parameters

  • graphicsApi -- [in] The graphics API to check for any required extensions.

  • extensionType -- [in] The type of required extensions to check for needed for the specified graphics API.

  • pExtensionCount -- [inout] Pointer to a variable related to the number of extensions of the specified type available or queried. Review notes for usage details.

  • pExtensions -- [inout] Pointer to an array of GraphicsApiExtension structs of the specified type or null. Review notes for usage details.

Returns

Upon success, kSuccess or kIncomplete is returned. Review notes for additional actions taken.