org.lwjgl.vulkan.VkMemoryRequirements2 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 specifying memory requirements.
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link VK11#VK_STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2 STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2}
* - {@code pNext} must be {@code NULL} or a pointer to a valid instance of {@link VkMemoryDedicatedRequirements}
* - The {@code sType} value of each struct in the {@code pNext} chain must be unique
*
*
* See Also
*
* {@link VkMemoryRequirements}, {@link VkVideoGetMemoryPropertiesKHR}, {@link VK11#vkGetBufferMemoryRequirements2 GetBufferMemoryRequirements2}, {@link KHRGetMemoryRequirements2#vkGetBufferMemoryRequirements2KHR GetBufferMemoryRequirements2KHR}, {@link KHRMaintenance4#vkGetDeviceBufferMemoryRequirementsKHR GetDeviceBufferMemoryRequirementsKHR}, {@link KHRMaintenance4#vkGetDeviceImageMemoryRequirementsKHR GetDeviceImageMemoryRequirementsKHR}, {@link NVDeviceGeneratedCommands#vkGetGeneratedCommandsMemoryRequirementsNV GetGeneratedCommandsMemoryRequirementsNV}, {@link VK11#vkGetImageMemoryRequirements2 GetImageMemoryRequirements2}, {@link KHRGetMemoryRequirements2#vkGetImageMemoryRequirements2KHR GetImageMemoryRequirements2KHR}
*
* Layout
*
*
* struct VkMemoryRequirements2 {
* VkStructureType {@link #sType};
* void * {@link #pNext};
* {@link VkMemoryRequirements VkMemoryRequirements} {@link #memoryRequirements};
* }
*/
public class VkMemoryRequirements2 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,
MEMORYREQUIREMENTS;
static {
Layout layout = __struct(
__member(4),
__member(POINTER_SIZE),
__member(VkMemoryRequirements.SIZEOF, VkMemoryRequirements.ALIGNOF)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
STYPE = layout.offsetof(0);
PNEXT = layout.offsetof(1);
MEMORYREQUIREMENTS = layout.offsetof(2);
}
/**
* Creates a {@code VkMemoryRequirements2} 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 VkMemoryRequirements2(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 *")
public long pNext() { return npNext(address()); }
/** a {@link VkMemoryRequirements} structure describing the memory requirements of the resource. */
public VkMemoryRequirements memoryRequirements() { return nmemoryRequirements(address()); }
/** Sets the specified value to the {@link #sType} field. */
public VkMemoryRequirements2 sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the {@link VK11#VK_STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2 STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2} value to the {@link #sType} field. */
public VkMemoryRequirements2 sType$Default() { return sType(VK11.VK_STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2); }
/** Sets the specified value to the {@link #pNext} field. */
public VkMemoryRequirements2 pNext(@NativeType("void *") long value) { npNext(address(), value); return this; }
/** Prepends the specified {@link VkMemoryDedicatedRequirements} value to the {@code pNext} chain. */
public VkMemoryRequirements2 pNext(VkMemoryDedicatedRequirements value) { return this.pNext(value.pNext(this.pNext()).address()); }
/** Prepends the specified {@link VkMemoryDedicatedRequirementsKHR} value to the {@code pNext} chain. */
public VkMemoryRequirements2 pNext(VkMemoryDedicatedRequirementsKHR value) { return this.pNext(value.pNext(this.pNext()).address()); }
/** Initializes this struct with the specified values. */
public VkMemoryRequirements2 set(
int sType,
long pNext
) {
sType(sType);
pNext(pNext);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkMemoryRequirements2 set(VkMemoryRequirements2 src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code VkMemoryRequirements2} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkMemoryRequirements2 malloc() {
return wrap(VkMemoryRequirements2.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code VkMemoryRequirements2} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkMemoryRequirements2 calloc() {
return wrap(VkMemoryRequirements2.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code VkMemoryRequirements2} instance allocated with {@link BufferUtils}. */
public static VkMemoryRequirements2 create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(VkMemoryRequirements2.class, memAddress(container), container);
}
/** Returns a new {@code VkMemoryRequirements2} instance for the specified memory address. */
public static VkMemoryRequirements2 create(long address) {
return wrap(VkMemoryRequirements2.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkMemoryRequirements2 createSafe(long address) {
return address == NULL ? null : wrap(VkMemoryRequirements2.class, address);
}
/**
* Returns a new {@link VkMemoryRequirements2.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkMemoryRequirements2.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link VkMemoryRequirements2.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkMemoryRequirements2.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkMemoryRequirements2.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkMemoryRequirements2.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link VkMemoryRequirements2.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkMemoryRequirements2.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 VkMemoryRequirements2.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 VkMemoryRequirements2 mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkMemoryRequirements2 callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static VkMemoryRequirements2 mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static VkMemoryRequirements2 callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkMemoryRequirements2.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static VkMemoryRequirements2.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static VkMemoryRequirements2.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 VkMemoryRequirements2.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code VkMemoryRequirements2} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkMemoryRequirements2 malloc(MemoryStack stack) {
return wrap(VkMemoryRequirements2.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code VkMemoryRequirements2} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkMemoryRequirements2 calloc(MemoryStack stack) {
return wrap(VkMemoryRequirements2.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkMemoryRequirements2.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkMemoryRequirements2.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkMemoryRequirements2.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 VkMemoryRequirements2.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 + VkMemoryRequirements2.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkMemoryRequirements2.PNEXT); }
/** Unsafe version of {@link #memoryRequirements}. */
public static VkMemoryRequirements nmemoryRequirements(long struct) { return VkMemoryRequirements.create(struct + VkMemoryRequirements2.MEMORYREQUIREMENTS); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { UNSAFE.putInt(null, struct + VkMemoryRequirements2.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkMemoryRequirements2.PNEXT, value); }
// -----------------------------------
/** An array of {@link VkMemoryRequirements2} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final VkMemoryRequirements2 ELEMENT_FACTORY = VkMemoryRequirements2.create(-1L);
/**
* Creates a new {@code VkMemoryRequirements2.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 VkMemoryRequirements2#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 VkMemoryRequirements2 getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link VkMemoryRequirements2#sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkMemoryRequirements2.nsType(address()); }
/** @return the value of the {@link VkMemoryRequirements2#pNext} field. */
@NativeType("void *")
public long pNext() { return VkMemoryRequirements2.npNext(address()); }
/** @return a {@link VkMemoryRequirements} view of the {@link VkMemoryRequirements2#memoryRequirements} field. */
public VkMemoryRequirements memoryRequirements() { return VkMemoryRequirements2.nmemoryRequirements(address()); }
/** Sets the specified value to the {@link VkMemoryRequirements2#sType} field. */
public VkMemoryRequirements2.Buffer sType(@NativeType("VkStructureType") int value) { VkMemoryRequirements2.nsType(address(), value); return this; }
/** Sets the {@link VK11#VK_STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2 STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2} value to the {@link VkMemoryRequirements2#sType} field. */
public VkMemoryRequirements2.Buffer sType$Default() { return sType(VK11.VK_STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2); }
/** Sets the specified value to the {@link VkMemoryRequirements2#pNext} field. */
public VkMemoryRequirements2.Buffer pNext(@NativeType("void *") long value) { VkMemoryRequirements2.npNext(address(), value); return this; }
/** Prepends the specified {@link VkMemoryDedicatedRequirements} value to the {@code pNext} chain. */
public VkMemoryRequirements2.Buffer pNext(VkMemoryDedicatedRequirements value) { return this.pNext(value.pNext(this.pNext()).address()); }
/** Prepends the specified {@link VkMemoryDedicatedRequirementsKHR} value to the {@code pNext} chain. */
public VkMemoryRequirements2.Buffer pNext(VkMemoryDedicatedRequirementsKHR value) { return this.pNext(value.pNext(this.pNext()).address()); }
}
}