org.lwjgl.vulkan.VkIndirectCommandsLayoutCreateInfoNVX 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.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying the parameters of a newly created indirect commands layout object.
*
* Description
*
* The following code illustrates some of the key flags:
*
*
* void cmdProcessAllSequences(cmd, objectTable, indirectCommandsLayout, pIndirectCommandsTokens, sequencesCount, indexbuffer, indexbufferoffset)
* {
* for (s = 0; s < sequencesCount; s++)
* {
* sequence = s;
*
* if (indirectCommandsLayout.flags & VK_INDIRECT_COMMANDS_LAYOUT_USAGE_UNORDERED_SEQUENCES_BIT_NVX) {
* sequence = incoherent_implementation_dependent_permutation[ sequence ];
* }
* if (indirectCommandsLayout.flags & VK_INDIRECT_COMMANDS_LAYOUT_USAGE_INDEXED_SEQUENCES_BIT_NVX) {
* sequence = indexbuffer.load_uint32( sequence * sizeof(uint32_t) + indexbufferoffset);
* }
*
* cmdProcessSequence( cmd, objectTable, indirectCommandsLayout, pIndirectCommandsTokens, sequence );
* }
* }Valid Usage
*
*
* - {@code tokenCount} must be greater than 0 and below {@link VkDeviceGeneratedCommandsLimitsNVX}{@code ::maxIndirectCommandsLayoutTokenCount}
* - If the {@link VkDeviceGeneratedCommandsFeaturesNVX}{@code ::computeBindingPointSupport} feature is not enabled, then {@code pipelineBindPoint} must not be {@link VK10#VK_PIPELINE_BIND_POINT_COMPUTE PIPELINE_BIND_POINT_COMPUTE}
* - If {@code pTokens} contains an entry of {@link NVXDeviceGeneratedCommands#VK_INDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NVX INDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NVX} it must be the first element of the array and there must be only a single element of such token type.
* - All state binding tokens in {@code pTokens} must occur prior work provoking tokens ({@link NVXDeviceGeneratedCommands#VK_INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_NVX INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_NVX}, {@link NVXDeviceGeneratedCommands#VK_INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_INDEXED_NVX INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_INDEXED_NVX}, {@link NVXDeviceGeneratedCommands#VK_INDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_NVX INDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_NVX}).
* - The content of {@code pTokens} must include one single work provoking token that is compatible with the {@code pipelineBindPoint}.
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link NVXDeviceGeneratedCommands#VK_STRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_NVX STRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_NVX}
* - {@code pNext} must be {@code NULL}
* - {@code pipelineBindPoint} must be a valid {@code VkPipelineBindPoint} value
* - {@code flags} must be a valid combination of {@code VkIndirectCommandsLayoutUsageFlagBitsNVX} values
* - {@code flags} must not be 0
* - {@code pTokens} must be a valid pointer to an array of {@code tokenCount} valid {@link VkIndirectCommandsLayoutTokenNVX} structures
* - {@code tokenCount} must be greater than 0
*
*
* See Also
*
* {@link VkIndirectCommandsLayoutTokenNVX}, {@link NVXDeviceGeneratedCommands#vkCreateIndirectCommandsLayoutNVX CreateIndirectCommandsLayoutNVX}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code pipelineBindPoint} – the {@code VkPipelineBindPoint} that this layout targets.
* - {@code flags} – a bitmask of {@code VkIndirectCommandsLayoutUsageFlagBitsNVX} specifying usage hints of this layout.
* - {@code tokenCount} – the length of the individual command sequnce.
* - {@code pTokens} – an array describing each command token in detail. See {@code VkIndirectCommandsTokenTypeNVX} and {@link VkIndirectCommandsLayoutTokenNVX} below for details.
*
*
* Layout
*
*
* struct VkIndirectCommandsLayoutCreateInfoNVX {
* VkStructureType sType;
* const void * pNext;
* VkPipelineBindPoint pipelineBindPoint;
* VkIndirectCommandsLayoutUsageFlagsNVX flags;
* uint32_t tokenCount;
* const {@link VkIndirectCommandsLayoutTokenNVX VkIndirectCommandsLayoutTokenNVX} * pTokens;
* }The created instance holds a strong reference to the container object.
*/
public VkIndirectCommandsLayoutCreateInfoNVX(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return npNext(address()); }
/** Returns the value of the {@code pipelineBindPoint} field. */
@NativeType("VkPipelineBindPoint")
public int pipelineBindPoint() { return npipelineBindPoint(address()); }
/** Returns the value of the {@code flags} field. */
@NativeType("VkIndirectCommandsLayoutUsageFlagsNVX")
public int flags() { return nflags(address()); }
/** Returns the value of the {@code tokenCount} field. */
@NativeType("uint32_t")
public int tokenCount() { return ntokenCount(address()); }
/** Returns a {@link VkIndirectCommandsLayoutTokenNVX.Buffer} view of the struct array pointed to by the {@code pTokens} field. */
@NativeType("const VkIndirectCommandsLayoutTokenNVX *")
public VkIndirectCommandsLayoutTokenNVX.Buffer pTokens() { return npTokens(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkIndirectCommandsLayoutCreateInfoNVX sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkIndirectCommandsLayoutCreateInfoNVX pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code pipelineBindPoint} field. */
public VkIndirectCommandsLayoutCreateInfoNVX pipelineBindPoint(@NativeType("VkPipelineBindPoint") int value) { npipelineBindPoint(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkIndirectCommandsLayoutCreateInfoNVX flags(@NativeType("VkIndirectCommandsLayoutUsageFlagsNVX") int value) { nflags(address(), value); return this; }
/** Sets the address of the specified {@link VkIndirectCommandsLayoutTokenNVX.Buffer} to the {@code pTokens} field. */
public VkIndirectCommandsLayoutCreateInfoNVX pTokens(@NativeType("const VkIndirectCommandsLayoutTokenNVX *") VkIndirectCommandsLayoutTokenNVX.Buffer value) { npTokens(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkIndirectCommandsLayoutCreateInfoNVX set(
int sType,
long pNext,
int pipelineBindPoint,
int flags,
VkIndirectCommandsLayoutTokenNVX.Buffer pTokens
) {
sType(sType);
pNext(pNext);
pipelineBindPoint(pipelineBindPoint);
flags(flags);
pTokens(pTokens);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkIndirectCommandsLayoutCreateInfoNVX set(VkIndirectCommandsLayoutCreateInfoNVX src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkIndirectCommandsLayoutCreateInfoNVX malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkIndirectCommandsLayoutCreateInfoNVX calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX} instance allocated with {@link BufferUtils}. */
public static VkIndirectCommandsLayoutCreateInfoNVX create() {
return new VkIndirectCommandsLayoutCreateInfoNVX(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX} instance for the specified memory address. */
public static VkIndirectCommandsLayoutCreateInfoNVX create(long address) {
return new VkIndirectCommandsLayoutCreateInfoNVX(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkIndirectCommandsLayoutCreateInfoNVX createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkIndirectCommandsLayoutCreateInfoNVX.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkIndirectCommandsLayoutCreateInfoNVX.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkIndirectCommandsLayoutCreateInfoNVX.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkIndirectCommandsLayoutCreateInfoNVX.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkIndirectCommandsLayoutCreateInfoNVX.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 VkIndirectCommandsLayoutCreateInfoNVX.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX} instance allocated on the thread-local {@link MemoryStack}. */
public static VkIndirectCommandsLayoutCreateInfoNVX mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkIndirectCommandsLayoutCreateInfoNVX callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkIndirectCommandsLayoutCreateInfoNVX mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkIndirectCommandsLayoutCreateInfoNVX callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkIndirectCommandsLayoutCreateInfoNVX.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkIndirectCommandsLayoutCreateInfoNVX.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkIndirectCommandsLayoutCreateInfoNVX.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkIndirectCommandsLayoutCreateInfoNVX.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 VkIndirectCommandsLayoutCreateInfoNVX.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 + VkIndirectCommandsLayoutCreateInfoNVX.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkIndirectCommandsLayoutCreateInfoNVX.PNEXT); }
/** Unsafe version of {@link #pipelineBindPoint}. */
public static int npipelineBindPoint(long struct) { return memGetInt(struct + VkIndirectCommandsLayoutCreateInfoNVX.PIPELINEBINDPOINT); }
/** Unsafe version of {@link #flags}. */
public static int nflags(long struct) { return memGetInt(struct + VkIndirectCommandsLayoutCreateInfoNVX.FLAGS); }
/** Unsafe version of {@link #tokenCount}. */
public static int ntokenCount(long struct) { return memGetInt(struct + VkIndirectCommandsLayoutCreateInfoNVX.TOKENCOUNT); }
/** Unsafe version of {@link #pTokens}. */
public static VkIndirectCommandsLayoutTokenNVX.Buffer npTokens(long struct) { return VkIndirectCommandsLayoutTokenNVX.create(memGetAddress(struct + VkIndirectCommandsLayoutCreateInfoNVX.PTOKENS), ntokenCount(struct)); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkIndirectCommandsLayoutCreateInfoNVX.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkIndirectCommandsLayoutCreateInfoNVX.PNEXT, value); }
/** Unsafe version of {@link #pipelineBindPoint(int) pipelineBindPoint}. */
public static void npipelineBindPoint(long struct, int value) { memPutInt(struct + VkIndirectCommandsLayoutCreateInfoNVX.PIPELINEBINDPOINT, value); }
/** Unsafe version of {@link #flags(int) flags}. */
public static void nflags(long struct, int value) { memPutInt(struct + VkIndirectCommandsLayoutCreateInfoNVX.FLAGS, value); }
/** Sets the specified value to the {@code tokenCount} field of the specified {@code struct}. */
public static void ntokenCount(long struct, int value) { memPutInt(struct + VkIndirectCommandsLayoutCreateInfoNVX.TOKENCOUNT, value); }
/** Unsafe version of {@link #pTokens(VkIndirectCommandsLayoutTokenNVX.Buffer) pTokens}. */
public static void npTokens(long struct, VkIndirectCommandsLayoutTokenNVX.Buffer value) { memPutAddress(struct + VkIndirectCommandsLayoutCreateInfoNVX.PTOKENS, value.address()); ntokenCount(struct, value.remaining()); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
check(memGetAddress(struct + VkIndirectCommandsLayoutCreateInfoNVX.PTOKENS));
}
/**
* Calls {@link #validate(long)} for each struct contained in the specified struct array.
*
* @param array the struct array to validate
* @param count the number of structs in {@code array}
*/
public static void validate(long array, int count) {
for (int i = 0; i < count; i++) {
validate(array + i * SIZEOF);
}
}
// -----------------------------------
/** An array of {@link VkIndirectCommandsLayoutCreateInfoNVX} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkIndirectCommandsLayoutCreateInfoNVX.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 VkIndirectCommandsLayoutCreateInfoNVX#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 VkIndirectCommandsLayoutCreateInfoNVX newInstance(long address) {
return new VkIndirectCommandsLayoutCreateInfoNVX(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkIndirectCommandsLayoutCreateInfoNVX.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkIndirectCommandsLayoutCreateInfoNVX.npNext(address()); }
/** Returns the value of the {@code pipelineBindPoint} field. */
@NativeType("VkPipelineBindPoint")
public int pipelineBindPoint() { return VkIndirectCommandsLayoutCreateInfoNVX.npipelineBindPoint(address()); }
/** Returns the value of the {@code flags} field. */
@NativeType("VkIndirectCommandsLayoutUsageFlagsNVX")
public int flags() { return VkIndirectCommandsLayoutCreateInfoNVX.nflags(address()); }
/** Returns the value of the {@code tokenCount} field. */
@NativeType("uint32_t")
public int tokenCount() { return VkIndirectCommandsLayoutCreateInfoNVX.ntokenCount(address()); }
/** Returns a {@link VkIndirectCommandsLayoutTokenNVX.Buffer} view of the struct array pointed to by the {@code pTokens} field. */
@NativeType("const VkIndirectCommandsLayoutTokenNVX *")
public VkIndirectCommandsLayoutTokenNVX.Buffer pTokens() { return VkIndirectCommandsLayoutCreateInfoNVX.npTokens(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkIndirectCommandsLayoutCreateInfoNVX.Buffer sType(@NativeType("VkStructureType") int value) { VkIndirectCommandsLayoutCreateInfoNVX.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkIndirectCommandsLayoutCreateInfoNVX.Buffer pNext(@NativeType("const void *") long value) { VkIndirectCommandsLayoutCreateInfoNVX.npNext(address(), value); return this; }
/** Sets the specified value to the {@code pipelineBindPoint} field. */
public VkIndirectCommandsLayoutCreateInfoNVX.Buffer pipelineBindPoint(@NativeType("VkPipelineBindPoint") int value) { VkIndirectCommandsLayoutCreateInfoNVX.npipelineBindPoint(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkIndirectCommandsLayoutCreateInfoNVX.Buffer flags(@NativeType("VkIndirectCommandsLayoutUsageFlagsNVX") int value) { VkIndirectCommandsLayoutCreateInfoNVX.nflags(address(), value); return this; }
/** Sets the address of the specified {@link VkIndirectCommandsLayoutTokenNVX.Buffer} to the {@code pTokens} field. */
public VkIndirectCommandsLayoutCreateInfoNVX.Buffer pTokens(@NativeType("const VkIndirectCommandsLayoutTokenNVX *") VkIndirectCommandsLayoutTokenNVX.Buffer value) { VkIndirectCommandsLayoutCreateInfoNVX.npTokens(address(), value); return this; }
}
}