org.lwjgl.vulkan.VkDrawIndexedIndirectCommand 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 indexed indirect command.
*
* Description
*
* The members of {@link VkDrawIndexedIndirectCommand} have the same meaning as the similarly named parameters of {@link VK10#vkCmdDrawIndexed CmdDrawIndexed}.
*
* 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
* (indexSize * (firstIndex + indexCount) + offset) must be less than or equal to the size of the currently bound index buffer, with {@code indexSize} being based on the type specified by {@code indexType}, where the index buffer, {@code indexType}, and {@code offset} are specified via {@link VK10#vkCmdBindIndexBuffer CmdBindIndexBuffer}- If the drawIndirectFirstInstance feature is not enabled, {@code firstInstance} must be 0
*
*
* See Also
*
* {@link VK10#vkCmdDrawIndexedIndirect CmdDrawIndexedIndirect}
*
* Member documentation
*
*
* - {@code indexCount} – the number of vertices to draw.
* - {@code instanceCount} – the number of instances to draw.
* - {@code firstIndex} – the base index within the index buffer.
* - {@code vertexOffset} – the value added to the vertex index before indexing into the vertex buffer.
* - {@code firstInstance} – the instance ID of the first instance to draw.
*
*
* Layout
*
*
* struct VkDrawIndexedIndirectCommand {
* uint32_t indexCount;
* uint32_t instanceCount;
* uint32_t firstIndex;
* int32_t vertexOffset;
* uint32_t firstInstance;
* }The created instance holds a strong reference to the container object.
*/
public VkDrawIndexedIndirectCommand(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code indexCount} field. */
@NativeType("uint32_t")
public int indexCount() { return nindexCount(address()); }
/** Returns the value of the {@code instanceCount} field. */
@NativeType("uint32_t")
public int instanceCount() { return ninstanceCount(address()); }
/** Returns the value of the {@code firstIndex} field. */
@NativeType("uint32_t")
public int firstIndex() { return nfirstIndex(address()); }
/** Returns the value of the {@code vertexOffset} field. */
@NativeType("int32_t")
public int vertexOffset() { return nvertexOffset(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 indexCount} field. */
public VkDrawIndexedIndirectCommand indexCount(@NativeType("uint32_t") int value) { nindexCount(address(), value); return this; }
/** Sets the specified value to the {@code instanceCount} field. */
public VkDrawIndexedIndirectCommand instanceCount(@NativeType("uint32_t") int value) { ninstanceCount(address(), value); return this; }
/** Sets the specified value to the {@code firstIndex} field. */
public VkDrawIndexedIndirectCommand firstIndex(@NativeType("uint32_t") int value) { nfirstIndex(address(), value); return this; }
/** Sets the specified value to the {@code vertexOffset} field. */
public VkDrawIndexedIndirectCommand vertexOffset(@NativeType("int32_t") int value) { nvertexOffset(address(), value); return this; }
/** Sets the specified value to the {@code firstInstance} field. */
public VkDrawIndexedIndirectCommand firstInstance(@NativeType("uint32_t") int value) { nfirstInstance(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkDrawIndexedIndirectCommand set(
int indexCount,
int instanceCount,
int firstIndex,
int vertexOffset,
int firstInstance
) {
indexCount(indexCount);
instanceCount(instanceCount);
firstIndex(firstIndex);
vertexOffset(vertexOffset);
firstInstance(firstInstance);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkDrawIndexedIndirectCommand set(VkDrawIndexedIndirectCommand src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkDrawIndexedIndirectCommand} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkDrawIndexedIndirectCommand malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkDrawIndexedIndirectCommand} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkDrawIndexedIndirectCommand calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkDrawIndexedIndirectCommand} instance allocated with {@link BufferUtils}. */
public static VkDrawIndexedIndirectCommand create() {
return new VkDrawIndexedIndirectCommand(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkDrawIndexedIndirectCommand} instance for the specified memory address. */
public static VkDrawIndexedIndirectCommand create(long address) {
return new VkDrawIndexedIndirectCommand(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkDrawIndexedIndirectCommand createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkDrawIndexedIndirectCommand.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkDrawIndexedIndirectCommand.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkDrawIndexedIndirectCommand.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkDrawIndexedIndirectCommand.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkDrawIndexedIndirectCommand.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkDrawIndexedIndirectCommand.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkDrawIndexedIndirectCommand.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkDrawIndexedIndirectCommand.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 VkDrawIndexedIndirectCommand.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkDrawIndexedIndirectCommand} instance allocated on the thread-local {@link MemoryStack}. */
public static VkDrawIndexedIndirectCommand mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkDrawIndexedIndirectCommand} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkDrawIndexedIndirectCommand callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkDrawIndexedIndirectCommand} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkDrawIndexedIndirectCommand mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkDrawIndexedIndirectCommand} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkDrawIndexedIndirectCommand callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkDrawIndexedIndirectCommand.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkDrawIndexedIndirectCommand.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkDrawIndexedIndirectCommand.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkDrawIndexedIndirectCommand.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkDrawIndexedIndirectCommand.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkDrawIndexedIndirectCommand.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkDrawIndexedIndirectCommand.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 VkDrawIndexedIndirectCommand.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #indexCount}. */
public static int nindexCount(long struct) { return memGetInt(struct + VkDrawIndexedIndirectCommand.INDEXCOUNT); }
/** Unsafe version of {@link #instanceCount}. */
public static int ninstanceCount(long struct) { return memGetInt(struct + VkDrawIndexedIndirectCommand.INSTANCECOUNT); }
/** Unsafe version of {@link #firstIndex}. */
public static int nfirstIndex(long struct) { return memGetInt(struct + VkDrawIndexedIndirectCommand.FIRSTINDEX); }
/** Unsafe version of {@link #vertexOffset}. */
public static int nvertexOffset(long struct) { return memGetInt(struct + VkDrawIndexedIndirectCommand.VERTEXOFFSET); }
/** Unsafe version of {@link #firstInstance}. */
public static int nfirstInstance(long struct) { return memGetInt(struct + VkDrawIndexedIndirectCommand.FIRSTINSTANCE); }
/** Unsafe version of {@link #indexCount(int) indexCount}. */
public static void nindexCount(long struct, int value) { memPutInt(struct + VkDrawIndexedIndirectCommand.INDEXCOUNT, value); }
/** Unsafe version of {@link #instanceCount(int) instanceCount}. */
public static void ninstanceCount(long struct, int value) { memPutInt(struct + VkDrawIndexedIndirectCommand.INSTANCECOUNT, value); }
/** Unsafe version of {@link #firstIndex(int) firstIndex}. */
public static void nfirstIndex(long struct, int value) { memPutInt(struct + VkDrawIndexedIndirectCommand.FIRSTINDEX, value); }
/** Unsafe version of {@link #vertexOffset(int) vertexOffset}. */
public static void nvertexOffset(long struct, int value) { memPutInt(struct + VkDrawIndexedIndirectCommand.VERTEXOFFSET, value); }
/** Unsafe version of {@link #firstInstance(int) firstInstance}. */
public static void nfirstInstance(long struct, int value) { memPutInt(struct + VkDrawIndexedIndirectCommand.FIRSTINSTANCE, value); }
// -----------------------------------
/** An array of {@link VkDrawIndexedIndirectCommand} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkDrawIndexedIndirectCommand.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 VkDrawIndexedIndirectCommand#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 VkDrawIndexedIndirectCommand newInstance(long address) {
return new VkDrawIndexedIndirectCommand(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code indexCount} field. */
@NativeType("uint32_t")
public int indexCount() { return VkDrawIndexedIndirectCommand.nindexCount(address()); }
/** Returns the value of the {@code instanceCount} field. */
@NativeType("uint32_t")
public int instanceCount() { return VkDrawIndexedIndirectCommand.ninstanceCount(address()); }
/** Returns the value of the {@code firstIndex} field. */
@NativeType("uint32_t")
public int firstIndex() { return VkDrawIndexedIndirectCommand.nfirstIndex(address()); }
/** Returns the value of the {@code vertexOffset} field. */
@NativeType("int32_t")
public int vertexOffset() { return VkDrawIndexedIndirectCommand.nvertexOffset(address()); }
/** Returns the value of the {@code firstInstance} field. */
@NativeType("uint32_t")
public int firstInstance() { return VkDrawIndexedIndirectCommand.nfirstInstance(address()); }
/** Sets the specified value to the {@code indexCount} field. */
public VkDrawIndexedIndirectCommand.Buffer indexCount(@NativeType("uint32_t") int value) { VkDrawIndexedIndirectCommand.nindexCount(address(), value); return this; }
/** Sets the specified value to the {@code instanceCount} field. */
public VkDrawIndexedIndirectCommand.Buffer instanceCount(@NativeType("uint32_t") int value) { VkDrawIndexedIndirectCommand.ninstanceCount(address(), value); return this; }
/** Sets the specified value to the {@code firstIndex} field. */
public VkDrawIndexedIndirectCommand.Buffer firstIndex(@NativeType("uint32_t") int value) { VkDrawIndexedIndirectCommand.nfirstIndex(address(), value); return this; }
/** Sets the specified value to the {@code vertexOffset} field. */
public VkDrawIndexedIndirectCommand.Buffer vertexOffset(@NativeType("int32_t") int value) { VkDrawIndexedIndirectCommand.nvertexOffset(address(), value); return this; }
/** Sets the specified value to the {@code firstInstance} field. */
public VkDrawIndexedIndirectCommand.Buffer firstInstance(@NativeType("uint32_t") int value) { VkDrawIndexedIndirectCommand.nfirstInstance(address(), value); return this; }
}
}