org.lwjgl.vulkan.VkDrawIndirectCommand 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 javax.annotation.*;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying a draw indirect command.
*
* Description
*
* The members of {@link VkDrawIndirectCommand} have the same meaning as the similarly named parameters of {@link VK10#vkCmdDraw CmdDraw}.
*
* Valid Usage
*
*
* - For a given vertex buffer binding, any attribute data fetched must be entirely contained within the corresponding vertex buffer binding, as described in the “Vertex Input Description” section
* - If the drawIndirectFirstInstance feature is not enabled, {@code firstInstance} must be 0
*
*
* See Also
*
* {@link VK10#vkCmdDrawIndirect CmdDrawIndirect}
*
* Member documentation
*
*
* - {@code vertexCount} – the number of vertices to draw.
* - {@code instanceCount} – the number of instances to draw.
* - {@code firstVertex} – the index of the first vertex to draw.
* - {@code firstInstance} – the instance ID of the first instance to draw.
*
*
* Layout
*
*
* struct VkDrawIndirectCommand {
* uint32_t vertexCount;
* uint32_t instanceCount;
* uint32_t firstVertex;
* uint32_t firstInstance;
* }The created instance holds a strong reference to the container object.
*/
public VkDrawIndirectCommand(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code vertexCount} field. */
@NativeType("uint32_t")
public int vertexCount() { return nvertexCount(address()); }
/** Returns the value of the {@code instanceCount} field. */
@NativeType("uint32_t")
public int instanceCount() { return ninstanceCount(address()); }
/** Returns the value of the {@code firstVertex} field. */
@NativeType("uint32_t")
public int firstVertex() { return nfirstVertex(address()); }
/** Returns the value of the {@code firstInstance} field. */
@NativeType("uint32_t")
public int firstInstance() { return nfirstInstance(address()); }
/** Sets the specified value to the {@code vertexCount} field. */
public VkDrawIndirectCommand vertexCount(@NativeType("uint32_t") int value) { nvertexCount(address(), value); return this; }
/** Sets the specified value to the {@code instanceCount} field. */
public VkDrawIndirectCommand instanceCount(@NativeType("uint32_t") int value) { ninstanceCount(address(), value); return this; }
/** Sets the specified value to the {@code firstVertex} field. */
public VkDrawIndirectCommand firstVertex(@NativeType("uint32_t") int value) { nfirstVertex(address(), value); return this; }
/** Sets the specified value to the {@code firstInstance} field. */
public VkDrawIndirectCommand firstInstance(@NativeType("uint32_t") int value) { nfirstInstance(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkDrawIndirectCommand set(
int vertexCount,
int instanceCount,
int firstVertex,
int firstInstance
) {
vertexCount(vertexCount);
instanceCount(instanceCount);
firstVertex(firstVertex);
firstInstance(firstInstance);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkDrawIndirectCommand set(VkDrawIndirectCommand src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkDrawIndirectCommand} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkDrawIndirectCommand malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkDrawIndirectCommand} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkDrawIndirectCommand calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkDrawIndirectCommand} instance allocated with {@link BufferUtils}. */
public static VkDrawIndirectCommand create() {
return new VkDrawIndirectCommand(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkDrawIndirectCommand} instance for the specified memory address. */
public static VkDrawIndirectCommand create(long address) {
return new VkDrawIndirectCommand(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkDrawIndirectCommand createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkDrawIndirectCommand.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkDrawIndirectCommand.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkDrawIndirectCommand.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkDrawIndirectCommand.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkDrawIndirectCommand.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkDrawIndirectCommand.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkDrawIndirectCommand.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkDrawIndirectCommand.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 VkDrawIndirectCommand.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkDrawIndirectCommand} instance allocated on the thread-local {@link MemoryStack}. */
public static VkDrawIndirectCommand mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkDrawIndirectCommand} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkDrawIndirectCommand callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkDrawIndirectCommand} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkDrawIndirectCommand mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkDrawIndirectCommand} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkDrawIndirectCommand callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkDrawIndirectCommand.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkDrawIndirectCommand.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkDrawIndirectCommand.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkDrawIndirectCommand.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkDrawIndirectCommand.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkDrawIndirectCommand.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkDrawIndirectCommand.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 VkDrawIndirectCommand.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #vertexCount}. */
public static int nvertexCount(long struct) { return memGetInt(struct + VkDrawIndirectCommand.VERTEXCOUNT); }
/** Unsafe version of {@link #instanceCount}. */
public static int ninstanceCount(long struct) { return memGetInt(struct + VkDrawIndirectCommand.INSTANCECOUNT); }
/** Unsafe version of {@link #firstVertex}. */
public static int nfirstVertex(long struct) { return memGetInt(struct + VkDrawIndirectCommand.FIRSTVERTEX); }
/** Unsafe version of {@link #firstInstance}. */
public static int nfirstInstance(long struct) { return memGetInt(struct + VkDrawIndirectCommand.FIRSTINSTANCE); }
/** Unsafe version of {@link #vertexCount(int) vertexCount}. */
public static void nvertexCount(long struct, int value) { memPutInt(struct + VkDrawIndirectCommand.VERTEXCOUNT, value); }
/** Unsafe version of {@link #instanceCount(int) instanceCount}. */
public static void ninstanceCount(long struct, int value) { memPutInt(struct + VkDrawIndirectCommand.INSTANCECOUNT, value); }
/** Unsafe version of {@link #firstVertex(int) firstVertex}. */
public static void nfirstVertex(long struct, int value) { memPutInt(struct + VkDrawIndirectCommand.FIRSTVERTEX, value); }
/** Unsafe version of {@link #firstInstance(int) firstInstance}. */
public static void nfirstInstance(long struct, int value) { memPutInt(struct + VkDrawIndirectCommand.FIRSTINSTANCE, value); }
// -----------------------------------
/** An array of {@link VkDrawIndirectCommand} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkDrawIndirectCommand.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 VkDrawIndirectCommand#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 VkDrawIndirectCommand newInstance(long address) {
return new VkDrawIndirectCommand(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code vertexCount} field. */
@NativeType("uint32_t")
public int vertexCount() { return VkDrawIndirectCommand.nvertexCount(address()); }
/** Returns the value of the {@code instanceCount} field. */
@NativeType("uint32_t")
public int instanceCount() { return VkDrawIndirectCommand.ninstanceCount(address()); }
/** Returns the value of the {@code firstVertex} field. */
@NativeType("uint32_t")
public int firstVertex() { return VkDrawIndirectCommand.nfirstVertex(address()); }
/** Returns the value of the {@code firstInstance} field. */
@NativeType("uint32_t")
public int firstInstance() { return VkDrawIndirectCommand.nfirstInstance(address()); }
/** Sets the specified value to the {@code vertexCount} field. */
public VkDrawIndirectCommand.Buffer vertexCount(@NativeType("uint32_t") int value) { VkDrawIndirectCommand.nvertexCount(address(), value); return this; }
/** Sets the specified value to the {@code instanceCount} field. */
public VkDrawIndirectCommand.Buffer instanceCount(@NativeType("uint32_t") int value) { VkDrawIndirectCommand.ninstanceCount(address(), value); return this; }
/** Sets the specified value to the {@code firstVertex} field. */
public VkDrawIndirectCommand.Buffer firstVertex(@NativeType("uint32_t") int value) { VkDrawIndirectCommand.nfirstVertex(address(), value); return this; }
/** Sets the specified value to the {@code firstInstance} field. */
public VkDrawIndirectCommand.Buffer firstInstance(@NativeType("uint32_t") int value) { VkDrawIndirectCommand.nfirstInstance(address(), value); return this; }
}
}