org.lwjgl.vulkan.VkDeviceGroupBindSparseInfo 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 indicating which instances are bound.
*
* Description
*
* These device indices apply to all buffer and image memory binds included in the batch pointing to this structure. The semaphore waits and signals for the batch are executed only by the physical device specified by the {@code resourceDeviceIndex}.
*
* If this structure is not present, {@code resourceDeviceIndex} and {@code memoryDeviceIndex} are assumed to be zero.
*
* Valid Usage
*
*
* - {@code resourceDeviceIndex} and {@code memoryDeviceIndex} must both be valid device indices
* - Each memory allocation bound in this batch must have allocated an instance for {@code memoryDeviceIndex}
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link VK11#VK_STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO}
*
*
* Layout
*
*
* struct VkDeviceGroupBindSparseInfo {
* VkStructureType {@link #sType};
* void const * {@link #pNext};
* uint32_t {@link #resourceDeviceIndex};
* uint32_t {@link #memoryDeviceIndex};
* }
*/
public class VkDeviceGroupBindSparseInfo 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
STYPE,
PNEXT,
RESOURCEDEVICEINDEX,
MEMORYDEVICEINDEX;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
STYPE = layout.offsetof(0);
PNEXT = layout.offsetof(1);
RESOURCEDEVICEINDEX = layout.offsetof(2);
MEMORYDEVICEINDEX = layout.offsetof(3);
}
/**
* Creates a {@code VkDeviceGroupBindSparseInfo} 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 VkDeviceGroupBindSparseInfo(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** the type of this structure. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** {@code NULL} or a pointer to a structure extending this structure. */
@NativeType("void const *")
public long pNext() { return npNext(address()); }
/** a device index indicating which instance of the resource is bound. */
@NativeType("uint32_t")
public int resourceDeviceIndex() { return nresourceDeviceIndex(address()); }
/** a device index indicating which instance of the memory the resource instance is bound to. */
@NativeType("uint32_t")
public int memoryDeviceIndex() { return nmemoryDeviceIndex(address()); }
/** Sets the specified value to the {@link #sType} field. */
public VkDeviceGroupBindSparseInfo sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the {@link VK11#VK_STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO} value to the {@link #sType} field. */
public VkDeviceGroupBindSparseInfo sType$Default() { return sType(VK11.VK_STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO); }
/** Sets the specified value to the {@link #pNext} field. */
public VkDeviceGroupBindSparseInfo pNext(@NativeType("void const *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@link #resourceDeviceIndex} field. */
public VkDeviceGroupBindSparseInfo resourceDeviceIndex(@NativeType("uint32_t") int value) { nresourceDeviceIndex(address(), value); return this; }
/** Sets the specified value to the {@link #memoryDeviceIndex} field. */
public VkDeviceGroupBindSparseInfo memoryDeviceIndex(@NativeType("uint32_t") int value) { nmemoryDeviceIndex(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkDeviceGroupBindSparseInfo set(
int sType,
long pNext,
int resourceDeviceIndex,
int memoryDeviceIndex
) {
sType(sType);
pNext(pNext);
resourceDeviceIndex(resourceDeviceIndex);
memoryDeviceIndex(memoryDeviceIndex);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkDeviceGroupBindSparseInfo set(VkDeviceGroupBindSparseInfo src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VkDeviceGroupBindSparseInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkDeviceGroupBindSparseInfo malloc() {
return wrap(VkDeviceGroupBindSparseInfo.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkDeviceGroupBindSparseInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkDeviceGroupBindSparseInfo calloc() {
return wrap(VkDeviceGroupBindSparseInfo.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkDeviceGroupBindSparseInfo} instance allocated with {@link BufferUtils}. */
public static VkDeviceGroupBindSparseInfo create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkDeviceGroupBindSparseInfo.class, memAddress(container), container);
}
/** Returns a new {@code VkDeviceGroupBindSparseInfo} instance for the specified memory address. */
public static VkDeviceGroupBindSparseInfo create(long address) {
return wrap(VkDeviceGroupBindSparseInfo.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkDeviceGroupBindSparseInfo createSafe(long address) {
return address == NULL ? null : wrap(VkDeviceGroupBindSparseInfo.class, address);
}
/**
* Returns a new {@link VkDeviceGroupBindSparseInfo.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkDeviceGroupBindSparseInfo.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkDeviceGroupBindSparseInfo.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkDeviceGroupBindSparseInfo.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkDeviceGroupBindSparseInfo.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkDeviceGroupBindSparseInfo.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkDeviceGroupBindSparseInfo.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkDeviceGroupBindSparseInfo.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 VkDeviceGroupBindSparseInfo.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkDeviceGroupBindSparseInfo mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkDeviceGroupBindSparseInfo callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkDeviceGroupBindSparseInfo mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkDeviceGroupBindSparseInfo callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkDeviceGroupBindSparseInfo.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkDeviceGroupBindSparseInfo.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkDeviceGroupBindSparseInfo.Buffer mallocStack(int capacity, MemoryStack stack) { return malloc(capacity, stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkDeviceGroupBindSparseInfo.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code VkDeviceGroupBindSparseInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkDeviceGroupBindSparseInfo malloc(MemoryStack stack) {
return wrap(VkDeviceGroupBindSparseInfo.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkDeviceGroupBindSparseInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkDeviceGroupBindSparseInfo calloc(MemoryStack stack) {
return wrap(VkDeviceGroupBindSparseInfo.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkDeviceGroupBindSparseInfo.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkDeviceGroupBindSparseInfo.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkDeviceGroupBindSparseInfo.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 VkDeviceGroupBindSparseInfo.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #sType}. */
public static int nsType(long struct) { return UNSAFE.getInt(null, struct + VkDeviceGroupBindSparseInfo.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkDeviceGroupBindSparseInfo.PNEXT); }
/** Unsafe version of {@link #resourceDeviceIndex}. */
public static int nresourceDeviceIndex(long struct) { return UNSAFE.getInt(null, struct + VkDeviceGroupBindSparseInfo.RESOURCEDEVICEINDEX); }
/** Unsafe version of {@link #memoryDeviceIndex}. */
public static int nmemoryDeviceIndex(long struct) { return UNSAFE.getInt(null, struct + VkDeviceGroupBindSparseInfo.MEMORYDEVICEINDEX); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { UNSAFE.putInt(null, struct + VkDeviceGroupBindSparseInfo.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkDeviceGroupBindSparseInfo.PNEXT, value); }
/** Unsafe version of {@link #resourceDeviceIndex(int) resourceDeviceIndex}. */
public static void nresourceDeviceIndex(long struct, int value) { UNSAFE.putInt(null, struct + VkDeviceGroupBindSparseInfo.RESOURCEDEVICEINDEX, value); }
/** Unsafe version of {@link #memoryDeviceIndex(int) memoryDeviceIndex}. */
public static void nmemoryDeviceIndex(long struct, int value) { UNSAFE.putInt(null, struct + VkDeviceGroupBindSparseInfo.MEMORYDEVICEINDEX, value); }
// -----------------------------------
/** An array of {@link VkDeviceGroupBindSparseInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkDeviceGroupBindSparseInfo ELEMENT_FACTORY = VkDeviceGroupBindSparseInfo.create(-1L);
/**
* Creates a new {@code VkDeviceGroupBindSparseInfo.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 VkDeviceGroupBindSparseInfo#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 VkDeviceGroupBindSparseInfo getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link VkDeviceGroupBindSparseInfo#sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkDeviceGroupBindSparseInfo.nsType(address()); }
/** @return the value of the {@link VkDeviceGroupBindSparseInfo#pNext} field. */
@NativeType("void const *")
public long pNext() { return VkDeviceGroupBindSparseInfo.npNext(address()); }
/** @return the value of the {@link VkDeviceGroupBindSparseInfo#resourceDeviceIndex} field. */
@NativeType("uint32_t")
public int resourceDeviceIndex() { return VkDeviceGroupBindSparseInfo.nresourceDeviceIndex(address()); }
/** @return the value of the {@link VkDeviceGroupBindSparseInfo#memoryDeviceIndex} field. */
@NativeType("uint32_t")
public int memoryDeviceIndex() { return VkDeviceGroupBindSparseInfo.nmemoryDeviceIndex(address()); }
/** Sets the specified value to the {@link VkDeviceGroupBindSparseInfo#sType} field. */
public VkDeviceGroupBindSparseInfo.Buffer sType(@NativeType("VkStructureType") int value) { VkDeviceGroupBindSparseInfo.nsType(address(), value); return this; }
/** Sets the {@link VK11#VK_STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO} value to the {@link VkDeviceGroupBindSparseInfo#sType} field. */
public VkDeviceGroupBindSparseInfo.Buffer sType$Default() { return sType(VK11.VK_STRUCTURE_TYPE_DEVICE_GROUP_BIND_SPARSE_INFO); }
/** Sets the specified value to the {@link VkDeviceGroupBindSparseInfo#pNext} field. */
public VkDeviceGroupBindSparseInfo.Buffer pNext(@NativeType("void const *") long value) { VkDeviceGroupBindSparseInfo.npNext(address(), value); return this; }
/** Sets the specified value to the {@link VkDeviceGroupBindSparseInfo#resourceDeviceIndex} field. */
public VkDeviceGroupBindSparseInfo.Buffer resourceDeviceIndex(@NativeType("uint32_t") int value) { VkDeviceGroupBindSparseInfo.nresourceDeviceIndex(address(), value); return this; }
/** Sets the specified value to the {@link VkDeviceGroupBindSparseInfo#memoryDeviceIndex} field. */
public VkDeviceGroupBindSparseInfo.Buffer memoryDeviceIndex(@NativeType("uint32_t") int value) { VkDeviceGroupBindSparseInfo.nmemoryDeviceIndex(address(), value); return this; }
}
}