org.lwjgl.vulkan.VkObjectTableDescriptorSetEntryNVX 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 descriptor set entry.
*
* Valid Usage
*
*
* - {@code type} must be {@link NVXDeviceGeneratedCommands#VK_OBJECT_ENTRY_TYPE_DESCRIPTOR_SET_NVX OBJECT_ENTRY_TYPE_DESCRIPTOR_SET_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 pipelineLayout} must be a valid {@code VkPipelineLayout} handle
* - {@code descriptorSet} must be a valid {@code VkDescriptorSet} handle
* - Both of {@code descriptorSet}, and {@code pipelineLayout} must have been created, allocated, or retrieved from the same {@code VkDevice}
*
*
* Member documentation
*
*
* - {@code descriptorSet} – specifies the {@code VkDescriptorSet} that can be bound with this entry.
*
*
* Layout
*
*
* struct VkObjectTableDescriptorSetEntryNVX {
* VkObjectEntryTypeNVX type;
* VkObjectEntryUsageFlagsNVX flags;
* VkPipelineLayout pipelineLayout;
* VkDescriptorSet descriptorSet;
* }The created instance holds a strong reference to the container object.
*/
public VkObjectTableDescriptorSetEntryNVX(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 pipelineLayout} field. */
@NativeType("VkPipelineLayout")
public long pipelineLayout() { return npipelineLayout(address()); }
/** Returns the value of the {@code descriptorSet} field. */
@NativeType("VkDescriptorSet")
public long descriptorSet() { return ndescriptorSet(address()); }
/** Sets the specified value to the {@code type} field. */
public VkObjectTableDescriptorSetEntryNVX type(@NativeType("VkObjectEntryTypeNVX") int value) { ntype(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkObjectTableDescriptorSetEntryNVX flags(@NativeType("VkObjectEntryUsageFlagsNVX") int value) { nflags(address(), value); return this; }
/** Sets the specified value to the {@code pipelineLayout} field. */
public VkObjectTableDescriptorSetEntryNVX pipelineLayout(@NativeType("VkPipelineLayout") long value) { npipelineLayout(address(), value); return this; }
/** Sets the specified value to the {@code descriptorSet} field. */
public VkObjectTableDescriptorSetEntryNVX descriptorSet(@NativeType("VkDescriptorSet") long value) { ndescriptorSet(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkObjectTableDescriptorSetEntryNVX set(
int type,
int flags,
long pipelineLayout,
long descriptorSet
) {
type(type);
flags(flags);
pipelineLayout(pipelineLayout);
descriptorSet(descriptorSet);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkObjectTableDescriptorSetEntryNVX set(VkObjectTableDescriptorSetEntryNVX src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkObjectTableDescriptorSetEntryNVX} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkObjectTableDescriptorSetEntryNVX malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkObjectTableDescriptorSetEntryNVX} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkObjectTableDescriptorSetEntryNVX calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkObjectTableDescriptorSetEntryNVX} instance allocated with {@link BufferUtils}. */
public static VkObjectTableDescriptorSetEntryNVX create() {
return new VkObjectTableDescriptorSetEntryNVX(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkObjectTableDescriptorSetEntryNVX} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkObjectTableDescriptorSetEntryNVX create(long address) {
return address == NULL ? null : new VkObjectTableDescriptorSetEntryNVX(address, null);
}
/**
* Returns a new {@link VkObjectTableDescriptorSetEntryNVX.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 VkObjectTableDescriptorSetEntryNVX.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 VkObjectTableDescriptorSetEntryNVX.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 VkObjectTableDescriptorSetEntryNVX.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 VkObjectTableDescriptorSetEntryNVX} instance allocated on the thread-local {@link MemoryStack}. */
public static VkObjectTableDescriptorSetEntryNVX mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkObjectTableDescriptorSetEntryNVX} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkObjectTableDescriptorSetEntryNVX callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkObjectTableDescriptorSetEntryNVX} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkObjectTableDescriptorSetEntryNVX mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkObjectTableDescriptorSetEntryNVX} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkObjectTableDescriptorSetEntryNVX callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkObjectTableDescriptorSetEntryNVX.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 VkObjectTableDescriptorSetEntryNVX.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 VkObjectTableDescriptorSetEntryNVX.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 VkObjectTableDescriptorSetEntryNVX.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 + VkObjectTableDescriptorSetEntryNVX.TYPE); }
/** Unsafe version of {@link #flags}. */
public static int nflags(long struct) { return memGetInt(struct + VkObjectTableDescriptorSetEntryNVX.FLAGS); }
/** Unsafe version of {@link #pipelineLayout}. */
public static long npipelineLayout(long struct) { return memGetLong(struct + VkObjectTableDescriptorSetEntryNVX.PIPELINELAYOUT); }
/** Unsafe version of {@link #descriptorSet}. */
public static long ndescriptorSet(long struct) { return memGetLong(struct + VkObjectTableDescriptorSetEntryNVX.DESCRIPTORSET); }
/** Unsafe version of {@link #type(int) type}. */
public static void ntype(long struct, int value) { memPutInt(struct + VkObjectTableDescriptorSetEntryNVX.TYPE, value); }
/** Unsafe version of {@link #flags(int) flags}. */
public static void nflags(long struct, int value) { memPutInt(struct + VkObjectTableDescriptorSetEntryNVX.FLAGS, value); }
/** Unsafe version of {@link #pipelineLayout(long) pipelineLayout}. */
public static void npipelineLayout(long struct, long value) { memPutLong(struct + VkObjectTableDescriptorSetEntryNVX.PIPELINELAYOUT, value); }
/** Unsafe version of {@link #descriptorSet(long) descriptorSet}. */
public static void ndescriptorSet(long struct, long value) { memPutLong(struct + VkObjectTableDescriptorSetEntryNVX.DESCRIPTORSET, value); }
// -----------------------------------
/** An array of {@link VkObjectTableDescriptorSetEntryNVX} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkObjectTableDescriptorSetEntryNVX.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 VkObjectTableDescriptorSetEntryNVX#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 VkObjectTableDescriptorSetEntryNVX newInstance(long address) {
return new VkObjectTableDescriptorSetEntryNVX(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code type} field. */
@NativeType("VkObjectEntryTypeNVX")
public int type() { return VkObjectTableDescriptorSetEntryNVX.ntype(address()); }
/** Returns the value of the {@code flags} field. */
@NativeType("VkObjectEntryUsageFlagsNVX")
public int flags() { return VkObjectTableDescriptorSetEntryNVX.nflags(address()); }
/** Returns the value of the {@code pipelineLayout} field. */
@NativeType("VkPipelineLayout")
public long pipelineLayout() { return VkObjectTableDescriptorSetEntryNVX.npipelineLayout(address()); }
/** Returns the value of the {@code descriptorSet} field. */
@NativeType("VkDescriptorSet")
public long descriptorSet() { return VkObjectTableDescriptorSetEntryNVX.ndescriptorSet(address()); }
/** Sets the specified value to the {@code type} field. */
public VkObjectTableDescriptorSetEntryNVX.Buffer type(@NativeType("VkObjectEntryTypeNVX") int value) { VkObjectTableDescriptorSetEntryNVX.ntype(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkObjectTableDescriptorSetEntryNVX.Buffer flags(@NativeType("VkObjectEntryUsageFlagsNVX") int value) { VkObjectTableDescriptorSetEntryNVX.nflags(address(), value); return this; }
/** Sets the specified value to the {@code pipelineLayout} field. */
public VkObjectTableDescriptorSetEntryNVX.Buffer pipelineLayout(@NativeType("VkPipelineLayout") long value) { VkObjectTableDescriptorSetEntryNVX.npipelineLayout(address(), value); return this; }
/** Sets the specified value to the {@code descriptorSet} field. */
public VkObjectTableDescriptorSetEntryNVX.Buffer descriptorSet(@NativeType("VkDescriptorSet") long value) { VkObjectTableDescriptorSetEntryNVX.ndescriptorSet(address(), value); return this; }
}
}