org.lwjgl.vulkan.VkSparseImageMemoryRequirements2KHR 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.*;
/**
* Layout
*
*
* struct VkSparseImageMemoryRequirements2KHR {
* VkStructureType sType;
* void * pNext;
* {@link VkSparseImageMemoryRequirements VkSparseImageMemoryRequirements} memoryRequirements;
* }
*/
public class VkSparseImageMemoryRequirements2KHR extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
STYPE,
PNEXT,
MEMORYREQUIREMENTS;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(VkSparseImageMemoryRequirements.SIZEOF, VkSparseImageMemoryRequirements.ALIGNOF)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
STYPE = layout.offsetof(0);
PNEXT = layout.offsetof(1);
MEMORYREQUIREMENTS = layout.offsetof(2);
}
VkSparseImageMemoryRequirements2KHR(long address, @Nullable ByteBuffer container) {
super(address, container);
}
/**
* Creates a {@link VkSparseImageMemoryRequirements2KHR} 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 VkSparseImageMemoryRequirements2KHR(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("void *")
public long pNext() { return npNext(address()); }
/** Returns a {@link VkSparseImageMemoryRequirements} view of the {@code memoryRequirements} field. */
public VkSparseImageMemoryRequirements memoryRequirements() { return nmemoryRequirements(address()); }
// -----------------------------------
/** Returns a new {@link VkSparseImageMemoryRequirements2KHR} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkSparseImageMemoryRequirements2KHR malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkSparseImageMemoryRequirements2KHR} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkSparseImageMemoryRequirements2KHR calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkSparseImageMemoryRequirements2KHR} instance allocated with {@link BufferUtils}. */
public static VkSparseImageMemoryRequirements2KHR create() {
return new VkSparseImageMemoryRequirements2KHR(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkSparseImageMemoryRequirements2KHR} instance for the specified memory address. */
public static VkSparseImageMemoryRequirements2KHR create(long address) {
return new VkSparseImageMemoryRequirements2KHR(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkSparseImageMemoryRequirements2KHR createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkSparseImageMemoryRequirements2KHR.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkSparseImageMemoryRequirements2KHR.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkSparseImageMemoryRequirements2KHR.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkSparseImageMemoryRequirements2KHR.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkSparseImageMemoryRequirements2KHR.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkSparseImageMemoryRequirements2KHR.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkSparseImageMemoryRequirements2KHR.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkSparseImageMemoryRequirements2KHR.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkSparseImageMemoryRequirements2KHR.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkSparseImageMemoryRequirements2KHR} instance allocated on the thread-local {@link MemoryStack}. */
public static VkSparseImageMemoryRequirements2KHR mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkSparseImageMemoryRequirements2KHR} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkSparseImageMemoryRequirements2KHR callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkSparseImageMemoryRequirements2KHR} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkSparseImageMemoryRequirements2KHR mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkSparseImageMemoryRequirements2KHR} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkSparseImageMemoryRequirements2KHR callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkSparseImageMemoryRequirements2KHR.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkSparseImageMemoryRequirements2KHR.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkSparseImageMemoryRequirements2KHR.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkSparseImageMemoryRequirements2KHR.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkSparseImageMemoryRequirements2KHR.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkSparseImageMemoryRequirements2KHR.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkSparseImageMemoryRequirements2KHR.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 VkSparseImageMemoryRequirements2KHR.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 + VkSparseImageMemoryRequirements2KHR.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkSparseImageMemoryRequirements2KHR.PNEXT); }
/** Unsafe version of {@link #memoryRequirements}. */
public static VkSparseImageMemoryRequirements nmemoryRequirements(long struct) { return VkSparseImageMemoryRequirements.create(struct + VkSparseImageMemoryRequirements2KHR.MEMORYREQUIREMENTS); }
// -----------------------------------
/** An array of {@link VkSparseImageMemoryRequirements2KHR} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkSparseImageMemoryRequirements2KHR.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 VkSparseImageMemoryRequirements2KHR#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 Buffer newBufferInstance(long address, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkSparseImageMemoryRequirements2KHR newInstance(long address) {
return new VkSparseImageMemoryRequirements2KHR(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkSparseImageMemoryRequirements2KHR.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("void *")
public long pNext() { return VkSparseImageMemoryRequirements2KHR.npNext(address()); }
/** Returns a {@link VkSparseImageMemoryRequirements} view of the {@code memoryRequirements} field. */
public VkSparseImageMemoryRequirements memoryRequirements() { return VkSparseImageMemoryRequirements2KHR.nmemoryRequirements(address()); }
}
}