org.lwjgl.util.vma.VmaVirtualAllocationCreateInfo 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 created virtual allocation to be passed to {@link Vma#vmaVirtualAllocate VirtualAllocate}.
*
* Layout
*
*
* struct VmaVirtualAllocationCreateInfo {
* VkDeviceSize {@link #size};
* VkDeviceSize {@link #alignment};
* VmaVirtualAllocationCreateFlags {@link #flags};
* void * {@link #pUserData};
* }
*/
public class VmaVirtualAllocationCreateInfo 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
SIZE,
ALIGNMENT,
FLAGS,
PUSERDATA;
static {
Layout layout = __struct(
__member(8),
__member(8),
__member(4),
__member(POINTER_SIZE)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
SIZE = layout.offsetof(0);
ALIGNMENT = layout.offsetof(1);
FLAGS = layout.offsetof(2);
PUSERDATA = layout.offsetof(3);
}
/**
* Creates a {@code VmaVirtualAllocationCreateInfo} 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 VmaVirtualAllocationCreateInfo(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/**
* size of the allocation.
*
* Cannot be zero.
*/
@NativeType("VkDeviceSize")
public long size() { return nsize(address()); }
/**
* required alignment of the allocation. Optional.
*
* Must be power of two. Special value 0 has the same meaning as 1 - means no special alignment is required, so allocation can start at any offset.
*/
@NativeType("VkDeviceSize")
public long alignment() { return nalignment(address()); }
/** use combination of {@code VmaVirtualAllocationCreateFlagBits}. One or more of:
{@link Vma#VMA_VIRTUAL_ALLOCATION_CREATE_UPPER_ADDRESS_BIT VIRTUAL_ALLOCATION_CREATE_UPPER_ADDRESS_BIT} {@link Vma#VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_MEMORY_BIT} {@link Vma#VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT VIRTUAL_ALLOCATION_CREATE_STRATEGY_MIN_TIME_BIT} {@link Vma#VMA_VIRTUAL_ALLOCATION_CREATE_STRATEGY_MASK VIRTUAL_ALLOCATION_CREATE_STRATEGY_MASK}
*/
@NativeType("VmaVirtualAllocationCreateFlags")
public int flags() { return nflags(address()); }
/**
* custom pointer to be associated with the allocation. Optional.
*
* It can be any value and can be used for user-defined purposes. It can be fetched or changed later.
*/
@NativeType("void *")
public long pUserData() { return npUserData(address()); }
/** Sets the specified value to the {@link #size} field. */
public VmaVirtualAllocationCreateInfo size(@NativeType("VkDeviceSize") long value) { nsize(address(), value); return this; }
/** Sets the specified value to the {@link #alignment} field. */
public VmaVirtualAllocationCreateInfo alignment(@NativeType("VkDeviceSize") long value) { nalignment(address(), value); return this; }
/** Sets the specified value to the {@link #flags} field. */
public VmaVirtualAllocationCreateInfo flags(@NativeType("VmaVirtualAllocationCreateFlags") int value) { nflags(address(), value); return this; }
/** Sets the specified value to the {@link #pUserData} field. */
public VmaVirtualAllocationCreateInfo pUserData(@NativeType("void *") long value) { npUserData(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VmaVirtualAllocationCreateInfo set(
long size,
long alignment,
int flags,
long pUserData
) {
size(size);
alignment(alignment);
flags(flags);
pUserData(pUserData);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VmaVirtualAllocationCreateInfo set(VmaVirtualAllocationCreateInfo src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VmaVirtualAllocationCreateInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VmaVirtualAllocationCreateInfo malloc() {
return wrap(VmaVirtualAllocationCreateInfo.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VmaVirtualAllocationCreateInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VmaVirtualAllocationCreateInfo calloc() {
return wrap(VmaVirtualAllocationCreateInfo.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VmaVirtualAllocationCreateInfo} instance allocated with {@link BufferUtils}. */
public static VmaVirtualAllocationCreateInfo create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VmaVirtualAllocationCreateInfo.class, memAddress(container), container);
}
/** Returns a new {@code VmaVirtualAllocationCreateInfo} instance for the specified memory address. */
public static VmaVirtualAllocationCreateInfo create(long address) {
return wrap(VmaVirtualAllocationCreateInfo.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VmaVirtualAllocationCreateInfo createSafe(long address) {
return address == NULL ? null : wrap(VmaVirtualAllocationCreateInfo.class, address);
}
/**
* Returns a new {@link VmaVirtualAllocationCreateInfo.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VmaVirtualAllocationCreateInfo.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VmaVirtualAllocationCreateInfo.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VmaVirtualAllocationCreateInfo.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VmaVirtualAllocationCreateInfo.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VmaVirtualAllocationCreateInfo.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VmaVirtualAllocationCreateInfo.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VmaVirtualAllocationCreateInfo.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 VmaVirtualAllocationCreateInfo.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
/**
* Returns a new {@code VmaVirtualAllocationCreateInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VmaVirtualAllocationCreateInfo malloc(MemoryStack stack) {
return wrap(VmaVirtualAllocationCreateInfo.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VmaVirtualAllocationCreateInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VmaVirtualAllocationCreateInfo calloc(MemoryStack stack) {
return wrap(VmaVirtualAllocationCreateInfo.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VmaVirtualAllocationCreateInfo.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VmaVirtualAllocationCreateInfo.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VmaVirtualAllocationCreateInfo.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 VmaVirtualAllocationCreateInfo.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #size}. */
public static long nsize(long struct) { return UNSAFE.getLong(null, struct + VmaVirtualAllocationCreateInfo.SIZE); }
/** Unsafe version of {@link #alignment}. */
public static long nalignment(long struct) { return UNSAFE.getLong(null, struct + VmaVirtualAllocationCreateInfo.ALIGNMENT); }
/** Unsafe version of {@link #flags}. */
public static int nflags(long struct) { return UNSAFE.getInt(null, struct + VmaVirtualAllocationCreateInfo.FLAGS); }
/** Unsafe version of {@link #pUserData}. */
public static long npUserData(long struct) { return memGetAddress(struct + VmaVirtualAllocationCreateInfo.PUSERDATA); }
/** Unsafe version of {@link #size(long) size}. */
public static void nsize(long struct, long value) { UNSAFE.putLong(null, struct + VmaVirtualAllocationCreateInfo.SIZE, value); }
/** Unsafe version of {@link #alignment(long) alignment}. */
public static void nalignment(long struct, long value) { UNSAFE.putLong(null, struct + VmaVirtualAllocationCreateInfo.ALIGNMENT, value); }
/** Unsafe version of {@link #flags(int) flags}. */
public static void nflags(long struct, int value) { UNSAFE.putInt(null, struct + VmaVirtualAllocationCreateInfo.FLAGS, value); }
/** Unsafe version of {@link #pUserData(long) pUserData}. */
public static void npUserData(long struct, long value) { memPutAddress(struct + VmaVirtualAllocationCreateInfo.PUSERDATA, value); }
// -----------------------------------
/** An array of {@link VmaVirtualAllocationCreateInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VmaVirtualAllocationCreateInfo ELEMENT_FACTORY = VmaVirtualAllocationCreateInfo.create(-1L);
/**
* Creates a new {@code VmaVirtualAllocationCreateInfo.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 VmaVirtualAllocationCreateInfo#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 VmaVirtualAllocationCreateInfo getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link VmaVirtualAllocationCreateInfo#size} field. */
@NativeType("VkDeviceSize")
public long size() { return VmaVirtualAllocationCreateInfo.nsize(address()); }
/** @return the value of the {@link VmaVirtualAllocationCreateInfo#alignment} field. */
@NativeType("VkDeviceSize")
public long alignment() { return VmaVirtualAllocationCreateInfo.nalignment(address()); }
/** @return the value of the {@link VmaVirtualAllocationCreateInfo#flags} field. */
@NativeType("VmaVirtualAllocationCreateFlags")
public int flags() { return VmaVirtualAllocationCreateInfo.nflags(address()); }
/** @return the value of the {@link VmaVirtualAllocationCreateInfo#pUserData} field. */
@NativeType("void *")
public long pUserData() { return VmaVirtualAllocationCreateInfo.npUserData(address()); }
/** Sets the specified value to the {@link VmaVirtualAllocationCreateInfo#size} field. */
public VmaVirtualAllocationCreateInfo.Buffer size(@NativeType("VkDeviceSize") long value) { VmaVirtualAllocationCreateInfo.nsize(address(), value); return this; }
/** Sets the specified value to the {@link VmaVirtualAllocationCreateInfo#alignment} field. */
public VmaVirtualAllocationCreateInfo.Buffer alignment(@NativeType("VkDeviceSize") long value) { VmaVirtualAllocationCreateInfo.nalignment(address(), value); return this; }
/** Sets the specified value to the {@link VmaVirtualAllocationCreateInfo#flags} field. */
public VmaVirtualAllocationCreateInfo.Buffer flags(@NativeType("VmaVirtualAllocationCreateFlags") int value) { VmaVirtualAllocationCreateInfo.nflags(address(), value); return this; }
/** Sets the specified value to the {@link VmaVirtualAllocationCreateInfo#pUserData} field. */
public VmaVirtualAllocationCreateInfo.Buffer pUserData(@NativeType("void *") long value) { VmaVirtualAllocationCreateInfo.npUserData(address(), value); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy