org.lwjgl.vulkan.VkObjectTableIndexBufferEntryNVX 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 java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Parameters of an object table index buffer entry.
*
* Valid Usage
*
*
* - {@code type} must be {@link NVXDeviceGeneratedCommands#VK_OBJECT_ENTRY_TYPE_INDEX_BUFFER_NVX OBJECT_ENTRY_TYPE_INDEX_BUFFER_NVX}
*
*
* Valid Usage (Implicit)
*
*
* - {@code type} must be a valid {@code VkObjectEntryTypeNVX} value
* - {@code flags} must be a valid combination of {@code VkObjectEntryUsageFlagBitsNVX} values
* - {@code flags} must not be 0
* - {@code buffer} must be a valid {@code VkBuffer} handle
* - {@code indexType} must be a valid {@code VkIndexType} value
*
*
* Member documentation
*
*
* - {@code buffer} – specifies the {@code VkBuffer} that can be bound as index buffer
* - {@code indexType} – specifies the {@code VkIndexType} used with this index buffer
*
*
* Layout
*
*
* struct VkObjectTableIndexBufferEntryNVX {
* VkObjectEntryTypeNVX type;
* VkObjectEntryUsageFlagsNVX flags;
* VkBuffer buffer;
* VkIndexType indexType;
* }The created instance holds a strong reference to the container object.
*/
public VkObjectTableIndexBufferEntryNVX(ByteBuffer container) {
this(memAddress(container), checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code type} field. */
@NativeType("VkObjectEntryTypeNVX")
public int type() { return ntype(address()); }
/** Returns the value of the {@code flags} field. */
@NativeType("VkObjectEntryUsageFlagsNVX")
public int flags() { return nflags(address()); }
/** Returns the value of the {@code buffer} field. */
@NativeType("VkBuffer")
public long buffer() { return nbuffer(address()); }
/** Returns the value of the {@code indexType} field. */
@NativeType("VkIndexType")
public int indexType() { return nindexType(address()); }
/** Sets the specified value to the {@code type} field. */
public VkObjectTableIndexBufferEntryNVX type(@NativeType("VkObjectEntryTypeNVX") int value) { ntype(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkObjectTableIndexBufferEntryNVX flags(@NativeType("VkObjectEntryUsageFlagsNVX") int value) { nflags(address(), value); return this; }
/** Sets the specified value to the {@code buffer} field. */
public VkObjectTableIndexBufferEntryNVX buffer(@NativeType("VkBuffer") long value) { nbuffer(address(), value); return this; }
/** Sets the specified value to the {@code indexType} field. */
public VkObjectTableIndexBufferEntryNVX indexType(@NativeType("VkIndexType") int value) { nindexType(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkObjectTableIndexBufferEntryNVX set(
int type,
int flags,
long buffer,
int indexType
) {
type(type);
flags(flags);
buffer(buffer);
indexType(indexType);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkObjectTableIndexBufferEntryNVX set(VkObjectTableIndexBufferEntryNVX src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkObjectTableIndexBufferEntryNVX} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkObjectTableIndexBufferEntryNVX malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkObjectTableIndexBufferEntryNVX} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkObjectTableIndexBufferEntryNVX calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkObjectTableIndexBufferEntryNVX} instance allocated with {@link BufferUtils}. */
public static VkObjectTableIndexBufferEntryNVX create() {
return new VkObjectTableIndexBufferEntryNVX(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkObjectTableIndexBufferEntryNVX} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkObjectTableIndexBufferEntryNVX create(long address) {
return address == NULL ? null : new VkObjectTableIndexBufferEntryNVX(address, null);
}
/**
* Returns a new {@link VkObjectTableIndexBufferEntryNVX.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkObjectTableIndexBufferEntryNVX.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer calloc(int capacity) {
return create(nmemCalloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkObjectTableIndexBufferEntryNVX.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkObjectTableIndexBufferEntryNVX.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static Buffer create(long address, int capacity) {
return address == NULL ? null : new Buffer(address, null, -1, 0, capacity, capacity);
}
// -----------------------------------
/** Returns a new {@link VkObjectTableIndexBufferEntryNVX} instance allocated on the thread-local {@link MemoryStack}. */
public static VkObjectTableIndexBufferEntryNVX mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkObjectTableIndexBufferEntryNVX} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkObjectTableIndexBufferEntryNVX callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkObjectTableIndexBufferEntryNVX} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkObjectTableIndexBufferEntryNVX mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkObjectTableIndexBufferEntryNVX} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkObjectTableIndexBufferEntryNVX callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkObjectTableIndexBufferEntryNVX.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkObjectTableIndexBufferEntryNVX.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkObjectTableIndexBufferEntryNVX.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkObjectTableIndexBufferEntryNVX.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 Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #type}. */
public static int ntype(long struct) { return memGetInt(struct + VkObjectTableIndexBufferEntryNVX.TYPE); }
/** Unsafe version of {@link #flags}. */
public static int nflags(long struct) { return memGetInt(struct + VkObjectTableIndexBufferEntryNVX.FLAGS); }
/** Unsafe version of {@link #buffer}. */
public static long nbuffer(long struct) { return memGetLong(struct + VkObjectTableIndexBufferEntryNVX.BUFFER); }
/** Unsafe version of {@link #indexType}. */
public static int nindexType(long struct) { return memGetInt(struct + VkObjectTableIndexBufferEntryNVX.INDEXTYPE); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + VkObjectTableIndexBufferEntryNVX.TYPE, value); }
/** Unsafe version of {@link #flags(int) flags}. */
public static void nflags(long struct, int value) { memPutInt(struct + VkObjectTableIndexBufferEntryNVX.FLAGS, value); }
/** Unsafe version of {@link #buffer(long) buffer}. */
public static void nbuffer(long struct, long value) { memPutLong(struct + VkObjectTableIndexBufferEntryNVX.BUFFER, value); }
/** Unsafe version of {@link #indexType(int) indexType}. */
public static void nindexType(long struct, int value) { memPutInt(struct + VkObjectTableIndexBufferEntryNVX.INDEXTYPE, value); }
// -----------------------------------
/** An array of {@link VkObjectTableIndexBufferEntryNVX} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkObjectTableIndexBufferEntryNVX.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 VkObjectTableIndexBufferEntryNVX#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);
}
Buffer(long address, 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, ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkObjectTableIndexBufferEntryNVX newInstance(long address) {
return new VkObjectTableIndexBufferEntryNVX(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code type} field. */
@NativeType("VkObjectEntryTypeNVX")
public int type() { return VkObjectTableIndexBufferEntryNVX.ntype(address()); }
/** Returns the value of the {@code flags} field. */
@NativeType("VkObjectEntryUsageFlagsNVX")
public int flags() { return VkObjectTableIndexBufferEntryNVX.nflags(address()); }
/** Returns the value of the {@code buffer} field. */
@NativeType("VkBuffer")
public long buffer() { return VkObjectTableIndexBufferEntryNVX.nbuffer(address()); }
/** Returns the value of the {@code indexType} field. */
@NativeType("VkIndexType")
public int indexType() { return VkObjectTableIndexBufferEntryNVX.nindexType(address()); }
/** Sets the specified value to the {@code type} field. */
public VkObjectTableIndexBufferEntryNVX.Buffer type(@NativeType("VkObjectEntryTypeNVX") int value) { VkObjectTableIndexBufferEntryNVX.ntype(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkObjectTableIndexBufferEntryNVX.Buffer flags(@NativeType("VkObjectEntryUsageFlagsNVX") int value) { VkObjectTableIndexBufferEntryNVX.nflags(address(), value); return this; }
/** Sets the specified value to the {@code buffer} field. */
public VkObjectTableIndexBufferEntryNVX.Buffer buffer(@NativeType("VkBuffer") long value) { VkObjectTableIndexBufferEntryNVX.nbuffer(address(), value); return this; }
/** Sets the specified value to the {@code indexType} field. */
public VkObjectTableIndexBufferEntryNVX.Buffer indexType(@NativeType("VkIndexType") int value) { VkObjectTableIndexBufferEntryNVX.nindexType(address(), value); return this; }
}
}