org.lwjgl.vulkan.VkIndirectCommandsStreamNV 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 streams for generated command tokens.
*
* Valid Usage
*
*
* - The {@code buffer}’s usage flag must have the {@link VK10#VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT BUFFER_USAGE_INDIRECT_BUFFER_BIT} bit set
* - The {@code offset} must be aligned to {@link VkPhysicalDeviceDeviceGeneratedCommandsPropertiesNV}{@code ::minIndirectCommandsBufferOffsetAlignment}
* - If {@code buffer} is non-sparse then it must be bound completely and contiguously to a single {@code VkDeviceMemory} object
*
*
* Valid Usage (Implicit)
*
*
* - {@code buffer} must be a valid {@code VkBuffer} handle
*
*
* See Also
*
* {@link VkGeneratedCommandsInfoNV}
*
* Layout
*
*
* struct VkIndirectCommandsStreamNV {
* VkBuffer {@link #buffer};
* VkDeviceSize {@link #offset};
* }
*/
public class VkIndirectCommandsStreamNV 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
BUFFER,
OFFSET;
static {
Layout layout = __struct(
__member(8),
__member(8)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
BUFFER = layout.offsetof(0);
OFFSET = layout.offsetof(1);
}
/**
* Creates a {@code VkIndirectCommandsStreamNV} 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 VkIndirectCommandsStreamNV(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** specifies the {@code VkBuffer} storing the functional arguments for each sequence. These arguments can be written by the device. */
@NativeType("VkBuffer")
public long buffer() { return nbuffer(address()); }
/** specified an offset into {@code buffer} where the arguments start. */
@NativeType("VkDeviceSize")
public long offset() { return noffset(address()); }
/** Sets the specified value to the {@link #buffer} field. */
public VkIndirectCommandsStreamNV buffer(@NativeType("VkBuffer") long value) { nbuffer(address(), value); return this; }
/** Sets the specified value to the {@link #offset} field. */
public VkIndirectCommandsStreamNV offset(@NativeType("VkDeviceSize") long value) { noffset(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkIndirectCommandsStreamNV set(
long buffer,
long offset
) {
buffer(buffer);
offset(offset);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkIndirectCommandsStreamNV set(VkIndirectCommandsStreamNV src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VkIndirectCommandsStreamNV} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkIndirectCommandsStreamNV malloc() {
return wrap(VkIndirectCommandsStreamNV.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkIndirectCommandsStreamNV} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkIndirectCommandsStreamNV calloc() {
return wrap(VkIndirectCommandsStreamNV.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkIndirectCommandsStreamNV} instance allocated with {@link BufferUtils}. */
public static VkIndirectCommandsStreamNV create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkIndirectCommandsStreamNV.class, memAddress(container), container);
}
/** Returns a new {@code VkIndirectCommandsStreamNV} instance for the specified memory address. */
public static VkIndirectCommandsStreamNV create(long address) {
return wrap(VkIndirectCommandsStreamNV.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkIndirectCommandsStreamNV createSafe(long address) {
return address == NULL ? null : wrap(VkIndirectCommandsStreamNV.class, address);
}
/**
* Returns a new {@link VkIndirectCommandsStreamNV.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkIndirectCommandsStreamNV.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkIndirectCommandsStreamNV.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkIndirectCommandsStreamNV.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkIndirectCommandsStreamNV.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkIndirectCommandsStreamNV.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkIndirectCommandsStreamNV.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkIndirectCommandsStreamNV.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 VkIndirectCommandsStreamNV.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
/**
* Returns a new {@code VkIndirectCommandsStreamNV} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkIndirectCommandsStreamNV malloc(MemoryStack stack) {
return wrap(VkIndirectCommandsStreamNV.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkIndirectCommandsStreamNV} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkIndirectCommandsStreamNV calloc(MemoryStack stack) {
return wrap(VkIndirectCommandsStreamNV.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkIndirectCommandsStreamNV.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkIndirectCommandsStreamNV.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkIndirectCommandsStreamNV.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 VkIndirectCommandsStreamNV.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #buffer}. */
public static long nbuffer(long struct) { return UNSAFE.getLong(null, struct + VkIndirectCommandsStreamNV.BUFFER); }
/** Unsafe version of {@link #offset}. */
public static long noffset(long struct) { return UNSAFE.getLong(null, struct + VkIndirectCommandsStreamNV.OFFSET); }
/** Unsafe version of {@link #buffer(long) buffer}. */
public static void nbuffer(long struct, long value) { UNSAFE.putLong(null, struct + VkIndirectCommandsStreamNV.BUFFER, value); }
/** Unsafe version of {@link #offset(long) offset}. */
public static void noffset(long struct, long value) { UNSAFE.putLong(null, struct + VkIndirectCommandsStreamNV.OFFSET, value); }
// -----------------------------------
/** An array of {@link VkIndirectCommandsStreamNV} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkIndirectCommandsStreamNV ELEMENT_FACTORY = VkIndirectCommandsStreamNV.create(-1L);
/**
* Creates a new {@code VkIndirectCommandsStreamNV.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 VkIndirectCommandsStreamNV#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 VkIndirectCommandsStreamNV getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link VkIndirectCommandsStreamNV#buffer} field. */
@NativeType("VkBuffer")
public long buffer() { return VkIndirectCommandsStreamNV.nbuffer(address()); }
/** @return the value of the {@link VkIndirectCommandsStreamNV#offset} field. */
@NativeType("VkDeviceSize")
public long offset() { return VkIndirectCommandsStreamNV.noffset(address()); }
/** Sets the specified value to the {@link VkIndirectCommandsStreamNV#buffer} field. */
public VkIndirectCommandsStreamNV.Buffer buffer(@NativeType("VkBuffer") long value) { VkIndirectCommandsStreamNV.nbuffer(address(), value); return this; }
/** Sets the specified value to the {@link VkIndirectCommandsStreamNV#offset} field. */
public VkIndirectCommandsStreamNV.Buffer offset(@NativeType("VkDeviceSize") long value) { VkIndirectCommandsStreamNV.noffset(address(), value); return this; }
}
}