Class VkMemoryAllocateFlagsInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkMemoryAllocateFlagsInfoKHR
Description
If MEMORY_ALLOCATE_DEVICE_MASK_BIT is not set, the number of instances allocated depends on whether MEMORY_HEAP_MULTI_INSTANCE_BIT is set in the memory heap. If MEMORY_HEAP_MULTI_INSTANCE_BIT is set, then memory is allocated for every physical device in the logical device (as if deviceMask has bits set for all device indices). If MEMORY_HEAP_MULTI_INSTANCE_BIT is not set, then a single instance of memory is allocated (as if deviceMask is set to one).
On some implementations, allocations from a multi-instance heap may consume memory on all physical devices even if the deviceMask excludes some devices. If VkPhysicalDeviceGroupProperties::subsetAllocation is 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
MEMORY_ALLOCATE_DEVICE_MASK_BITis set,deviceMaskmust be a valid device mask - If
MEMORY_ALLOCATE_DEVICE_MASK_BITis set,deviceMaskmust not be zero
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFOflagsmust be a valid combination ofVkMemoryAllocateFlagBitsvalues
Layout
struct VkMemoryAllocateFlagsInfo {
VkStructureType sType();
void const * pNext();
VkMemoryAllocateFlags flags();
uint32_t deviceMask();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkMemoryAllocateFlagsInfo(ByteBuffer container) Creates aVkMemoryAllocateFlagsInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkMemoryAllocateFlagsInfocalloc()Returns a newVkMemoryAllocateFlagsInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkMemoryAllocateFlagsInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkMemoryAllocateFlagsInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkMemoryAllocateFlagsInfocalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkMemoryAllocateFlagsInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkMemoryAllocateFlagsInfoDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkMemoryAllocateFlagsInfocallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkMemoryAllocateFlagsInfocreate()Returns a newVkMemoryAllocateFlagsInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkMemoryAllocateFlagsInfo.Bufferinstance allocated withBufferUtils.static VkMemoryAllocateFlagsInfocreate(long address) Returns a newVkMemoryAllocateFlagsInfoinstance for the specified memory address.create(long address, int capacity) Create aVkMemoryAllocateFlagsInfo.Bufferinstance at the specified memory.static @Nullable VkMemoryAllocateFlagsInfocreateSafe(long address) static @Nullable VkMemoryAllocateFlagsInfo.BuffercreateSafe(long address, int capacity) inta mask of physical devices in the logical device, indicating that memory must be allocated on each device in the mask, ifMEMORY_ALLOCATE_DEVICE_MASK_BITis set inflags.deviceMask(int value) Sets the specified value to thedeviceMask()field.intflags()a bitmask ofVkMemoryAllocateFlagBitscontrolling the allocation.flags(int value) Sets the specified value to theflags()field.static VkMemoryAllocateFlagsInfomalloc()Returns a newVkMemoryAllocateFlagsInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkMemoryAllocateFlagsInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkMemoryAllocateFlagsInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkMemoryAllocateFlagsInfomalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkMemoryAllocateFlagsInfoinstance allocated on the specifiedMemoryStack.static VkMemoryAllocateFlagsInfoDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkMemoryAllocateFlagsInfomallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static intndeviceMask(long struct) Unsafe version ofdeviceMask().static voidndeviceMask(long struct, int value) Unsafe version ofdeviceMask.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, int flags, int deviceMask) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFOvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
DEVICEMASK
public static final int DEVICEMASKThe struct member offsets.
-
-
Constructor Details
-
VkMemoryAllocateFlagsInfo
Creates aVkMemoryAllocateFlagsInfoinstance at the current position of the specifiedByteBuffercontainer. 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.
-
-
Method Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkMemoryAllocateFlagsInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()a bitmask ofVkMemoryAllocateFlagBitscontrolling the allocation. -
deviceMask
public int deviceMask()a mask of physical devices in the logical device, indicating that memory must be allocated on each device in the mask, ifMEMORY_ALLOCATE_DEVICE_MASK_BITis set inflags. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_MEMORY_ALLOCATE_FLAGS_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
flags
Sets the specified value to theflags()field. -
deviceMask
Sets the specified value to thedeviceMask()field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkMemoryAllocateFlagsInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkMemoryAllocateFlagsInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkMemoryAllocateFlagsInfoinstance allocated withBufferUtils. -
create
Returns a newVkMemoryAllocateFlagsInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkMemoryAllocateFlagsInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkMemoryAllocateFlagsInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkMemoryAllocateFlagsInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkMemoryAllocateFlagsInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
mallocStack
@Deprecated public static VkMemoryAllocateFlagsInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
@Deprecated public static VkMemoryAllocateFlagsInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkMemoryAllocateFlagsInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkMemoryAllocateFlagsInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkMemoryAllocateFlagsInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkMemoryAllocateFlagsInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkMemoryAllocateFlagsInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkMemoryAllocateFlagsInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
ndeviceMask
public static int ndeviceMask(long struct) Unsafe version ofdeviceMask(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
ndeviceMask
public static void ndeviceMask(long struct, int value) Unsafe version ofdeviceMask.
-