org.lwjgl.vulkan.VkMemoryAllocateFlagsInfoKHX 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.*;
/**
* Structure controlling how many instances of memory will be allocated.
*
* Description
*
* If {@link KHXDeviceGroup#VK_MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHX MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHX} is not set, the number of instances allocated depends on whether {@link KHXDeviceGroupCreation#VK_MEMORY_HEAP_MULTI_INSTANCE_BIT_KHX MEMORY_HEAP_MULTI_INSTANCE_BIT_KHX} is set in the memory heap. If {@link KHXDeviceGroupCreation#VK_MEMORY_HEAP_MULTI_INSTANCE_BIT_KHX MEMORY_HEAP_MULTI_INSTANCE_BIT_KHX} is set, then memory is allocated for every physical device in the logical device (as if {@code deviceMask} has bits set for all device indices). If {@link KHXDeviceGroupCreation#VK_MEMORY_HEAP_MULTI_INSTANCE_BIT_KHX MEMORY_HEAP_MULTI_INSTANCE_BIT_KHX} is not set, then a single instance of memory is allocated (as if {@code deviceMask} is set to one).
*
* On some implementations, allocations from a multi-instance heap may consume memory on all physical devices even if the {@code deviceMask} excludes some devices. If {@link VkPhysicalDeviceGroupPropertiesKHX}{@code ::subsetAllocation} is {@link VK10#VK_TRUE TRUE}, then memory is only consumed for the devices in the device mask.
*
* Note
*
* In practice, most allocations on a multi-instance heap will be allocated across all physical devices. Unicast allocation support is an optional optimization for a minority of allocations.
*
*
* Valid Usage
*
*
* - If {@link KHXDeviceGroup#VK_MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHX MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHX} is set, {@code deviceMask} must be a valid device mask.
* - If {@link KHXDeviceGroup#VK_MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHX MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHX} is set, {@code deviceMask} must not be zero
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link KHXDeviceGroup#VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHX STRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFO_KHX}
* - {@code flags} must be a valid combination of {@code VkMemoryAllocateFlagBitsKHX} values
*
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code flags} – a bitmask of {@code VkMemoryAllocateFlagBitsKHX} controlling the allocation.
* - {@code deviceMask} – a mask of physical devices in the logical device, indicating that memory must be allocated on each device in the mask, if {@link KHXDeviceGroup#VK_MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHX MEMORY_ALLOCATE_DEVICE_MASK_BIT_KHX} is set in {@code flags}.
*
*
* Layout
*
*
* struct VkMemoryAllocateFlagsInfoKHX {
* VkStructureType sType;
* const void * pNext;
* VkMemoryAllocateFlagsKHX flags;
* uint32_t deviceMask;
* }The created instance holds a strong reference to the container object.
*/
public VkMemoryAllocateFlagsInfoKHX(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 flags} field. */
@NativeType("VkMemoryAllocateFlagsKHX")
public int flags() { return nflags(address()); }
/** Returns the value of the {@code deviceMask} field. */
@NativeType("uint32_t")
public int deviceMask() { return ndeviceMask(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkMemoryAllocateFlagsInfoKHX sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkMemoryAllocateFlagsInfoKHX pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkMemoryAllocateFlagsInfoKHX flags(@NativeType("VkMemoryAllocateFlagsKHX") int value) { nflags(address(), value); return this; }
/** Sets the specified value to the {@code deviceMask} field. */
public VkMemoryAllocateFlagsInfoKHX deviceMask(@NativeType("uint32_t") int value) { ndeviceMask(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkMemoryAllocateFlagsInfoKHX set(
int sType,
long pNext,
int flags,
int deviceMask
) {
sType(sType);
pNext(pNext);
flags(flags);
deviceMask(deviceMask);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkMemoryAllocateFlagsInfoKHX set(VkMemoryAllocateFlagsInfoKHX src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkMemoryAllocateFlagsInfoKHX} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkMemoryAllocateFlagsInfoKHX malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkMemoryAllocateFlagsInfoKHX} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkMemoryAllocateFlagsInfoKHX calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkMemoryAllocateFlagsInfoKHX} instance allocated with {@link BufferUtils}. */
public static VkMemoryAllocateFlagsInfoKHX create() {
return new VkMemoryAllocateFlagsInfoKHX(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkMemoryAllocateFlagsInfoKHX} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkMemoryAllocateFlagsInfoKHX create(long address) {
return address == NULL ? null : new VkMemoryAllocateFlagsInfoKHX(address, null);
}
/**
* Returns a new {@link VkMemoryAllocateFlagsInfoKHX.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 VkMemoryAllocateFlagsInfoKHX.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 VkMemoryAllocateFlagsInfoKHX.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 VkMemoryAllocateFlagsInfoKHX.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 VkMemoryAllocateFlagsInfoKHX} instance allocated on the thread-local {@link MemoryStack}. */
public static VkMemoryAllocateFlagsInfoKHX mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkMemoryAllocateFlagsInfoKHX} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkMemoryAllocateFlagsInfoKHX callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkMemoryAllocateFlagsInfoKHX} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkMemoryAllocateFlagsInfoKHX mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkMemoryAllocateFlagsInfoKHX} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkMemoryAllocateFlagsInfoKHX callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkMemoryAllocateFlagsInfoKHX.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 VkMemoryAllocateFlagsInfoKHX.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 VkMemoryAllocateFlagsInfoKHX.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 VkMemoryAllocateFlagsInfoKHX.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 + VkMemoryAllocateFlagsInfoKHX.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkMemoryAllocateFlagsInfoKHX.PNEXT); }
/** Unsafe version of {@link #flags}. */
public static int nflags(long struct) { return memGetInt(struct + VkMemoryAllocateFlagsInfoKHX.FLAGS); }
/** Unsafe version of {@link #deviceMask}. */
public static int ndeviceMask(long struct) { return memGetInt(struct + VkMemoryAllocateFlagsInfoKHX.DEVICEMASK); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkMemoryAllocateFlagsInfoKHX.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkMemoryAllocateFlagsInfoKHX.PNEXT, value); }
/** Unsafe version of {@link #flags(int) flags}. */
public static void nflags(long struct, int value) { memPutInt(struct + VkMemoryAllocateFlagsInfoKHX.FLAGS, value); }
/** Unsafe version of {@link #deviceMask(int) deviceMask}. */
public static void ndeviceMask(long struct, int value) { memPutInt(struct + VkMemoryAllocateFlagsInfoKHX.DEVICEMASK, value); }
// -----------------------------------
/** An array of {@link VkMemoryAllocateFlagsInfoKHX} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkMemoryAllocateFlagsInfoKHX.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 VkMemoryAllocateFlagsInfoKHX#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 VkMemoryAllocateFlagsInfoKHX newInstance(long address) {
return new VkMemoryAllocateFlagsInfoKHX(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkMemoryAllocateFlagsInfoKHX.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkMemoryAllocateFlagsInfoKHX.npNext(address()); }
/** Returns the value of the {@code flags} field. */
@NativeType("VkMemoryAllocateFlagsKHX")
public int flags() { return VkMemoryAllocateFlagsInfoKHX.nflags(address()); }
/** Returns the value of the {@code deviceMask} field. */
@NativeType("uint32_t")
public int deviceMask() { return VkMemoryAllocateFlagsInfoKHX.ndeviceMask(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkMemoryAllocateFlagsInfoKHX.Buffer sType(@NativeType("VkStructureType") int value) { VkMemoryAllocateFlagsInfoKHX.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkMemoryAllocateFlagsInfoKHX.Buffer pNext(@NativeType("const void *") long value) { VkMemoryAllocateFlagsInfoKHX.npNext(address(), value); return this; }
/** Sets the specified value to the {@code flags} field. */
public VkMemoryAllocateFlagsInfoKHX.Buffer flags(@NativeType("VkMemoryAllocateFlagsKHX") int value) { VkMemoryAllocateFlagsInfoKHX.nflags(address(), value); return this; }
/** Sets the specified value to the {@code deviceMask} field. */
public VkMemoryAllocateFlagsInfoKHX.Buffer deviceMask(@NativeType("uint32_t") int value) { VkMemoryAllocateFlagsInfoKHX.ndeviceMask(address(), value); return this; }
}
}