org.lwjgl.util.vma.VmaAllocationInfo 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.*;
/**
* Parameters of {@code VmaAllocation} objects, that can be retrieved using function {@link Vma#vmaGetAllocationInfo GetAllocationInfo}.
*
* Member documentation
*
*
* - {@code memoryType} –
* memory type index that this allocation was allocated from.
*
*
It never changes.
* - {@code deviceMemory} –
* handle to Vulkan memory object.
*
*
Same memory object can be shared by multiple allocations.
*
* It can change after call to {@link Vma#vmaDefragment Defragment} if this allocation is passed to the function, or if allocation is lost.
*
* If the allocation is lost, it is equal to {@code VK_NULL_HANDLE}.
* - {@code offset} –
* offset into {@code deviceMemory} object to the beginning of this allocation, in bytes. ({@code deviceMemory}, {@code offset}) pair is unique to this
* allocation.
*
*
It can change after call to {@link Vma#vmaDefragment Defragment} if this allocation is passed to the function, or if allocation is lost.
* - {@code size} –
* size of this allocation, in bytes.
*
*
It never changes, unless allocation is lost.
* - {@code pMappedData} –
* pointer to the beginning of this allocation as mapped data.
*
*
If the allocation hasn't been mapped using {@link Vma#vmaMapMemory MapMemory} and hasn't been created with {@link Vma#VMA_ALLOCATION_CREATE_MAPPED_BIT ALLOCATION_CREATE_MAPPED_BIT} flag, this value null.
*
* It can change after call to {@link Vma#vmaMapMemory MapMemory}, {@link Vma#vmaUnmapMemory UnmapMemory}. It can also change after call to {@link Vma#vmaDefragment Defragment} if this allocation is passed to the function.
* - {@code pUserData} –
* custom general-purpose pointer that was passed as {@link VmaAllocationCreateInfo}{@code ::pUserData} or set using {@link Vma#vmaSetAllocationUserData SetAllocationUserData}.
*
*
It can change after call to {@link Vma#vmaSetAllocationUserData SetAllocationUserData} for this allocation.
*
*
* Layout
*
*
* struct VmaAllocationInfo {
* uint32_t memoryType;
* VkDeviceMemory deviceMemory;
* VkDeviceSize offset;
* VkDeviceSize size;
* void * pMappedData;
* void * pUserData;
* }
*/
public class VmaAllocationInfo 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
MEMORYTYPE,
DEVICEMEMORY,
OFFSET,
SIZE,
PMAPPEDDATA,
PUSERDATA;
static {
Layout layout = __struct(
__member(4),
__member(8),
__member(8),
__member(8),
__member(POINTER_SIZE),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
MEMORYTYPE = layout.offsetof(0);
DEVICEMEMORY = layout.offsetof(1);
OFFSET = layout.offsetof(2);
SIZE = layout.offsetof(3);
PMAPPEDDATA = layout.offsetof(4);
PUSERDATA = layout.offsetof(5);
}
/**
* Creates a {@code VmaAllocationInfo} 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 VmaAllocationInfo(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code memoryType} field. */
@NativeType("uint32_t")
public int memoryType() { return nmemoryType(address()); }
/** Returns the value of the {@code deviceMemory} field. */
@NativeType("VkDeviceMemory")
public long deviceMemory() { return ndeviceMemory(address()); }
/** Returns the value of the {@code offset} field. */
@NativeType("VkDeviceSize")
public long offset() { return noffset(address()); }
/** Returns the value of the {@code size} field. */
@NativeType("VkDeviceSize")
public long size() { return nsize(address()); }
/** Returns the value of the {@code pMappedData} field. */
@NativeType("void *")
public long pMappedData() { return npMappedData(address()); }
/** Returns the value of the {@code pUserData} field. */
@NativeType("void *")
public long pUserData() { return npUserData(address()); }
// -----------------------------------
/** Returns a new {@code VmaAllocationInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VmaAllocationInfo malloc() {
return wrap(VmaAllocationInfo.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VmaAllocationInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VmaAllocationInfo calloc() {
return wrap(VmaAllocationInfo.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VmaAllocationInfo} instance allocated with {@link BufferUtils}. */
public static VmaAllocationInfo create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VmaAllocationInfo.class, memAddress(container), container);
}
/** Returns a new {@code VmaAllocationInfo} instance for the specified memory address. */
public static VmaAllocationInfo create(long address) {
return wrap(VmaAllocationInfo.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VmaAllocationInfo createSafe(long address) {
return address == NULL ? null : wrap(VmaAllocationInfo.class, address);
}
/**
* Returns a new {@link VmaAllocationInfo.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VmaAllocationInfo.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VmaAllocationInfo.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VmaAllocationInfo.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VmaAllocationInfo.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VmaAllocationInfo.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VmaAllocationInfo.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VmaAllocationInfo.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VmaAllocationInfo.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Returns a new {@code VmaAllocationInfo} instance allocated on the thread-local {@link MemoryStack}. */
public static VmaAllocationInfo mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@code VmaAllocationInfo} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VmaAllocationInfo callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@code VmaAllocationInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VmaAllocationInfo mallocStack(MemoryStack stack) {
return wrap(VmaAllocationInfo.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VmaAllocationInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VmaAllocationInfo callocStack(MemoryStack stack) {
return wrap(VmaAllocationInfo.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VmaAllocationInfo.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VmaAllocationInfo.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VmaAllocationInfo.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VmaAllocationInfo.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VmaAllocationInfo.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VmaAllocationInfo.Buffer mallocStack(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VmaAllocationInfo.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 VmaAllocationInfo.Buffer callocStack(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #memoryType}. */
public static int nmemoryType(long struct) { return UNSAFE.getInt(null, struct + VmaAllocationInfo.MEMORYTYPE); }
/** Unsafe version of {@link #deviceMemory}. */
public static long ndeviceMemory(long struct) { return UNSAFE.getLong(null, struct + VmaAllocationInfo.DEVICEMEMORY); }
/** Unsafe version of {@link #offset}. */
public static long noffset(long struct) { return UNSAFE.getLong(null, struct + VmaAllocationInfo.OFFSET); }
/** Unsafe version of {@link #size}. */
public static long nsize(long struct) { return UNSAFE.getLong(null, struct + VmaAllocationInfo.SIZE); }
/** Unsafe version of {@link #pMappedData}. */
public static long npMappedData(long struct) { return memGetAddress(struct + VmaAllocationInfo.PMAPPEDDATA); }
/** Unsafe version of {@link #pUserData}. */
public static long npUserData(long struct) { return memGetAddress(struct + VmaAllocationInfo.PUSERDATA); }
// -----------------------------------
/** An array of {@link VmaAllocationInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VmaAllocationInfo ELEMENT_FACTORY = VmaAllocationInfo.create(-1L);
/**
* Creates a new {@code VmaAllocationInfo.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 VmaAllocationInfo#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 VmaAllocationInfo getElementFactory() {
return ELEMENT_FACTORY;
}
/** Returns the value of the {@code memoryType} field. */
@NativeType("uint32_t")
public int memoryType() { return VmaAllocationInfo.nmemoryType(address()); }
/** Returns the value of the {@code deviceMemory} field. */
@NativeType("VkDeviceMemory")
public long deviceMemory() { return VmaAllocationInfo.ndeviceMemory(address()); }
/** Returns the value of the {@code offset} field. */
@NativeType("VkDeviceSize")
public long offset() { return VmaAllocationInfo.noffset(address()); }
/** Returns the value of the {@code size} field. */
@NativeType("VkDeviceSize")
public long size() { return VmaAllocationInfo.nsize(address()); }
/** Returns the value of the {@code pMappedData} field. */
@NativeType("void *")
public long pMappedData() { return VmaAllocationInfo.npMappedData(address()); }
/** Returns the value of the {@code pUserData} field. */
@NativeType("void *")
public long pUserData() { return VmaAllocationInfo.npUserData(address()); }
}
}