Top Description Inners Constructors Methods
org.lwjgl.vulkan

public abstract Class VkReallocationFunction

extends Callback
implements VkReallocationFunctionI
Class Inheritance
All Implemented Interfaces
org.lwjgl.vulkan.VkReallocationFunctionI, org.lwjgl.system.CallbackI, org.lwjgl.system.Pointer
Known Direct Subclasses
org.lwjgl.vulkan.VkReallocationFunction.Container
Imports
javax.annotation.*, org.lwjgl.system.*

Application-defined memory reallocation function.
C Specification

The type of pfnReallocation is:


typedef void* (VKAPI_PTR *PFN_vkReallocationFunction)(
    void*                                       pUserData,
    void*                                       pOriginal,
    size_t                                      size,
    size_t                                      alignment,
    VkSystemAllocationScope                     allocationScope);
Description

If the reallocation was successful, pfnReallocation must return an allocation with enough space for size bytes, and the contents of the original allocation from bytes zero to min(original size, new size) - 1 must be preserved in the returned allocation. If size is larger than the old size, the contents of the additional space are undefined. If satisfying these requirements involves creating a new allocation, then the old allocation should be freed.

If pOriginal is NULL, then pfnReallocation must behave equivalently to a call to VkAllocationFunction with the same parameter values (without pOriginal).

If size is zero, then pfnReallocation must behave equivalently to a call to VkFreeFunction with the same pUserData parameter value, and pMemory equal to pOriginal.

If pOriginal is non-NULL, the implementation must ensure that alignment is equal to the alignment used to originally allocate pOriginal.

If this function fails and pOriginal is non-NULL the application must not free the old allocation.

pfnReallocation must follow the same rules for return values as PFN_vkAllocationFunction.

See Also

VkAllocationCallbacks

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Constructor Summary

AccessConstructor and Description
protected
pack-priv
VkReallocationFunction(long functionPointer)

Method Summary

Modifier and TypeMethod and Description
public static VkReallocationFunction

Returns:

the new VkReallocationFunction
create
(long functionPointer)

Creates a VkReallocationFunction instance from the specified function pointer.

public static VkReallocationFunction
create(VkReallocationFunctionI instance)

Creates a VkReallocationFunction instance that delegates to the specified VkReallocationFunctionI instance.

public static VkReallocationFunction
createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

Inherited from org.lwjgl.system.Callback:
addressequalsfreefreegetgetSafehashCodetoString

Constructor Detail

VkReallocationFunctionback to summary
protected VkReallocationFunction()
VkReallocationFunctionback to summary
pack-priv VkReallocationFunction(long functionPointer)

Method Detail

createback to summary
public static VkReallocationFunction create(long functionPointer)

Creates a VkReallocationFunction instance from the specified function pointer.

Returns:VkReallocationFunction

the new VkReallocationFunction

createback to summary
public static VkReallocationFunction create(VkReallocationFunctionI instance)

Creates a VkReallocationFunction instance that delegates to the specified VkReallocationFunctionI instance.

createSafeback to summary
public static VkReallocationFunction createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

Annotations
@Nullable
org.lwjgl.vulkan back to summary

private final Class VkReallocationFunction.Container

extends VkReallocationFunction
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final VkReallocationFunctionI

Constructor Summary

AccessConstructor and Description
pack-priv
Container(long functionPointer, VkReallocationFunctionI delegate)

Method Summary

Modifier and TypeMethod and Description
public long
invoke(long
the value specified for VkAllocationCallbacks::pUserData in the allocator specified by the application.
pUserData
,
long
must be either NULL or a pointer previously returned by pfnReallocation or pfnAllocation of a compatible allocator.
pOriginal
,
long
the size in bytes of the requested allocation.
size
,
long
the requested alignment of the allocation in bytes and must be a power of two.
alignment
,
int
a VkSystemAllocationScope value specifying the allocation scope of the lifetime of the allocation, as described here.
allocationScope
)

Implements org.lwjgl.vulkan.VkReallocationFunctionI.invoke.

Application-defined memory reallocation function.
Inherited from org.lwjgl.vulkan.VkReallocationFunction:
createcreatecreateSafe

Field Detail

delegateback to summary
private final VkReallocationFunctionI delegate

Constructor Detail

Containerback to summary
pack-priv Container(long functionPointer, VkReallocationFunctionI delegate)

Method Detail

invokeback to summary
public long invoke(long pUserData, long pOriginal, long size, long alignment, int allocationScope)

Implements org.lwjgl.vulkan.VkReallocationFunctionI.invoke.

Doc from org.lwjgl.vulkan.VkReallocationFunctionI.invoke.

Application-defined memory reallocation function.

Parameters
pUserData:long

the value specified for VkAllocationCallbacks::pUserData in the allocator specified by the application.

pOriginal:long

must be either NULL or a pointer previously returned by pfnReallocation or pfnAllocation of a compatible allocator.

size:long

the size in bytes of the requested allocation.

alignment:long

the requested alignment of the allocation in bytes and must be a power of two.

allocationScope:int

a VkSystemAllocationScope value specifying the allocation scope of the lifetime of the allocation, as described here.

Annotations
@Override