org.lwjgl.vulkan.VkBindImageMemoryDeviceGroupInfoKHX 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.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying device within a group to bind to.
*
* Description
*
* The {@link VkBindImageMemoryDeviceGroupInfoKHX} structure is defined as:
*
*
* - {@code sType} is the type of this structure.
* - {@code pNext} is {@code NULL} or a pointer to an extension-specific structure.
* - {@code deviceIndexCount} is the number of elements in {@code pDeviceIndices}.
* - {@code pDeviceIndices} is a pointer to an array of device indices.
* - {@code SFRRectCount} is the number of elements in {@code pSFRRects}.
* - {@code pSFRRects} is a pointer to an array of rectangles describing which regions of the image are attached to each instance of memory.
*
*
* If {@code deviceIndexCount} is greater than zero, then on device index i {@code image} is attached to the instance of the memory on the physical device with device index pDeviceIndices[i].
*
* Let N be the number of physical devices in the logical device. If {@code SFRRectCount} is greater than zero, then {@code pSFRRects} is an array of N2 rectangles, where the image region specified by the rectangle at element i*N+j in resource instance i is bound to the memory instance j. The blocks of the memory that are bound to each sparse image block region use an offset in memory, relative to {@code memoryOffset}, computed as if the whole image were being bound to a contiguous range of memory. In other words, horizontally adjacent image blocks use consecutive blocks of memory, vertically adjacent image blocks are separated by the number of bytes per block multiplied by the width in blocks of {@code image}, and the block at (0,0) corresponds to memory starting at {@code memoryOffset}.
*
* If {@code SFRRectCount} and {@code deviceIndexCount} are zero and the memory comes from a memory heap with the {@link KHXDeviceGroupCreation#VK_MEMORY_HEAP_MULTI_INSTANCE_BIT_KHX MEMORY_HEAP_MULTI_INSTANCE_BIT_KHX} bit set, then it is as if {@code pDeviceIndices} contains consecutive indices from zero to the number of physical devices in the logical device, minus one. In other words, by default each physical device attaches to its own instance of the memory.
*
* If {@code SFRRectCount} and {@code deviceIndexCount} are zero and the memory comes from a memory heap without the {@link KHXDeviceGroupCreation#VK_MEMORY_HEAP_MULTI_INSTANCE_BIT_KHX MEMORY_HEAP_MULTI_INSTANCE_BIT_KHX} bit set, then it is as if {@code pDeviceIndices} contains an array of zeros. In other words, by default each physical device attaches to instance zero.
*
* Valid Usage
*
*
* - At least one of {@code deviceIndexCount} and {@code SFRRectCount} must be zero.
* - {@code deviceIndexCount} must either be zero or equal to the number of physical devices in the logical device
* - All elements of {@code pDeviceIndices} must be valid device indices.
* - {@code SFRRectCount} must either be zero or equal to the number of physical devices in the logical device squared
* - Elements of {@code pSFRRects} that correspond to the same instance of an image must not overlap.
* - The {@code offset.x} member of any element of {@code pSFRRects} must be a multiple of the sparse image block width ({@link VkSparseImageFormatProperties}{@code ::imageGranularity}.width) of all non-metadata aspects of the image
* - The {@code offset.y} member of any element of {@code pSFRRects} must be a multiple of the sparse image block height ({@link VkSparseImageFormatProperties}{@code ::imageGranularity}.height) of all non-metadata aspects of the image
* - The {@code extent.width} member of any element of {@code pSFRRects} must either be a multiple of the sparse image block width of all non-metadata aspects of the image, or else {@code extent.width} + {@code offset.x} must equal the width of the image subresource
* - The {@code extent.height} member of any element of {@code pSFRRects} must either be a multiple of the sparse image block height of all non-metadata aspects of the image, or else {@code extent.height} {@code offset.y} must equal the width of the image subresource
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link KHXDeviceGroup#VK_STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO_KHX STRUCTURE_TYPE_BIND_IMAGE_MEMORY_DEVICE_GROUP_INFO_KHX}
* - {@code pNext} must be {@code NULL}
* - If {@code deviceIndexCount} is not 0, {@code pDeviceIndices} must be a pointer to an array of {@code deviceIndexCount} {@code uint32_t} values
* - If {@code SFRRectCount} is not 0, {@code pSFRRects} must be a pointer to an array of {@code SFRRectCount} {@link VkRect2D} structures
*
*
* See Also
*
* {@link VkRect2D}
*
* Layout
*
*
* struct VkBindImageMemoryDeviceGroupInfoKHX {
* VkStructureType sType;
* const void * pNext;
* uint32_t deviceIndexCount;
* const uint32_t * pDeviceIndices;
* uint32_t SFRRectCount;
* const {@link VkRect2D VkRect2D} * pSFRRects;
* }The created instance holds a strong reference to the container object.
*/
public VkBindImageMemoryDeviceGroupInfoKHX(ByteBuffer container) {
this(memAddress(container), checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return npNext(address()); }
/** Returns the value of the {@code deviceIndexCount} field. */
@NativeType("uint32_t")
public int deviceIndexCount() { return ndeviceIndexCount(address()); }
/** Returns a {@link IntBuffer} view of the data pointed to by the {@code pDeviceIndices} field. */
@NativeType("const uint32_t *")
public IntBuffer pDeviceIndices() { return npDeviceIndices(address()); }
/** Returns the value of the {@code SFRRectCount} field. */
@NativeType("uint32_t")
public int SFRRectCount() { return nSFRRectCount(address()); }
/** Returns a {@link VkRect2D.Buffer} view of the struct array pointed to by the {@code pSFRRects} field. */
@NativeType("const VkRect2D *")
public VkRect2D.Buffer pSFRRects() { return npSFRRects(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkBindImageMemoryDeviceGroupInfoKHX sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkBindImageMemoryDeviceGroupInfoKHX pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the address of the specified {@link IntBuffer} to the {@code pDeviceIndices} field. */
public VkBindImageMemoryDeviceGroupInfoKHX pDeviceIndices(@NativeType("const uint32_t *") IntBuffer value) { npDeviceIndices(address(), value); return this; }
/** Sets the address of the specified {@link VkRect2D.Buffer} to the {@code pSFRRects} field. */
public VkBindImageMemoryDeviceGroupInfoKHX pSFRRects(@NativeType("const VkRect2D *") VkRect2D.Buffer value) { npSFRRects(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkBindImageMemoryDeviceGroupInfoKHX set(
int sType,
long pNext,
IntBuffer pDeviceIndices,
VkRect2D.Buffer pSFRRects
) {
sType(sType);
pNext(pNext);
pDeviceIndices(pDeviceIndices);
pSFRRects(pSFRRects);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkBindImageMemoryDeviceGroupInfoKHX set(VkBindImageMemoryDeviceGroupInfoKHX src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkBindImageMemoryDeviceGroupInfoKHX} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkBindImageMemoryDeviceGroupInfoKHX malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkBindImageMemoryDeviceGroupInfoKHX} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkBindImageMemoryDeviceGroupInfoKHX calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkBindImageMemoryDeviceGroupInfoKHX} instance allocated with {@link BufferUtils}. */
public static VkBindImageMemoryDeviceGroupInfoKHX create() {
return new VkBindImageMemoryDeviceGroupInfoKHX(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkBindImageMemoryDeviceGroupInfoKHX} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkBindImageMemoryDeviceGroupInfoKHX create(long address) {
return address == NULL ? null : new VkBindImageMemoryDeviceGroupInfoKHX(address, null);
}
/**
* Returns a new {@link VkBindImageMemoryDeviceGroupInfoKHX.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 VkBindImageMemoryDeviceGroupInfoKHX.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 VkBindImageMemoryDeviceGroupInfoKHX.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 VkBindImageMemoryDeviceGroupInfoKHX.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 VkBindImageMemoryDeviceGroupInfoKHX} instance allocated on the thread-local {@link MemoryStack}. */
public static VkBindImageMemoryDeviceGroupInfoKHX mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkBindImageMemoryDeviceGroupInfoKHX} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkBindImageMemoryDeviceGroupInfoKHX callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkBindImageMemoryDeviceGroupInfoKHX} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkBindImageMemoryDeviceGroupInfoKHX mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkBindImageMemoryDeviceGroupInfoKHX} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkBindImageMemoryDeviceGroupInfoKHX callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkBindImageMemoryDeviceGroupInfoKHX.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 VkBindImageMemoryDeviceGroupInfoKHX.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 VkBindImageMemoryDeviceGroupInfoKHX.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 VkBindImageMemoryDeviceGroupInfoKHX.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 #sType}. */
public static int nsType(long struct) { return memGetInt(struct + VkBindImageMemoryDeviceGroupInfoKHX.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkBindImageMemoryDeviceGroupInfoKHX.PNEXT); }
/** Unsafe version of {@link #deviceIndexCount}. */
public static int ndeviceIndexCount(long struct) { return memGetInt(struct + VkBindImageMemoryDeviceGroupInfoKHX.DEVICEINDEXCOUNT); }
/** Unsafe version of {@link #pDeviceIndices() pDeviceIndices}. */
public static IntBuffer npDeviceIndices(long struct) { return memIntBuffer(memGetAddress(struct + VkBindImageMemoryDeviceGroupInfoKHX.PDEVICEINDICES), ndeviceIndexCount(struct)); }
/** Unsafe version of {@link #SFRRectCount}. */
public static int nSFRRectCount(long struct) { return memGetInt(struct + VkBindImageMemoryDeviceGroupInfoKHX.SFRRECTCOUNT); }
/** Unsafe version of {@link #pSFRRects}. */
public static VkRect2D.Buffer npSFRRects(long struct) { return VkRect2D.create(memGetAddress(struct + VkBindImageMemoryDeviceGroupInfoKHX.PSFRRECTS), nSFRRectCount(struct)); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkBindImageMemoryDeviceGroupInfoKHX.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkBindImageMemoryDeviceGroupInfoKHX.PNEXT, value); }
/** Sets the specified value to the {@code deviceIndexCount} field of the specified {@code struct}. */
public static void ndeviceIndexCount(long struct, int value) { memPutInt(struct + VkBindImageMemoryDeviceGroupInfoKHX.DEVICEINDEXCOUNT, value); }
/** Unsafe version of {@link #pDeviceIndices(IntBuffer) pDeviceIndices}. */
public static void npDeviceIndices(long struct, IntBuffer value) { memPutAddress(struct + VkBindImageMemoryDeviceGroupInfoKHX.PDEVICEINDICES, memAddressSafe(value)); ndeviceIndexCount(struct, value == null ? 0 : value.remaining()); }
/** Sets the specified value to the {@code SFRRectCount} field of the specified {@code struct}. */
public static void nSFRRectCount(long struct, int value) { memPutInt(struct + VkBindImageMemoryDeviceGroupInfoKHX.SFRRECTCOUNT, value); }
/** Unsafe version of {@link #pSFRRects(VkRect2D.Buffer) pSFRRects}. */
public static void npSFRRects(long struct, VkRect2D.Buffer value) { memPutAddress(struct + VkBindImageMemoryDeviceGroupInfoKHX.PSFRRECTS, memAddressSafe(value)); nSFRRectCount(struct, value == null ? 0 : value.remaining()); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
if (ndeviceIndexCount(struct) != 0) {
check(memGetAddress(struct + VkBindImageMemoryDeviceGroupInfoKHX.PDEVICEINDICES));
}
if (nSFRRectCount(struct) != 0) {
check(memGetAddress(struct + VkBindImageMemoryDeviceGroupInfoKHX.PSFRRECTS));
}
}
/**
* Calls {@link #validate(long)} for each struct contained in the specified struct array.
*
* @param array the struct array to validate
* @param count the number of structs in {@code array}
*/
public static void validate(long array, int count) {
for (int i = 0; i < count; i++) {
validate(array + i * SIZEOF);
}
}
// -----------------------------------
/** An array of {@link VkBindImageMemoryDeviceGroupInfoKHX} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkBindImageMemoryDeviceGroupInfoKHX.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 VkBindImageMemoryDeviceGroupInfoKHX#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 VkBindImageMemoryDeviceGroupInfoKHX newInstance(long address) {
return new VkBindImageMemoryDeviceGroupInfoKHX(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkBindImageMemoryDeviceGroupInfoKHX.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkBindImageMemoryDeviceGroupInfoKHX.npNext(address()); }
/** Returns the value of the {@code deviceIndexCount} field. */
@NativeType("uint32_t")
public int deviceIndexCount() { return VkBindImageMemoryDeviceGroupInfoKHX.ndeviceIndexCount(address()); }
/** Returns a {@link IntBuffer} view of the data pointed to by the {@code pDeviceIndices} field. */
@NativeType("const uint32_t *")
public IntBuffer pDeviceIndices() { return VkBindImageMemoryDeviceGroupInfoKHX.npDeviceIndices(address()); }
/** Returns the value of the {@code SFRRectCount} field. */
@NativeType("uint32_t")
public int SFRRectCount() { return VkBindImageMemoryDeviceGroupInfoKHX.nSFRRectCount(address()); }
/** Returns a {@link VkRect2D.Buffer} view of the struct array pointed to by the {@code pSFRRects} field. */
@NativeType("const VkRect2D *")
public VkRect2D.Buffer pSFRRects() { return VkBindImageMemoryDeviceGroupInfoKHX.npSFRRects(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkBindImageMemoryDeviceGroupInfoKHX.Buffer sType(@NativeType("VkStructureType") int value) { VkBindImageMemoryDeviceGroupInfoKHX.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkBindImageMemoryDeviceGroupInfoKHX.Buffer pNext(@NativeType("const void *") long value) { VkBindImageMemoryDeviceGroupInfoKHX.npNext(address(), value); return this; }
/** Sets the address of the specified {@link IntBuffer} to the {@code pDeviceIndices} field. */
public VkBindImageMemoryDeviceGroupInfoKHX.Buffer pDeviceIndices(@NativeType("const uint32_t *") IntBuffer value) { VkBindImageMemoryDeviceGroupInfoKHX.npDeviceIndices(address(), value); return this; }
/** Sets the address of the specified {@link VkRect2D.Buffer} to the {@code pSFRRects} field. */
public VkBindImageMemoryDeviceGroupInfoKHX.Buffer pSFRRects(@NativeType("const VkRect2D *") VkRect2D.Buffer value) { VkBindImageMemoryDeviceGroupInfoKHX.npSFRRects(address(), value); return this; }
}
}