Package org.lwjgl.vulkan

Class VkMemoryAllocateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMemoryAllocateInfo>

org.lwjgl.vulkan.VkMemoryAllocateInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkMemoryAllocateInfo
extends Struct<VkMemoryAllocateInfo>
implements NativeResource

 struct VkMemoryAllocateInfo {
     VkStructureType sType;
     void const * pNext;
     VkDeviceSize allocationSize;
     uint32_t memoryTypeIndex;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkMemoryAllocateInfo.Buffer	An array of VkMemoryAllocateInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	ALLOCATIONSIZE	The struct member offsets.
static final int	MEMORYTYPEINDEX	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkMemoryAllocateInfo(ByteBuffer container)	Creates a VkMemoryAllocateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
long	allocationSize()
VkMemoryAllocateInfo	allocationSize(long value)	Sets the specified value to the allocationSize field.
static VkMemoryAllocateInfo	calloc()	Returns a new VkMemoryAllocateInfo instance allocated with memCalloc.
static VkMemoryAllocateInfo.Buffer	calloc(int capacity)	Returns a new VkMemoryAllocateInfo.Buffer instance allocated with memCalloc.
static VkMemoryAllocateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkMemoryAllocateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryAllocateInfo	calloc(MemoryStack stack)	Returns a new VkMemoryAllocateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryAllocateInfo	create()	Returns a new VkMemoryAllocateInfo instance allocated with BufferUtils.
static VkMemoryAllocateInfo.Buffer	create(int capacity)	Returns a new VkMemoryAllocateInfo.Buffer instance allocated with BufferUtils.
static VkMemoryAllocateInfo	create(long address)	Returns a new VkMemoryAllocateInfo instance for the specified memory address.
static VkMemoryAllocateInfo.Buffer	create(long address, int capacity)	Create a VkMemoryAllocateInfo.Buffer instance at the specified memory.
static @Nullable VkMemoryAllocateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkMemoryAllocateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkMemoryAllocateInfo	malloc()	Returns a new VkMemoryAllocateInfo instance allocated with memAlloc.
static VkMemoryAllocateInfo.Buffer	malloc(int capacity)	Returns a new VkMemoryAllocateInfo.Buffer instance allocated with memAlloc.
static VkMemoryAllocateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkMemoryAllocateInfo.Buffer instance allocated on the specified MemoryStack.
static VkMemoryAllocateInfo	malloc(MemoryStack stack)	Returns a new VkMemoryAllocateInfo instance allocated on the specified MemoryStack.
int	memoryTypeIndex()
VkMemoryAllocateInfo	memoryTypeIndex(int value)	Sets the specified value to the memoryTypeIndex field.
static long	nallocationSize(long struct)	Unsafe version of allocationSize().
static void	nallocationSize(long struct, long value)	Unsafe version of allocationSize.
static int	nmemoryTypeIndex(long struct)	Unsafe version of memoryTypeIndex().
static void	nmemoryTypeIndex(long struct, int value)	Unsafe version of memoryTypeIndex.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()
VkMemoryAllocateInfo	pNext(long value)	Sets the specified value to the pNext field.
VkMemoryAllocateInfo	pNext(VkDedicatedAllocationMemoryAllocateInfoNV value)	Prepends the specified VkDedicatedAllocationMemoryAllocateInfoNV value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkExportMemoryAllocateInfo value)	Prepends the specified VkExportMemoryAllocateInfo value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkExportMemoryAllocateInfoKHR value)	Prepends the specified VkExportMemoryAllocateInfoKHR value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkExportMemoryAllocateInfoNV value)	Prepends the specified VkExportMemoryAllocateInfoNV value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkExportMemoryWin32HandleInfoKHR value)	Prepends the specified VkExportMemoryWin32HandleInfoKHR value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkExportMemoryWin32HandleInfoNV value)	Prepends the specified VkExportMemoryWin32HandleInfoNV value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkExportMetalObjectCreateInfoEXT value)	Prepends the specified VkExportMetalObjectCreateInfoEXT value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkImportAndroidHardwareBufferInfoANDROID value)	Prepends the specified VkImportAndroidHardwareBufferInfoANDROID value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkImportMemoryFdInfoKHR value)	Prepends the specified VkImportMemoryFdInfoKHR value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkImportMemoryHostPointerInfoEXT value)	Prepends the specified VkImportMemoryHostPointerInfoEXT value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkImportMemoryMetalHandleInfoEXT value)	Prepends the specified VkImportMemoryMetalHandleInfoEXT value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkImportMemoryWin32HandleInfoKHR value)	Prepends the specified VkImportMemoryWin32HandleInfoKHR value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkImportMemoryWin32HandleInfoNV value)	Prepends the specified VkImportMemoryWin32HandleInfoNV value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkImportMetalBufferInfoEXT value)	Prepends the specified VkImportMetalBufferInfoEXT value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkMemoryAllocateFlagsInfo value)	Prepends the specified VkMemoryAllocateFlagsInfo value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkMemoryAllocateFlagsInfoKHR value)	Prepends the specified VkMemoryAllocateFlagsInfoKHR value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkMemoryDedicatedAllocateInfo value)	Prepends the specified VkMemoryDedicatedAllocateInfo value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkMemoryDedicatedAllocateInfoKHR value)	Prepends the specified VkMemoryDedicatedAllocateInfoKHR value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkMemoryDedicatedAllocateInfoTensorARM value)	Prepends the specified VkMemoryDedicatedAllocateInfoTensorARM value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkMemoryOpaqueCaptureAddressAllocateInfo value)	Prepends the specified VkMemoryOpaqueCaptureAddressAllocateInfo value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkMemoryOpaqueCaptureAddressAllocateInfoKHR value)	Prepends the specified VkMemoryOpaqueCaptureAddressAllocateInfoKHR value to the pNext chain.
VkMemoryAllocateInfo	pNext(VkMemoryPriorityAllocateInfoEXT value)	Prepends the specified VkMemoryPriorityAllocateInfoEXT value to the pNext chain.
VkMemoryAllocateInfo	set(int sType, long pNext, long allocationSize, int memoryTypeIndex)	Initializes this struct with the specified values.
VkMemoryAllocateInfo	set(VkMemoryAllocateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkMemoryAllocateInfo	sType(int value)	Sets the specified value to the sType field.
VkMemoryAllocateInfo	sType$Default()	Sets the STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO value to the sType field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

ALLOCATIONSIZE

public static final int ALLOCATIONSIZE

The struct member offsets.

MEMORYTYPEINDEX

public static final int MEMORYTYPEINDEX

The struct member offsets.

Constructor Details

VkMemoryAllocateInfo

public VkMemoryAllocateInfo(ByteBuffer container)

Creates a VkMemoryAllocateInfo instance at the current position of the specified 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.

Method Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkMemoryAllocateInfo>

sType

public int sType()

Returns:

the value of the sType field.

pNext

public long pNext()

Returns:

the value of the pNext field.

allocationSize

public long allocationSize()

Returns:

the value of the allocationSize field.

memoryTypeIndex

public int memoryTypeIndex()

Returns:

the value of the memoryTypeIndex field.

sType

public VkMemoryAllocateInfo sType(int value)

Sets the specified value to the sType field.

sType$Default

public VkMemoryAllocateInfo sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO value to the sType field.

pNext

public VkMemoryAllocateInfo pNext(long value)

Sets the specified value to the pNext field.

pNext

public VkMemoryAllocateInfo pNext(VkDedicatedAllocationMemoryAllocateInfoNV value)

Prepends the specified VkDedicatedAllocationMemoryAllocateInfoNV value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkExportMemoryAllocateInfo value)

Prepends the specified VkExportMemoryAllocateInfo value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkExportMemoryAllocateInfoKHR value)

Prepends the specified VkExportMemoryAllocateInfoKHR value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkExportMemoryAllocateInfoNV value)

Prepends the specified VkExportMemoryAllocateInfoNV value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkExportMemoryWin32HandleInfoKHR value)

Prepends the specified VkExportMemoryWin32HandleInfoKHR value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkExportMemoryWin32HandleInfoNV value)

Prepends the specified VkExportMemoryWin32HandleInfoNV value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkExportMetalObjectCreateInfoEXT value)

Prepends the specified VkExportMetalObjectCreateInfoEXT value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkImportAndroidHardwareBufferInfoANDROID value)

Prepends the specified VkImportAndroidHardwareBufferInfoANDROID value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkImportMemoryFdInfoKHR value)

Prepends the specified VkImportMemoryFdInfoKHR value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkImportMemoryHostPointerInfoEXT value)

Prepends the specified VkImportMemoryHostPointerInfoEXT value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkImportMemoryMetalHandleInfoEXT value)

Prepends the specified VkImportMemoryMetalHandleInfoEXT value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkImportMemoryWin32HandleInfoKHR value)

Prepends the specified VkImportMemoryWin32HandleInfoKHR value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkImportMemoryWin32HandleInfoNV value)

Prepends the specified VkImportMemoryWin32HandleInfoNV value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkImportMetalBufferInfoEXT value)

Prepends the specified VkImportMetalBufferInfoEXT value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkMemoryAllocateFlagsInfo value)

Prepends the specified VkMemoryAllocateFlagsInfo value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkMemoryAllocateFlagsInfoKHR value)

Prepends the specified VkMemoryAllocateFlagsInfoKHR value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkMemoryDedicatedAllocateInfo value)

Prepends the specified VkMemoryDedicatedAllocateInfo value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkMemoryDedicatedAllocateInfoKHR value)

Prepends the specified VkMemoryDedicatedAllocateInfoKHR value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkMemoryDedicatedAllocateInfoTensorARM value)

Prepends the specified VkMemoryDedicatedAllocateInfoTensorARM value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkMemoryOpaqueCaptureAddressAllocateInfo value)

Prepends the specified VkMemoryOpaqueCaptureAddressAllocateInfo value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkMemoryOpaqueCaptureAddressAllocateInfoKHR value)

Prepends the specified VkMemoryOpaqueCaptureAddressAllocateInfoKHR value to the pNext chain.

pNext

public VkMemoryAllocateInfo pNext(VkMemoryPriorityAllocateInfoEXT value)

Prepends the specified VkMemoryPriorityAllocateInfoEXT value to the pNext chain.

allocationSize

public VkMemoryAllocateInfo allocationSize(long value)

Sets the specified value to the allocationSize field.

memoryTypeIndex

public VkMemoryAllocateInfo memoryTypeIndex(int value)

Sets the specified value to the memoryTypeIndex field.

set

public VkMemoryAllocateInfo set(int sType,
 long pNext,
 long allocationSize,
 int memoryTypeIndex)

Initializes this struct with the specified values.

set

public VkMemoryAllocateInfo set(VkMemoryAllocateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMemoryAllocateInfo malloc()

Returns a new VkMemoryAllocateInfo instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkMemoryAllocateInfo calloc()

Returns a new VkMemoryAllocateInfo instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkMemoryAllocateInfo create()

Returns a new VkMemoryAllocateInfo instance allocated with BufferUtils.

create

public static VkMemoryAllocateInfo create(long address)

Returns a new VkMemoryAllocateInfo instance for the specified memory address.

createSafe

public static @Nullable VkMemoryAllocateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryAllocateInfo.Buffer malloc(int capacity)

Returns a new VkMemoryAllocateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkMemoryAllocateInfo.Buffer calloc(int capacity)

Returns a new VkMemoryAllocateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkMemoryAllocateInfo.Buffer create(int capacity)

Returns a new VkMemoryAllocateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkMemoryAllocateInfo.Buffer create(long address,
 int capacity)

Create a VkMemoryAllocateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkMemoryAllocateInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryAllocateInfo malloc(MemoryStack stack)

Returns a new VkMemoryAllocateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkMemoryAllocateInfo calloc(MemoryStack stack)

Returns a new VkMemoryAllocateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkMemoryAllocateInfo.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new VkMemoryAllocateInfo.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkMemoryAllocateInfo.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkMemoryAllocateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nallocationSize

public static long nallocationSize(long struct)

Unsafe version of allocationSize().

nmemoryTypeIndex

public static int nmemoryTypeIndex(long struct)

Unsafe version of memoryTypeIndex().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nallocationSize

public static void nallocationSize(long struct,
 long value)

Unsafe version of allocationSize.

nmemoryTypeIndex

public static void nmemoryTypeIndex(long struct,
 int value)

Unsafe version of memoryTypeIndex.