From b9ec5776bbe864f40ed688d76ca5e715a903f2dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 29 Nov 2020 17:33:57 +0100 Subject: [PATCH] doc: mention ignored overrides for Vulkan host allocations. --- doc/vulkan-wrapping.dox | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/doc/vulkan-wrapping.dox b/doc/vulkan-wrapping.dox index 0e77dc44e..d74385302 100644 --- a/doc/vulkan-wrapping.dox +++ b/doc/vulkan-wrapping.dox @@ -66,10 +66,20 @@ tied to a particular instance/device still apply: @section vulkan-wrapping-create-info CreateInfo structure wrappers -In most cases, a`Vk::*CreateInfo` instance has all required fields set to valid -values upon construction, with everything else optional. One exception to this -rule is for example @ref Vk::DeviceCreateInfo, where the user is expected to -call @ref Vk::DeviceCreateInfo::addQueues() "addQueues()". +Unless said otherwise in the particular constructor docs, a`Vk::*CreateInfo` +instance has all required fields set to valid values upon construction, with +everything else optional. One exception is for example +@ref Vk::DeviceCreateInfo, where the user is expected to call +@ref Vk::DeviceCreateInfo::addQueues() "addQueues()" as well. + +@section vulkan-wrapping-host-allocation Host memory allocation + +As opposed to device memory allocation, which is exposed through +@ref Vk::Memory and related APIs, overriding host memory allocation via +@type_vk{AllocationCallbacks} is not possible as use cases for overriding host +memory allocators are quite rare. This pointer is thus always set to +@cpp nullptr @ce in any `vkCreate*()` calls. If you want to supply your own +callbacks, @section vulkan-wrapping-raw Common interfaces for interaction with raw Vulkan code