org.lwjgl.util.vma.VmaDeviceMemoryCallbacks Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vma Show documentation
Show all versions of lwjgl-vma Show documentation
An easy to integrate Vulkan memory allocation library.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.util.vma;
import javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Set of callbacks that the library will call for {@code vkAllocateMemory} and {@code vkFreeMemory}.
*
* Provided for informative purpose, e.g. to gather statistics about number of allocations or total amount of memory allocated in Vulkan.
*
* Used in {@link VmaAllocatorCreateInfo}{@code ::pDeviceMemoryCallbacks}.
*
* Layout
*
*
* struct VmaDeviceMemoryCallbacks {
* {@link VmaAllocateDeviceMemoryFunctionI PFN_vmaAllocateDeviceMemoryFunction} pfnAllocate;
* {@link VmaFreeDeviceMemoryFunctionI PFN_vmaFreeDeviceMemoryFunction} pfnFree;
* }
*/
public class VmaDeviceMemoryCallbacks extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
PFNALLOCATE,
PFNFREE;
static {
Layout layout = __struct(
__member(POINTER_SIZE),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
PFNALLOCATE = layout.offsetof(0);
PFNFREE = layout.offsetof(1);
}
VmaDeviceMemoryCallbacks(long address, @Nullable ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link VmaDeviceMemoryCallbacks} instance at the current position of the specified {@link 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.
*/
public VmaDeviceMemoryCallbacks(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code pfnAllocate} field. */
@Nullable
@NativeType("PFN_vmaAllocateDeviceMemoryFunction")
public VmaAllocateDeviceMemoryFunction pfnAllocate() { return npfnAllocate(address()); }
/** Returns the value of the {@code pfnFree} field. */
@Nullable
@NativeType("PFN_vmaFreeDeviceMemoryFunction")
public VmaFreeDeviceMemoryFunction pfnFree() { return npfnFree(address()); }
/** Sets the specified value to the {@code pfnAllocate} field. */
public VmaDeviceMemoryCallbacks pfnAllocate(@Nullable @NativeType("PFN_vmaAllocateDeviceMemoryFunction") VmaAllocateDeviceMemoryFunctionI value) { npfnAllocate(address(), value); return this; }
/** Sets the specified value to the {@code pfnFree} field. */
public VmaDeviceMemoryCallbacks pfnFree(@Nullable @NativeType("PFN_vmaFreeDeviceMemoryFunction") VmaFreeDeviceMemoryFunctionI value) { npfnFree(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VmaDeviceMemoryCallbacks set(
VmaAllocateDeviceMemoryFunctionI pfnAllocate,
VmaFreeDeviceMemoryFunctionI pfnFree
) {
pfnAllocate(pfnAllocate);
pfnFree(pfnFree);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VmaDeviceMemoryCallbacks set(VmaDeviceMemoryCallbacks src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VmaDeviceMemoryCallbacks} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VmaDeviceMemoryCallbacks malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VmaDeviceMemoryCallbacks} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VmaDeviceMemoryCallbacks calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VmaDeviceMemoryCallbacks} instance allocated with {@link BufferUtils}. */
public static VmaDeviceMemoryCallbacks create() {
return new VmaDeviceMemoryCallbacks(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VmaDeviceMemoryCallbacks} instance for the specified memory address. */
public static VmaDeviceMemoryCallbacks create(long address) {
return new VmaDeviceMemoryCallbacks(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VmaDeviceMemoryCallbacks createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VmaDeviceMemoryCallbacks.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VmaDeviceMemoryCallbacks.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VmaDeviceMemoryCallbacks.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VmaDeviceMemoryCallbacks.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VmaDeviceMemoryCallbacks.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VmaDeviceMemoryCallbacks.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VmaDeviceMemoryCallbacks.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VmaDeviceMemoryCallbacks.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VmaDeviceMemoryCallbacks.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VmaDeviceMemoryCallbacks} instance allocated on the thread-local {@link MemoryStack}. */
public static VmaDeviceMemoryCallbacks mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VmaDeviceMemoryCallbacks} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VmaDeviceMemoryCallbacks callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VmaDeviceMemoryCallbacks} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VmaDeviceMemoryCallbacks mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VmaDeviceMemoryCallbacks} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VmaDeviceMemoryCallbacks callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VmaDeviceMemoryCallbacks.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VmaDeviceMemoryCallbacks.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VmaDeviceMemoryCallbacks.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VmaDeviceMemoryCallbacks.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VmaDeviceMemoryCallbacks.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VmaDeviceMemoryCallbacks.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VmaDeviceMemoryCallbacks.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VmaDeviceMemoryCallbacks.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #pfnAllocate}. */
@Nullable public static VmaAllocateDeviceMemoryFunction npfnAllocate(long struct) { return VmaAllocateDeviceMemoryFunction.createSafe(memGetAddress(struct + VmaDeviceMemoryCallbacks.PFNALLOCATE)); }
/** Unsafe version of {@link #pfnFree}. */
@Nullable public static VmaFreeDeviceMemoryFunction npfnFree(long struct) { return VmaFreeDeviceMemoryFunction.createSafe(memGetAddress(struct + VmaDeviceMemoryCallbacks.PFNFREE)); }
/** Unsafe version of {@link #pfnAllocate(VmaAllocateDeviceMemoryFunctionI) pfnAllocate}. */
public static void npfnAllocate(long struct, @Nullable VmaAllocateDeviceMemoryFunctionI value) { memPutAddress(struct + VmaDeviceMemoryCallbacks.PFNALLOCATE, memAddressSafe(value)); }
/** Unsafe version of {@link #pfnFree(VmaFreeDeviceMemoryFunctionI) pfnFree}. */
public static void npfnFree(long struct, @Nullable VmaFreeDeviceMemoryFunctionI value) { memPutAddress(struct + VmaDeviceMemoryCallbacks.PFNFREE, memAddressSafe(value)); }
// -----------------------------------
/** An array of {@link VmaDeviceMemoryCallbacks} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VmaDeviceMemoryCallbacks.Buffer} instance backed by the specified container.
*
* Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values
* will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided
* by {@link VmaDeviceMemoryCallbacks#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VmaDeviceMemoryCallbacks newInstance(long address) {
return new VmaDeviceMemoryCallbacks(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code pfnAllocate} field. */
@Nullable
@NativeType("PFN_vmaAllocateDeviceMemoryFunction")
public VmaAllocateDeviceMemoryFunction pfnAllocate() { return VmaDeviceMemoryCallbacks.npfnAllocate(address()); }
/** Returns the value of the {@code pfnFree} field. */
@Nullable
@NativeType("PFN_vmaFreeDeviceMemoryFunction")
public VmaFreeDeviceMemoryFunction pfnFree() { return VmaDeviceMemoryCallbacks.npfnFree(address()); }
/** Sets the specified value to the {@code pfnAllocate} field. */
public VmaDeviceMemoryCallbacks.Buffer pfnAllocate(@Nullable @NativeType("PFN_vmaAllocateDeviceMemoryFunction") VmaAllocateDeviceMemoryFunctionI value) { VmaDeviceMemoryCallbacks.npfnAllocate(address(), value); return this; }
/** Sets the specified value to the {@code pfnFree} field. */
public VmaDeviceMemoryCallbacks.Buffer pfnFree(@Nullable @NativeType("PFN_vmaFreeDeviceMemoryFunction") VmaFreeDeviceMemoryFunctionI value) { VmaDeviceMemoryCallbacks.npfnFree(address(), value); return this; }
}
}