org.lwjgl.util.vma.VmaDefragmentationInfo 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.*;
/**
* Member documentation
*
*
* - {@code maxBytesToMove} –
* maximum total numbers of bytes that can be copied while moving allocations to different places.
*
*
Default is {@code VK_WHOLE_SIZ}E, which means no limit.
* - {@code maxAllocationsToMove} –
* maximum number of allocations that can be moved to different place.
*
*
Default is {@code UINT32_MAX}, which means no limit.
*
*
* Layout
*
*
* struct VmaDefragmentationInfo {
* VkDeviceSize maxBytesToMove;
* uint32_t maxAllocationsToMove;
* }
*/
public class VmaDefragmentationInfo 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
MAXBYTESTOMOVE,
MAXALLOCATIONSTOMOVE;
static {
Layout layout = __struct(
__member(8),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
MAXBYTESTOMOVE = layout.offsetof(0);
MAXALLOCATIONSTOMOVE = layout.offsetof(1);
}
VmaDefragmentationInfo(long address, @Nullable ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link VmaDefragmentationInfo} 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 VmaDefragmentationInfo(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code maxBytesToMove} field. */
@NativeType("VkDeviceSize")
public long maxBytesToMove() { return nmaxBytesToMove(address()); }
/** Returns the value of the {@code maxAllocationsToMove} field. */
@NativeType("uint32_t")
public int maxAllocationsToMove() { return nmaxAllocationsToMove(address()); }
/** Sets the specified value to the {@code maxBytesToMove} field. */
public VmaDefragmentationInfo maxBytesToMove(@NativeType("VkDeviceSize") long value) { nmaxBytesToMove(address(), value); return this; }
/** Sets the specified value to the {@code maxAllocationsToMove} field. */
public VmaDefragmentationInfo maxAllocationsToMove(@NativeType("uint32_t") int value) { nmaxAllocationsToMove(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VmaDefragmentationInfo set(
long maxBytesToMove,
int maxAllocationsToMove
) {
maxBytesToMove(maxBytesToMove);
maxAllocationsToMove(maxAllocationsToMove);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VmaDefragmentationInfo set(VmaDefragmentationInfo src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VmaDefragmentationInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VmaDefragmentationInfo malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VmaDefragmentationInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VmaDefragmentationInfo calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VmaDefragmentationInfo} instance allocated with {@link BufferUtils}. */
public static VmaDefragmentationInfo create() {
return new VmaDefragmentationInfo(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VmaDefragmentationInfo} instance for the specified memory address. */
public static VmaDefragmentationInfo create(long address) {
return new VmaDefragmentationInfo(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VmaDefragmentationInfo createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VmaDefragmentationInfo.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VmaDefragmentationInfo.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VmaDefragmentationInfo.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VmaDefragmentationInfo.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VmaDefragmentationInfo.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VmaDefragmentationInfo.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VmaDefragmentationInfo.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VmaDefragmentationInfo.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 VmaDefragmentationInfo.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VmaDefragmentationInfo} instance allocated on the thread-local {@link MemoryStack}. */
public static VmaDefragmentationInfo mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VmaDefragmentationInfo} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VmaDefragmentationInfo callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VmaDefragmentationInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VmaDefragmentationInfo mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VmaDefragmentationInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VmaDefragmentationInfo callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VmaDefragmentationInfo.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VmaDefragmentationInfo.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VmaDefragmentationInfo.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VmaDefragmentationInfo.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VmaDefragmentationInfo.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VmaDefragmentationInfo.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VmaDefragmentationInfo.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 VmaDefragmentationInfo.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #maxBytesToMove}. */
public static long nmaxBytesToMove(long struct) { return memGetLong(struct + VmaDefragmentationInfo.MAXBYTESTOMOVE); }
/** Unsafe version of {@link #maxAllocationsToMove}. */
public static int nmaxAllocationsToMove(long struct) { return memGetInt(struct + VmaDefragmentationInfo.MAXALLOCATIONSTOMOVE); }
/** Unsafe version of {@link #maxBytesToMove(long) maxBytesToMove}. */
public static void nmaxBytesToMove(long struct, long value) { memPutLong(struct + VmaDefragmentationInfo.MAXBYTESTOMOVE, value); }
/** Unsafe version of {@link #maxAllocationsToMove(int) maxAllocationsToMove}. */
public static void nmaxAllocationsToMove(long struct, int value) { memPutInt(struct + VmaDefragmentationInfo.MAXALLOCATIONSTOMOVE, value); }
// -----------------------------------
/** An array of {@link VmaDefragmentationInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VmaDefragmentationInfo.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 VmaDefragmentationInfo#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 VmaDefragmentationInfo newInstance(long address) {
return new VmaDefragmentationInfo(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code maxBytesToMove} field. */
@NativeType("VkDeviceSize")
public long maxBytesToMove() { return VmaDefragmentationInfo.nmaxBytesToMove(address()); }
/** Returns the value of the {@code maxAllocationsToMove} field. */
@NativeType("uint32_t")
public int maxAllocationsToMove() { return VmaDefragmentationInfo.nmaxAllocationsToMove(address()); }
/** Sets the specified value to the {@code maxBytesToMove} field. */
public VmaDefragmentationInfo.Buffer maxBytesToMove(@NativeType("VkDeviceSize") long value) { VmaDefragmentationInfo.nmaxBytesToMove(address(), value); return this; }
/** Sets the specified value to the {@code maxAllocationsToMove} field. */
public VmaDefragmentationInfo.Buffer maxAllocationsToMove(@NativeType("uint32_t") int value) { VmaDefragmentationInfo.nmaxAllocationsToMove(address(), value); return this; }
}
}