Vulkan-Docs/doc/specs/vulkan/man/PFN_vkFreeFunction.txt

60 lines
1.4 KiB
Plaintext

// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/
PFN_vkFreeFunction(3)
=====================
Name
----
PFN_vkFreeFunction - application-defined memory free function
C Specification
---------------
// refBegin PFN_vkFreeFunction application-defined memory free function
The type of pname:pfnFree is:
include::../funcpointers/PFN_vkFreeFunction.txt[]
Parameters
----------
* pname:pUserData is the value specified for
slink:VkAllocationCallbacks.pUserData in the allocator specified by the
application.
* pname:pMemory is the allocation to be freed.
Description
-----------
pname:pMemory may: be `NULL`, which the callback must: handle safely. If
pname:pMemory is non-`NULL`, it must: be a pointer previously allocated by
pname:pfnAllocation or pname:pfnReallocation. The application should: free
this memory.
// refEnd PFN_vkFreeFunction VkAllocationCallbacks
See Also
--------
slink:VkAllocationCallbacks
Document Notes
--------------
For more information, see the Vulkan Specification at URL
https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#PFN_vkFreeFunction
This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.
include::footer.txt[]