org.lwjgl.vulkan.VkCommandBufferAllocateInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.vulkan;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying the allocation parameters for command buffer object.
*
* Valid Usage
*
*
* - {@code commandBufferCount} must be greater than 0
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link VK10#VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO}
* - {@code pNext} must be {@code NULL}
* - {@code commandPool} must be a valid {@code VkCommandPool} handle
* - {@code level} must be a valid {@code VkCommandBufferLevel} value
*
*
* See Also
*
* {@link VK10#vkAllocateCommandBuffers AllocateCommandBuffers}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code commandPool} – the name of the command pool that the command buffers allocate their memory from.
* - {@code level} – determines whether the command buffers are primary or secondary command buffers. Possible values include:
*
*
typedef enum VkCommandBufferLevel {
VK_COMMAND_BUFFER_LEVEL_PRIMARY = 0,
VK_COMMAND_BUFFER_LEVEL_SECONDARY = 1,
} VkCommandBufferLevel;
* - {@code commandBufferCount} – the number of command buffers to allocate from the pool.
*
*
* Layout
*
* struct VkCommandBufferAllocateInfo {
VkStructureType sType;
const void * pNext;
VkCommandPool commandPool;
VkCommandBufferLevel level;
uint32_t commandBufferCount;
}
*/
public class VkCommandBufferAllocateInfo extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
STYPE,
PNEXT,
COMMANDPOOL,
LEVEL,
COMMANDBUFFERCOUNT;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(8),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
STYPE = layout.offsetof(0);
PNEXT = layout.offsetof(1);
COMMANDPOOL = layout.offsetof(2);
LEVEL = layout.offsetof(3);
COMMANDBUFFERCOUNT = layout.offsetof(4);
}
VkCommandBufferAllocateInfo(long address, ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link VkCommandBufferAllocateInfo} 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 VkCommandBufferAllocateInfo(ByteBuffer container) {
this(memAddress(container), checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code sType} field. */
public int sType() { return nsType(address()); }
/** Returns the value of the {@code pNext} field. */
public long pNext() { return npNext(address()); }
/** Returns the value of the {@code commandPool} field. */
public long commandPool() { return ncommandPool(address()); }
/** Returns the value of the {@code level} field. */
public int level() { return nlevel(address()); }
/** Returns the value of the {@code commandBufferCount} field. */
public int commandBufferCount() { return ncommandBufferCount(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkCommandBufferAllocateInfo sType(int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkCommandBufferAllocateInfo pNext(long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code commandPool} field. */
public VkCommandBufferAllocateInfo commandPool(long value) { ncommandPool(address(), value); return this; }
/** Sets the specified value to the {@code level} field. */
public VkCommandBufferAllocateInfo level(int value) { nlevel(address(), value); return this; }
/** Sets the specified value to the {@code commandBufferCount} field. */
public VkCommandBufferAllocateInfo commandBufferCount(int value) { ncommandBufferCount(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkCommandBufferAllocateInfo set(
int sType,
long pNext,
long commandPool,
int level,
int commandBufferCount
) {
sType(sType);
pNext(pNext);
commandPool(commandPool);
level(level);
commandBufferCount(commandBufferCount);
return this;
}
/** Unsafe version of {@link #set(VkCommandBufferAllocateInfo) set}. */
public VkCommandBufferAllocateInfo nset(long struct) {
memCopy(struct, address(), SIZEOF);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkCommandBufferAllocateInfo set(VkCommandBufferAllocateInfo src) {
return nset(src.address());
}
// -----------------------------------
/** Returns a new {@link VkCommandBufferAllocateInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkCommandBufferAllocateInfo malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkCommandBufferAllocateInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkCommandBufferAllocateInfo calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkCommandBufferAllocateInfo} instance allocated with {@link BufferUtils}. */
public static VkCommandBufferAllocateInfo create() {
return new VkCommandBufferAllocateInfo(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkCommandBufferAllocateInfo} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkCommandBufferAllocateInfo create(long address) {
return address == NULL ? null : new VkCommandBufferAllocateInfo(address, null);
}
/**
* Returns a new {@link VkCommandBufferAllocateInfo.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer malloc(int capacity) {
return create(nmemAlloc(capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkCommandBufferAllocateInfo.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer calloc(int capacity) {
return create(nmemCalloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkCommandBufferAllocateInfo.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static Buffer create(int capacity) {
return new Buffer(BufferUtils.createByteBuffer(capacity * SIZEOF));
}
/**
* Create a {@link VkCommandBufferAllocateInfo.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static Buffer create(long address, int capacity) {
return address == NULL ? null : new Buffer(address, null, -1, 0, capacity, capacity);
}
// -----------------------------------
/** Returns a new {@link VkCommandBufferAllocateInfo} instance allocated on the thread-local {@link MemoryStack}. */
public static VkCommandBufferAllocateInfo mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkCommandBufferAllocateInfo} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkCommandBufferAllocateInfo callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkCommandBufferAllocateInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkCommandBufferAllocateInfo mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkCommandBufferAllocateInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkCommandBufferAllocateInfo callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkCommandBufferAllocateInfo.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkCommandBufferAllocateInfo.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkCommandBufferAllocateInfo.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkCommandBufferAllocateInfo.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 Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #sType}. */
public static int nsType(long struct) { return memGetInt(struct + VkCommandBufferAllocateInfo.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkCommandBufferAllocateInfo.PNEXT); }
/** Unsafe version of {@link #commandPool}. */
public static long ncommandPool(long struct) { return memGetLong(struct + VkCommandBufferAllocateInfo.COMMANDPOOL); }
/** Unsafe version of {@link #level}. */
public static int nlevel(long struct) { return memGetInt(struct + VkCommandBufferAllocateInfo.LEVEL); }
/** Unsafe version of {@link #commandBufferCount}. */
public static int ncommandBufferCount(long struct) { return memGetInt(struct + VkCommandBufferAllocateInfo.COMMANDBUFFERCOUNT); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkCommandBufferAllocateInfo.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkCommandBufferAllocateInfo.PNEXT, value); }
/** Unsafe version of {@link #commandPool(long) commandPool}. */
public static void ncommandPool(long struct, long value) { memPutLong(struct + VkCommandBufferAllocateInfo.COMMANDPOOL, value); }
/** Unsafe version of {@link #level(int) level}. */
public static void nlevel(long struct, int value) { memPutInt(struct + VkCommandBufferAllocateInfo.LEVEL, value); }
/** Unsafe version of {@link #commandBufferCount(int) commandBufferCount}. */
public static void ncommandBufferCount(long struct, int value) { memPutInt(struct + VkCommandBufferAllocateInfo.COMMANDBUFFERCOUNT, value); }
// -----------------------------------
/** An array of {@link VkCommandBufferAllocateInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkCommandBufferAllocateInfo.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 VkCommandBufferAllocateInfo#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);
}
Buffer(long address, 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, ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkCommandBufferAllocateInfo newInstance(long address) {
return new VkCommandBufferAllocateInfo(address, container);
}
@Override
protected int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
public int sType() { return VkCommandBufferAllocateInfo.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
public long pNext() { return VkCommandBufferAllocateInfo.npNext(address()); }
/** Returns the value of the {@code commandPool} field. */
public long commandPool() { return VkCommandBufferAllocateInfo.ncommandPool(address()); }
/** Returns the value of the {@code level} field. */
public int level() { return VkCommandBufferAllocateInfo.nlevel(address()); }
/** Returns the value of the {@code commandBufferCount} field. */
public int commandBufferCount() { return VkCommandBufferAllocateInfo.ncommandBufferCount(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkCommandBufferAllocateInfo.Buffer sType(int value) { VkCommandBufferAllocateInfo.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkCommandBufferAllocateInfo.Buffer pNext(long value) { VkCommandBufferAllocateInfo.npNext(address(), value); return this; }
/** Sets the specified value to the {@code commandPool} field. */
public VkCommandBufferAllocateInfo.Buffer commandPool(long value) { VkCommandBufferAllocateInfo.ncommandPool(address(), value); return this; }
/** Sets the specified value to the {@code level} field. */
public VkCommandBufferAllocateInfo.Buffer level(int value) { VkCommandBufferAllocateInfo.nlevel(address(), value); return this; }
/** Sets the specified value to the {@code commandBufferCount} field. */
public VkCommandBufferAllocateInfo.Buffer commandBufferCount(int value) { VkCommandBufferAllocateInfo.ncommandBufferCount(address(), value); return this; }
}
}