Package org.lwjgl.vulkan

Class VkMemoryRequirements

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMemoryRequirements>

org.lwjgl.vulkan.VkMemoryRequirements

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkMemoryRequirements
extends Struct<VkMemoryRequirements>
implements NativeResource

Structure specifying memory requirements.

See Also

VkMemoryRequirements2, VkVideoSessionMemoryRequirementsKHR, GetBufferMemoryRequirements, GetImageMemoryRequirements

Layout

 struct VkMemoryRequirements {
     VkDeviceSize size();
     VkDeviceSize alignment();
     uint32_t memoryTypeBits();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkMemoryRequirements.Buffer	An array of VkMemoryRequirements 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	ALIGNMENT	The struct member offsets.
static final int	ALIGNOF	The struct alignment in bytes.
static final int	MEMORYTYPEBITS	The struct member offsets.
static final int	SIZE	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
long	alignment()	the alignment, in bytes, of the offset within the allocation required for the resource.
VkMemoryRequirements	alignment(long value)	Sets the specified value to the alignment() field.
static VkMemoryRequirements	calloc()	Returns a new VkMemoryRequirements instance allocated with memCalloc.
static VkMemoryRequirements.Buffer	calloc(int capacity)	Returns a new VkMemoryRequirements.Buffer instance allocated with memCalloc.
static VkMemoryRequirements.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkMemoryRequirements.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryRequirements	calloc(MemoryStack stack)	Returns a new VkMemoryRequirements instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryRequirements	callocStack()	Deprecated.
static VkMemoryRequirements.Buffer	callocStack(int capacity)	Deprecated.
static VkMemoryRequirements.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkMemoryRequirements	callocStack(MemoryStack stack)	Deprecated.
static VkMemoryRequirements	create()	Returns a new VkMemoryRequirements instance allocated with BufferUtils.
static VkMemoryRequirements.Buffer	create(int capacity)	Returns a new VkMemoryRequirements.Buffer instance allocated with BufferUtils.
static VkMemoryRequirements	create(long address)	Returns a new VkMemoryRequirements instance for the specified memory address.
static VkMemoryRequirements.Buffer	create(long address, int capacity)	Create a VkMemoryRequirements.Buffer instance at the specified memory.
static VkMemoryRequirements	createSafe(long address)	Like create, but returns null if address is NULL.
static VkMemoryRequirements.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkMemoryRequirements	malloc()	Returns a new VkMemoryRequirements instance allocated with memAlloc.
static VkMemoryRequirements.Buffer	malloc(int capacity)	Returns a new VkMemoryRequirements.Buffer instance allocated with memAlloc.
static VkMemoryRequirements.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkMemoryRequirements.Buffer instance allocated on the specified MemoryStack.
static VkMemoryRequirements	malloc(MemoryStack stack)	Returns a new VkMemoryRequirements instance allocated on the specified MemoryStack.
static VkMemoryRequirements	mallocStack()	Deprecated.
static VkMemoryRequirements.Buffer	mallocStack(int capacity)	Deprecated.
static VkMemoryRequirements.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkMemoryRequirements	mallocStack(MemoryStack stack)	Deprecated.
int	memoryTypeBits()	a bitmask and contains one bit set for every supported memory type for the resource.
VkMemoryRequirements	memoryTypeBits(int value)	Sets the specified value to the memoryTypeBits() field.
static long	nalignment(long struct)	Unsafe version of alignment().
static void	nalignment(long struct, long value)	Unsafe version of alignment.
static int	nmemoryTypeBits(long struct)	Unsafe version of memoryTypeBits().
static void	nmemoryTypeBits(long struct, int value)	Unsafe version of memoryTypeBits.
static long	nsize(long struct)	Unsafe version of size().
static void	nsize(long struct, long value)	Unsafe version of size.
VkMemoryRequirements	set(long size, long alignment, int memoryTypeBits)	Initializes this struct with the specified values.
VkMemoryRequirements	set(VkMemoryRequirements src)	Copies the specified struct data to this struct.
long	size()	the size, in bytes, of the memory allocation required for the resource.
VkMemoryRequirements	size(long value)	Sets the specified value to the size() field.
int	sizeof()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

SIZE

public static final int SIZE

The struct member offsets.

ALIGNMENT

public static final int ALIGNMENT

The struct member offsets.

MEMORYTYPEBITS

public static final int MEMORYTYPEBITS

The struct member offsets.

Constructor Details

VkMemoryRequirements

public VkMemoryRequirements(ByteBuffer container)

Creates a VkMemoryRequirements 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<VkMemoryRequirements>

size

public long size()

the size, in bytes, of the memory allocation required for the resource.

alignment

public long alignment()

the alignment, in bytes, of the offset within the allocation required for the resource.

memoryTypeBits

public int memoryTypeBits()

a bitmask and contains one bit set for every supported memory type for the resource. Bit i is set if and only if the memory type i in the VkPhysicalDeviceMemoryProperties structure for the physical device is supported for the resource.

size

public VkMemoryRequirements size(long value)

Sets the specified value to the size() field.

alignment

public VkMemoryRequirements alignment(long value)

Sets the specified value to the alignment() field.

memoryTypeBits

public VkMemoryRequirements memoryTypeBits(int value)

Sets the specified value to the memoryTypeBits() field.

set

public VkMemoryRequirements set(long size,
 long alignment,
 int memoryTypeBits)

Initializes this struct with the specified values.

set

public VkMemoryRequirements set(VkMemoryRequirements src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMemoryRequirements malloc()

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

calloc

public static VkMemoryRequirements calloc()

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

create

public static VkMemoryRequirements create()

Returns a new VkMemoryRequirements instance allocated with BufferUtils.

create

public static VkMemoryRequirements create(long address)

Returns a new VkMemoryRequirements instance for the specified memory address.

createSafe

@Nullable
public static VkMemoryRequirements createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryRequirements.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkMemoryRequirements.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkMemoryRequirements.Buffer create(int capacity)

Returns a new VkMemoryRequirements.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkMemoryRequirements.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkMemoryRequirements mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkMemoryRequirements callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkMemoryRequirements mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkMemoryRequirements callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkMemoryRequirements.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkMemoryRequirements.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkMemoryRequirements.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkMemoryRequirements.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkMemoryRequirements malloc(MemoryStack stack)

Returns a new VkMemoryRequirements instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkMemoryRequirements calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkMemoryRequirements.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

nsize

public static long nsize(long struct)

Unsafe version of size().

nalignment

public static long nalignment(long struct)

Unsafe version of alignment().

nmemoryTypeBits

public static int nmemoryTypeBits(long struct)

Unsafe version of memoryTypeBits().

nsize

public static void nsize(long struct,
 long value)

Unsafe version of size.

nalignment

public static void nalignment(long struct,
 long value)

Unsafe version of alignment.

nmemoryTypeBits

public static void nmemoryTypeBits(long struct,
 int value)

Unsafe version of memoryTypeBits.