Vulkan.Core10.AllocationCallbacks

Documentation

data AllocationCallbacks

VkAllocationCallbacks - Structure containing callback function pointers for memory allocation

Description

• pUserData is a value to be interpreted by the implementation of the callbacks. When any of the callbacks in AllocationCallbacks are called, the Vulkan implementation will pass this value as the first parameter to the callback. This value can vary each time an allocator is passed into a command, even when the same object takes an allocator in multiple commands.

• pfnAllocation is a PFN_vkAllocationFunction pointer to an application-defined memory allocation function.
• pfnReallocation is a PFN_vkReallocationFunction pointer to an application-defined memory reallocation function.
• pfnFree is a PFN_vkFreeFunction pointer to an application-defined memory free function.
• pfnInternalAllocation is a PFN_vkInternalAllocationNotification pointer to an application-defined function that is called by the implementation when the implementation makes internal allocations.
• pfnInternalFree is a PFN_vkInternalFreeNotification pointer to an application-defined function that is called by the implementation when the implementation frees internal allocations.

Valid Usage

• pfnAllocation must be a valid pointer to a valid user-defined PFN_vkAllocationFunction

• pfnReallocation must be a valid pointer to a valid user-defined PFN_vkReallocationFunction
• pfnFree must be a valid pointer to a valid user-defined PFN_vkFreeFunction
• If either of pfnInternalAllocation or pfnInternalFree is not NULL, both must be valid callbacks

See Also

PFN_vkAllocationFunction, PFN_vkFreeFunction, PFN_vkInternalAllocationNotification, PFN_vkInternalFreeNotification, PFN_vkReallocationFunction, VK_VERSION_1_0, allocateMemory, createAccelerationStructureKHR, createAccelerationStructureNV, createAndroidSurfaceKHR, createBuffer, createBufferCollectionFUCHSIA, createBufferView, createCommandPool, createComputePipelines, createCuFunctionNVX, createCuModuleNVX, createDebugReportCallbackEXT, createDebugUtilsMessengerEXT, createDeferredOperationKHR, createDescriptorPool, createDescriptorSetLayout, createDescriptorUpdateTemplate, createDescriptorUpdateTemplateKHR, createDevice, createDirectFBSurfaceEXT, createDisplayModeKHR, createDisplayPlaneSurfaceKHR, createEvent, createExecutionGraphPipelinesAMDX, createFence, createFramebuffer, createGraphicsPipelines, createHeadlessSurfaceEXT, createIOSSurfaceMVK, createImage, createImagePipeSurfaceFUCHSIA, createImageView, createIndirectCommandsLayoutNV, createInstance, createMacOSSurfaceMVK, createMetalSurfaceEXT, createMicromapEXT, createOpticalFlowSessionNV, createPipelineCache, createPipelineLayout, createPrivateDataSlot, createPrivateDataSlotEXT, createQueryPool, createRayTracingPipelinesKHR, createRayTracingPipelinesNV, createRenderPass, createRenderPass2, createRenderPass2KHR, createSampler, createSamplerYcbcrConversion, createSamplerYcbcrConversionKHR, createScreenSurfaceQNX, createSemaphore, createShaderModule, createShadersEXT, createSharedSwapchainsKHR, createStreamDescriptorSurfaceGGP, createSwapchainKHR, createValidationCacheEXT, createViSurfaceNN, vkCreateVideoSessionKHR, vkCreateVideoSessionParametersKHR, createWaylandSurfaceKHR, createWin32SurfaceKHR, createXcbSurfaceKHR, createXlibSurfaceKHR, destroyAccelerationStructureKHR, destroyAccelerationStructureNV, destroyBuffer, destroyBufferCollectionFUCHSIA, destroyBufferView, destroyCommandPool, destroyCuFunctionNVX, destroyCuModuleNVX, destroyDebugReportCallbackEXT, destroyDebugUtilsMessengerEXT, destroyDeferredOperationKHR, destroyDescriptorPool, destroyDescriptorSetLayout, destroyDescriptorUpdateTemplate, destroyDescriptorUpdateTemplateKHR, destroyDevice, destroyEvent, destroyFence, destroyFramebuffer, destroyImage, destroyImageView, destroyIndirectCommandsLayoutNV, destroyInstance, destroyMicromapEXT, destroyOpticalFlowSessionNV, destroyPipeline, destroyPipelineCache, destroyPipelineLayout, destroyPrivateDataSlot, destroyPrivateDataSlotEXT, destroyQueryPool, destroyRenderPass, destroySampler, destroySamplerYcbcrConversion, destroySamplerYcbcrConversionKHR, destroySemaphore, destroyShaderEXT, destroyShaderModule, destroySurfaceKHR, destroySwapchainKHR, destroyValidationCacheEXT, vkDestroyVideoSessionKHR, vkDestroyVideoSessionParametersKHR, freeMemory, registerDeviceEventEXT, registerDisplayEventEXT

Constructors

AllocationCallbacks

Fields

• userData :: Ptr ()
• pfnAllocation :: PFN_vkAllocationFunction
• pfnReallocation :: PFN_vkReallocationFunction
• pfnFree :: PFN_vkFreeFunction
• pfnInternalAllocation :: PFN_vkInternalAllocationNotification
• pfnInternalFree :: PFN_vkInternalFreeNotification

Instances

Storable AllocationCallbacks

Defined in Vulkan.Core10.AllocationCallbacks

Methods

sizeOf :: AllocationCallbacks -> Int

alignment :: AllocationCallbacks -> Int

peekElemOff :: Ptr AllocationCallbacks -> Int -> IO AllocationCallbacks

pokeElemOff :: Ptr AllocationCallbacks -> Int -> AllocationCallbacks -> IO ()

peekByteOff :: Ptr b -> Int -> IO AllocationCallbacks

pokeByteOff :: Ptr b -> Int -> AllocationCallbacks -> IO ()

peek :: Ptr AllocationCallbacks -> IO AllocationCallbacks

poke :: Ptr AllocationCallbacks -> AllocationCallbacks -> IO ()

Show AllocationCallbacks

Defined in Vulkan.Core10.AllocationCallbacks

Methods

showsPrec :: Int -> AllocationCallbacks -> ShowS

show :: AllocationCallbacks -> String

showList :: [AllocationCallbacks] -> ShowS

FromCStruct AllocationCallbacks

Defined in Vulkan.Core10.AllocationCallbacks

Methods

peekCStruct :: Ptr AllocationCallbacks -> IO AllocationCallbacks

ToCStruct AllocationCallbacks

Defined in Vulkan.Core10.AllocationCallbacks

Methods

withCStruct :: AllocationCallbacks -> (Ptr AllocationCallbacks -> IO b) -> IO b

pokeCStruct :: Ptr AllocationCallbacks -> AllocationCallbacks -> IO b -> IO b

withZeroCStruct :: (Ptr AllocationCallbacks -> IO b) -> IO b

pokeZeroCStruct :: Ptr AllocationCallbacks -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AllocationCallbacks

Defined in Vulkan.Core10.AllocationCallbacks

Methods

zero :: AllocationCallbacks