Top Description Inners Constructors Methods
org.lwjgl.vulkan

public abstract Class VkFreeFunction

extends Callback
implements VkFreeFunctionI
Class Inheritance
All Implemented Interfaces
org.lwjgl.vulkan.VkFreeFunctionI, org.lwjgl.system.CallbackI, org.lwjgl.system.Pointer
Known Direct Subclasses
org.lwjgl.vulkan.VkFreeFunction.Container
Imports
javax.annotation.*, org.lwjgl.system.*
Application-defined memory free function.
C Specification

The type of pfnFree is:


typedef void (VKAPI_PTR *PFN_vkFreeFunction)(
    void*                                       pUserData,
    void*                                       pMemory);
Description

pMemory may be NULL, which the callback must handle safely. If pMemory is non-NULL, it must be a pointer previously allocated by pfnAllocation or pfnReallocation. The application should free this memory.

See Also

VkAllocationCallbacks

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
VkFreeFunction.Container

Constructor Summary

AccessConstructor and Description
protected
VkFreeFunction()

pack-priv
VkFreeFunction(long functionPointer)

Method Summary

Modifier and TypeMethod and Description
public static VkFreeFunction

Returns:

the new VkFreeFunction
create(long functionPointer)

Creates a VkFreeFunction instance from the specified function pointer.

public static VkFreeFunction
create(VkFreeFunctionI instance)

Creates a VkFreeFunction instance that delegates to the specified VkFreeFunctionI instance.

public static VkFreeFunction
createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

Inherited from org.lwjgl.system.Callback:
addressequalsfreefreegetgetSafehashCodetoString

Constructor Detail

VkFreeFunctionback to summary
protected VkFreeFunction()
VkFreeFunctionback to summary
pack-priv VkFreeFunction(long functionPointer)

Method Detail

createback to summary
public static VkFreeFunction create(long functionPointer)

Creates a VkFreeFunction instance from the specified function pointer.

Returns:VkFreeFunction

the new VkFreeFunction

createback to summary
public static VkFreeFunction create(VkFreeFunctionI instance)

Creates a VkFreeFunction instance that delegates to the specified VkFreeFunctionI instance.

createSafeback to summary
public static VkFreeFunction createSafe(long functionPointer)

Like create, but returns null if functionPointer is NULL.

Annotations
@Nullable
org.lwjgl.vulkan back to summary

private final Class VkFreeFunction.Container

extends VkFreeFunction
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final VkFreeFunctionI
delegate

Constructor Summary

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

Method Summary

Modifier and TypeMethod and Description
public void
invoke(long
the value specified for VkAllocationCallbacks::pUserData in the allocator specified by the application.
pUserData, long
the allocation to be freed.
pMemory)

Implements org.lwjgl.vulkan.VkFreeFunctionI.invoke.

Application-defined memory free function.
Inherited from org.lwjgl.vulkan.VkFreeFunction:
createcreatecreateSafe

Field Detail

delegateback to summary
private final VkFreeFunctionI delegate

Constructor Detail

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

Method Detail

invokeback to summary
public void invoke(long pUserData, long pMemory)

Implements org.lwjgl.vulkan.VkFreeFunctionI.invoke.

Doc from org.lwjgl.vulkan.VkFreeFunctionI.invoke.

Application-defined memory free function.

Parameters
pUserData:long

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

pMemory:long

the allocation to be freed.

Annotations
@Override