org.lwjgl.vulkan.VkBindShaderGroupIndirectCommandNV 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 input data for a single shader group command token.
*
* Valid Usage
*
*
* - The current bound graphics pipeline, as well as the pipelines it may reference, must have been created with {@link NVDeviceGeneratedCommands#VK_PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV}
* - The {@code index} must be within range of the accessible shader groups of the current bound graphics pipeline. See {@link NVDeviceGeneratedCommands#vkCmdBindPipelineShaderGroupNV CmdBindPipelineShaderGroupNV} for further details
*
*
* Layout
*
*
* struct VkBindShaderGroupIndirectCommandNV {
* uint32_t groupIndex;
* }
*/
public class VkBindShaderGroupIndirectCommandNV 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
GROUPINDEX;
static {
Layout layout = __struct(
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
GROUPINDEX = layout.offsetof(0);
}
/**
* Creates a {@code VkBindShaderGroupIndirectCommandNV} 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 VkBindShaderGroupIndirectCommandNV(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** @return the value of the {@code groupIndex} field. */
@NativeType("uint32_t")
public int groupIndex() { return ngroupIndex(address()); }
/** Sets the specified value to the {@code groupIndex} field. */
public VkBindShaderGroupIndirectCommandNV groupIndex(@NativeType("uint32_t") int value) { ngroupIndex(address(), value); return this; }
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkBindShaderGroupIndirectCommandNV set(VkBindShaderGroupIndirectCommandNV src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VkBindShaderGroupIndirectCommandNV} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkBindShaderGroupIndirectCommandNV malloc() {
return wrap(VkBindShaderGroupIndirectCommandNV.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkBindShaderGroupIndirectCommandNV} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkBindShaderGroupIndirectCommandNV calloc() {
return wrap(VkBindShaderGroupIndirectCommandNV.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkBindShaderGroupIndirectCommandNV} instance allocated with {@link BufferUtils}. */
public static VkBindShaderGroupIndirectCommandNV create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkBindShaderGroupIndirectCommandNV.class, memAddress(container), container);
}
/** Returns a new {@code VkBindShaderGroupIndirectCommandNV} instance for the specified memory address. */
public static VkBindShaderGroupIndirectCommandNV create(long address) {
return wrap(VkBindShaderGroupIndirectCommandNV.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkBindShaderGroupIndirectCommandNV createSafe(long address) {
return address == NULL ? null : wrap(VkBindShaderGroupIndirectCommandNV.class, address);
}
/**
* Returns a new {@link VkBindShaderGroupIndirectCommandNV.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkBindShaderGroupIndirectCommandNV.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkBindShaderGroupIndirectCommandNV.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkBindShaderGroupIndirectCommandNV.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkBindShaderGroupIndirectCommandNV.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkBindShaderGroupIndirectCommandNV.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkBindShaderGroupIndirectCommandNV.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkBindShaderGroupIndirectCommandNV.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkBindShaderGroupIndirectCommandNV.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
/**
* Returns a new {@code VkBindShaderGroupIndirectCommandNV} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkBindShaderGroupIndirectCommandNV malloc(MemoryStack stack) {
return wrap(VkBindShaderGroupIndirectCommandNV.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkBindShaderGroupIndirectCommandNV} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkBindShaderGroupIndirectCommandNV calloc(MemoryStack stack) {
return wrap(VkBindShaderGroupIndirectCommandNV.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkBindShaderGroupIndirectCommandNV.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkBindShaderGroupIndirectCommandNV.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkBindShaderGroupIndirectCommandNV.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 VkBindShaderGroupIndirectCommandNV.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #groupIndex}. */
public static int ngroupIndex(long struct) { return UNSAFE.getInt(null, struct + VkBindShaderGroupIndirectCommandNV.GROUPINDEX); }
/** Unsafe version of {@link #groupIndex(int) groupIndex}. */
public static void ngroupIndex(long struct, int value) { UNSAFE.putInt(null, struct + VkBindShaderGroupIndirectCommandNV.GROUPINDEX, value); }
// -----------------------------------
/** An array of {@link VkBindShaderGroupIndirectCommandNV} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkBindShaderGroupIndirectCommandNV ELEMENT_FACTORY = VkBindShaderGroupIndirectCommandNV.create(-1L);
/**
* Creates a new {@code VkBindShaderGroupIndirectCommandNV.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 VkBindShaderGroupIndirectCommandNV#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 VkBindShaderGroupIndirectCommandNV getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@code groupIndex} field. */
@NativeType("uint32_t")
public int groupIndex() { return VkBindShaderGroupIndirectCommandNV.ngroupIndex(address()); }
/** Sets the specified value to the {@code groupIndex} field. */
public VkBindShaderGroupIndirectCommandNV.Buffer groupIndex(@NativeType("uint32_t") int value) { VkBindShaderGroupIndirectCommandNV.ngroupIndex(address(), value); return this; }
}
}