Package org.lwjgl.vulkan

Class VkMemoryHeap

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkMemoryHeap

All Implemented Interfaces:

Pointer

public class VkMemoryHeap
extends Struct

Structure specifying a memory heap.

Member documentation

• size – the total memory size in bytes in the heap.
• flags – a bitmask of VkMemoryHeapFlagBits specifying attribute flags for the heap.

Layout

 struct VkMemoryHeap {
     VkDeviceSize size;
     VkMemoryHeapFlags flags;
 }

Nested Class Summary

Nested Classes

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

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static int	ALIGNOF	The struct alignment in bytes.
static int	FLAGS SIZE	The struct member offsets.
static int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkMemoryHeap	create(long address)	Returns a new VkMemoryHeap instance for the specified memory address.
static VkMemoryHeap.Buffer	create(long address, int capacity)	Create a VkMemoryHeap.Buffer instance at the specified memory.
static VkMemoryHeap	createSafe(long address)	Like create, but returns null if address is NULL.
static VkMemoryHeap.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	Returns the value of the flags field.
static int	nflags(long struct)	Unsafe version of flags().
static long	nsize(long struct)	Unsafe version of size().
long	size()	Returns the value of the size field.
int	sizeof()	Returns sizeof(struct).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull

Field Detail

SIZEOF

The struct size in bytes.

ALIGNOF

The struct alignment in bytes.

SIZE, FLAGS

The struct member offsets.

Constructor Detail

VkMemoryHeap

public VkMemoryHeap(java.nio.ByteBuffer container)

Creates a VkMemoryHeap 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 Detail

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct

size

public long size()

Returns the value of the size field.

flags

public int flags()

Returns the value of the flags field.

create

public static VkMemoryHeap create(long address)

Returns a new VkMemoryHeap instance for the specified memory address.

createSafe

@Nullable
public static VkMemoryHeap createSafe(long address)

Like create, but returns null if address is NULL.

create

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

Create a VkMemoryHeap.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

nsize

public static long nsize(long struct)

Unsafe version of size().

nflags

public static int nflags(long struct)

Unsafe version of flags().