Package org.lwjgl.util.ktx

Class ktxVulkanTexture_subAllocatorCallbacks

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<ktxVulkanTexture_subAllocatorCallbacks>

org.lwjgl.util.ktx.ktxVulkanTexture_subAllocatorCallbacks

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class ktxVulkanTexture_subAllocatorCallbacks
extends org.lwjgl.system.Struct<ktxVulkanTexture_subAllocatorCallbacks>
implements org.lwjgl.system.NativeResource

Struct that contains all callbacks necessary for suballocation.

These pointers must all be provided for upload or destroy to occur using suballocator callbacks.

Layout

 struct ktxVulkanTexture_subAllocatorCallbacks {
     void * (*allocMemFuncPtr) (VkMemoryAllocateInfo *allocInfo, VkMemoryRequirements *memReq, uint64_t *pageCount);
     void * (*bindBufferFuncPtr) (VkBuffer buffer, uint64_t allocId);
     void * (*bindImageFuncPtr) (VkImage image, uint64_t allocId);
     void * (*memoryMapFuncPtr) (uint64_t allocId, uint64_t pageNumber, VkDeviceSize *mapLength, void **dataPtr);
     void * (*memoryUnmapFuncPtr) (uint64_t allocId, uint64_t pageNumber);
     void * (*freeMemFuncPtr) (uint64_t allocId);
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ktxVulkanTexture_subAllocatorCallbacks.Buffer	An array of ktxVulkanTexture_subAllocatorCallbacks structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	ALLOCMEMFUNCPTR	The struct member offsets.
static final int	BINDBUFFERFUNCPTR	The struct member offsets.
static final int	BINDIMAGEFUNCPTR	The struct member offsets.
static final int	FREEMEMFUNCPTR	The struct member offsets.
static final int	MEMORYMAPFUNCPTR	The struct member offsets.
static final int	MEMORYUNMAPFUNCPTR	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
ktxVulkanTexture_subAllocatorCallbacks(ByteBuffer container)	Creates a ktxVulkanTexture_subAllocatorCallbacks instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
ktxVulkanTexture_subAllocatorAllocMemFuncPtr	allocMemFuncPtr()	pointer to the memory procurement function.
ktxVulkanTexture_subAllocatorCallbacks	allocMemFuncPtr(ktxVulkanTexture_subAllocatorAllocMemFuncPtrI value)	Sets the specified value to the allocMemFuncPtr() field.
ktxVulkanTexture_subAllocatorBindBufferFuncPtr	bindBufferFuncPtr()	pointer to bind-buffer-to-suballocation(s) function
ktxVulkanTexture_subAllocatorCallbacks	bindBufferFuncPtr(ktxVulkanTexture_subAllocatorBindBufferFuncPtrI value)	Sets the specified value to the bindBufferFuncPtr() field.
ktxVulkanTexture_subAllocatorBindImageFuncPtr	bindImageFuncPtr()	ointer to bind-image-to-suballocation(s) function
ktxVulkanTexture_subAllocatorCallbacks	bindImageFuncPtr(ktxVulkanTexture_subAllocatorBindImageFuncPtrI value)	Sets the specified value to the bindImageFuncPtr() field.
static ktxVulkanTexture_subAllocatorCallbacks	calloc()	Returns a new ktxVulkanTexture_subAllocatorCallbacks instance allocated with memCalloc.
static ktxVulkanTexture_subAllocatorCallbacks.Buffer	calloc(int capacity)	Returns a new ktxVulkanTexture_subAllocatorCallbacks.Buffer instance allocated with memCalloc.
static ktxVulkanTexture_subAllocatorCallbacks.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new ktxVulkanTexture_subAllocatorCallbacks.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ktxVulkanTexture_subAllocatorCallbacks	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new ktxVulkanTexture_subAllocatorCallbacks instance allocated on the specified MemoryStack and initializes all its bits to zero.
static ktxVulkanTexture_subAllocatorCallbacks	create()	Returns a new ktxVulkanTexture_subAllocatorCallbacks instance allocated with BufferUtils.
static ktxVulkanTexture_subAllocatorCallbacks.Buffer	create(int capacity)	Returns a new ktxVulkanTexture_subAllocatorCallbacks.Buffer instance allocated with BufferUtils.
static ktxVulkanTexture_subAllocatorCallbacks	create(long address)	Returns a new ktxVulkanTexture_subAllocatorCallbacks instance for the specified memory address.
static ktxVulkanTexture_subAllocatorCallbacks.Buffer	create(long address, int capacity)	Create a ktxVulkanTexture_subAllocatorCallbacks.Buffer instance at the specified memory.
static @Nullable ktxVulkanTexture_subAllocatorCallbacks	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable ktxVulkanTexture_subAllocatorCallbacks.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
ktxVulkanTexture_subAllocatorFreeMemFuncPtr	freeMemFuncPtr()	pointer to the free procurement function
ktxVulkanTexture_subAllocatorCallbacks	freeMemFuncPtr(ktxVulkanTexture_subAllocatorFreeMemFuncPtrI value)	Sets the specified value to the freeMemFuncPtr() field.
static ktxVulkanTexture_subAllocatorCallbacks	malloc()	Returns a new ktxVulkanTexture_subAllocatorCallbacks instance allocated with memAlloc.
static ktxVulkanTexture_subAllocatorCallbacks.Buffer	malloc(int capacity)	Returns a new ktxVulkanTexture_subAllocatorCallbacks.Buffer instance allocated with memAlloc.
static ktxVulkanTexture_subAllocatorCallbacks.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new ktxVulkanTexture_subAllocatorCallbacks.Buffer instance allocated on the specified MemoryStack.
static ktxVulkanTexture_subAllocatorCallbacks	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new ktxVulkanTexture_subAllocatorCallbacks instance allocated on the specified MemoryStack.
ktxVulkanTexture_subAllocatorMemoryMapFuncPtr	memoryMapFuncPtr()	pointer to function for mapping the memory of a specific page
ktxVulkanTexture_subAllocatorCallbacks	memoryMapFuncPtr(ktxVulkanTexture_subAllocatorMemoryMapFuncPtrI value)	Sets the specified value to the memoryMapFuncPtr() field.
ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtr	memoryUnmapFuncPtr()	pointer to function for unmapping the memory of a specific page
ktxVulkanTexture_subAllocatorCallbacks	memoryUnmapFuncPtr(ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtrI value)	Sets the specified value to the memoryUnmapFuncPtr() field.
static ktxVulkanTexture_subAllocatorAllocMemFuncPtr	nallocMemFuncPtr(long struct)	Unsafe version of allocMemFuncPtr().
static void	nallocMemFuncPtr(long struct, ktxVulkanTexture_subAllocatorAllocMemFuncPtrI value)	Unsafe version of allocMemFuncPtr.
static ktxVulkanTexture_subAllocatorBindBufferFuncPtr	nbindBufferFuncPtr(long struct)	Unsafe version of bindBufferFuncPtr().
static void	nbindBufferFuncPtr(long struct, ktxVulkanTexture_subAllocatorBindBufferFuncPtrI value)	Unsafe version of bindBufferFuncPtr.
static ktxVulkanTexture_subAllocatorBindImageFuncPtr	nbindImageFuncPtr(long struct)	Unsafe version of bindImageFuncPtr().
static void	nbindImageFuncPtr(long struct, ktxVulkanTexture_subAllocatorBindImageFuncPtrI value)	Unsafe version of bindImageFuncPtr.
static ktxVulkanTexture_subAllocatorFreeMemFuncPtr	nfreeMemFuncPtr(long struct)	Unsafe version of freeMemFuncPtr().
static void	nfreeMemFuncPtr(long struct, ktxVulkanTexture_subAllocatorFreeMemFuncPtrI value)	Unsafe version of freeMemFuncPtr.
static ktxVulkanTexture_subAllocatorMemoryMapFuncPtr	nmemoryMapFuncPtr(long struct)	Unsafe version of memoryMapFuncPtr().
static void	nmemoryMapFuncPtr(long struct, ktxVulkanTexture_subAllocatorMemoryMapFuncPtrI value)	Unsafe version of memoryMapFuncPtr.
static ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtr	nmemoryUnmapFuncPtr(long struct)	Unsafe version of memoryUnmapFuncPtr().
static void	nmemoryUnmapFuncPtr(long struct, ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtrI value)	Unsafe version of memoryUnmapFuncPtr.
ktxVulkanTexture_subAllocatorCallbacks	set(ktxVulkanTexture_subAllocatorAllocMemFuncPtrI allocMemFuncPtr, ktxVulkanTexture_subAllocatorBindBufferFuncPtrI bindBufferFuncPtr, ktxVulkanTexture_subAllocatorBindImageFuncPtrI bindImageFuncPtr, ktxVulkanTexture_subAllocatorMemoryMapFuncPtrI memoryMapFuncPtr, ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtrI memoryUnmapFuncPtr, ktxVulkanTexture_subAllocatorFreeMemFuncPtrI freeMemFuncPtr)	Initializes this struct with the specified values.
ktxVulkanTexture_subAllocatorCallbacks	set(ktxVulkanTexture_subAllocatorCallbacks src)	Copies the specified struct data to this struct.
int	sizeof()
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

ALLOCMEMFUNCPTR

public static final int ALLOCMEMFUNCPTR

The struct member offsets.

BINDBUFFERFUNCPTR

public static final int BINDBUFFERFUNCPTR

The struct member offsets.

BINDIMAGEFUNCPTR

public static final int BINDIMAGEFUNCPTR

The struct member offsets.

MEMORYMAPFUNCPTR

public static final int MEMORYMAPFUNCPTR

The struct member offsets.

MEMORYUNMAPFUNCPTR

public static final int MEMORYUNMAPFUNCPTR

The struct member offsets.

FREEMEMFUNCPTR

public static final int FREEMEMFUNCPTR

The struct member offsets.

Constructor Details

ktxVulkanTexture_subAllocatorCallbacks

public ktxVulkanTexture_subAllocatorCallbacks(ByteBuffer container)

Creates a ktxVulkanTexture_subAllocatorCallbacks instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<ktxVulkanTexture_subAllocatorCallbacks>

allocMemFuncPtr

public ktxVulkanTexture_subAllocatorAllocMemFuncPtr allocMemFuncPtr()

pointer to the memory procurement function. Can suballocate one or more pages.

bindBufferFuncPtr

public ktxVulkanTexture_subAllocatorBindBufferFuncPtr bindBufferFuncPtr()

pointer to bind-buffer-to-suballocation(s) function

bindImageFuncPtr

public ktxVulkanTexture_subAllocatorBindImageFuncPtr bindImageFuncPtr()

ointer to bind-image-to-suballocation(s) function

memoryMapFuncPtr

public ktxVulkanTexture_subAllocatorMemoryMapFuncPtr memoryMapFuncPtr()

pointer to function for mapping the memory of a specific page

memoryUnmapFuncPtr

public ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtr memoryUnmapFuncPtr()

pointer to function for unmapping the memory of a specific page

freeMemFuncPtr

public ktxVulkanTexture_subAllocatorFreeMemFuncPtr freeMemFuncPtr()

pointer to the free procurement function

allocMemFuncPtr

public ktxVulkanTexture_subAllocatorCallbacks allocMemFuncPtr(ktxVulkanTexture_subAllocatorAllocMemFuncPtrI value)

Sets the specified value to the allocMemFuncPtr() field.

bindBufferFuncPtr

public ktxVulkanTexture_subAllocatorCallbacks bindBufferFuncPtr(ktxVulkanTexture_subAllocatorBindBufferFuncPtrI value)

Sets the specified value to the bindBufferFuncPtr() field.

bindImageFuncPtr

public ktxVulkanTexture_subAllocatorCallbacks bindImageFuncPtr(ktxVulkanTexture_subAllocatorBindImageFuncPtrI value)

Sets the specified value to the bindImageFuncPtr() field.

memoryMapFuncPtr

public ktxVulkanTexture_subAllocatorCallbacks memoryMapFuncPtr(ktxVulkanTexture_subAllocatorMemoryMapFuncPtrI value)

Sets the specified value to the memoryMapFuncPtr() field.

memoryUnmapFuncPtr

public ktxVulkanTexture_subAllocatorCallbacks memoryUnmapFuncPtr(ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtrI value)

Sets the specified value to the memoryUnmapFuncPtr() field.

freeMemFuncPtr

public ktxVulkanTexture_subAllocatorCallbacks freeMemFuncPtr(ktxVulkanTexture_subAllocatorFreeMemFuncPtrI value)

Sets the specified value to the freeMemFuncPtr() field.

set

public ktxVulkanTexture_subAllocatorCallbacks set(ktxVulkanTexture_subAllocatorAllocMemFuncPtrI allocMemFuncPtr,
 ktxVulkanTexture_subAllocatorBindBufferFuncPtrI bindBufferFuncPtr,
 ktxVulkanTexture_subAllocatorBindImageFuncPtrI bindImageFuncPtr,
 ktxVulkanTexture_subAllocatorMemoryMapFuncPtrI memoryMapFuncPtr,
 ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtrI memoryUnmapFuncPtr,
 ktxVulkanTexture_subAllocatorFreeMemFuncPtrI freeMemFuncPtr)

Initializes this struct with the specified values.

set

public ktxVulkanTexture_subAllocatorCallbacks set(ktxVulkanTexture_subAllocatorCallbacks src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static ktxVulkanTexture_subAllocatorCallbacks malloc()

Returns a new ktxVulkanTexture_subAllocatorCallbacks instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static ktxVulkanTexture_subAllocatorCallbacks calloc()

Returns a new ktxVulkanTexture_subAllocatorCallbacks instance allocated with memCalloc. The instance must be explicitly freed.

create

public static ktxVulkanTexture_subAllocatorCallbacks create()

Returns a new ktxVulkanTexture_subAllocatorCallbacks instance allocated with BufferUtils.

create

public static ktxVulkanTexture_subAllocatorCallbacks create(long address)

Returns a new ktxVulkanTexture_subAllocatorCallbacks instance for the specified memory address.

createSafe

public static @Nullable ktxVulkanTexture_subAllocatorCallbacks createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static ktxVulkanTexture_subAllocatorCallbacks.Buffer malloc(int capacity)

Returns a new ktxVulkanTexture_subAllocatorCallbacks.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static ktxVulkanTexture_subAllocatorCallbacks.Buffer calloc(int capacity)

Returns a new ktxVulkanTexture_subAllocatorCallbacks.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static ktxVulkanTexture_subAllocatorCallbacks.Buffer create(int capacity)

Returns a new ktxVulkanTexture_subAllocatorCallbacks.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static ktxVulkanTexture_subAllocatorCallbacks.Buffer create(long address,
 int capacity)

Create a ktxVulkanTexture_subAllocatorCallbacks.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable ktxVulkanTexture_subAllocatorCallbacks.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static ktxVulkanTexture_subAllocatorCallbacks malloc(org.lwjgl.system.MemoryStack stack)

Returns a new ktxVulkanTexture_subAllocatorCallbacks instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static ktxVulkanTexture_subAllocatorCallbacks calloc(org.lwjgl.system.MemoryStack stack)

Returns a new ktxVulkanTexture_subAllocatorCallbacks instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static ktxVulkanTexture_subAllocatorCallbacks.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new ktxVulkanTexture_subAllocatorCallbacks.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static ktxVulkanTexture_subAllocatorCallbacks.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new ktxVulkanTexture_subAllocatorCallbacks.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nallocMemFuncPtr

public static ktxVulkanTexture_subAllocatorAllocMemFuncPtr nallocMemFuncPtr(long struct)

Unsafe version of allocMemFuncPtr().

nbindBufferFuncPtr

public static ktxVulkanTexture_subAllocatorBindBufferFuncPtr nbindBufferFuncPtr(long struct)

Unsafe version of bindBufferFuncPtr().

nbindImageFuncPtr

public static ktxVulkanTexture_subAllocatorBindImageFuncPtr nbindImageFuncPtr(long struct)

Unsafe version of bindImageFuncPtr().

nmemoryMapFuncPtr

public static ktxVulkanTexture_subAllocatorMemoryMapFuncPtr nmemoryMapFuncPtr(long struct)

Unsafe version of memoryMapFuncPtr().

nmemoryUnmapFuncPtr

public static ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtr nmemoryUnmapFuncPtr(long struct)

Unsafe version of memoryUnmapFuncPtr().

nfreeMemFuncPtr

public static ktxVulkanTexture_subAllocatorFreeMemFuncPtr nfreeMemFuncPtr(long struct)

Unsafe version of freeMemFuncPtr().

nallocMemFuncPtr

public static void nallocMemFuncPtr(long struct,
 ktxVulkanTexture_subAllocatorAllocMemFuncPtrI value)

Unsafe version of allocMemFuncPtr.

nbindBufferFuncPtr

public static void nbindBufferFuncPtr(long struct,
 ktxVulkanTexture_subAllocatorBindBufferFuncPtrI value)

Unsafe version of bindBufferFuncPtr.

nbindImageFuncPtr

public static void nbindImageFuncPtr(long struct,
 ktxVulkanTexture_subAllocatorBindImageFuncPtrI value)

Unsafe version of bindImageFuncPtr.

nmemoryMapFuncPtr

public static void nmemoryMapFuncPtr(long struct,
 ktxVulkanTexture_subAllocatorMemoryMapFuncPtrI value)

Unsafe version of memoryMapFuncPtr.

nmemoryUnmapFuncPtr

public static void nmemoryUnmapFuncPtr(long struct,
 ktxVulkanTexture_subAllocatorMemoryUnmapFuncPtrI value)

Unsafe version of memoryUnmapFuncPtr.

nfreeMemFuncPtr

public static void nfreeMemFuncPtr(long struct,
 ktxVulkanTexture_subAllocatorFreeMemFuncPtrI value)

Unsafe version of freeMemFuncPtr.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate