java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkMemoryHeap

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkMemoryHeap
extends Struct
```
Khronos Reference Page
Vulkan Specification
Contains information about a memory heap.

Member documentation
- size – the total memory size in bytes in the heap
- flags – a bitmask of VkMemoryHeapFlagBits attribute flags for the heap. One or more of:
  MEMORY_HEAP_DEVICE_LOCAL_BIT
Layout
```
struct VkMemoryHeap {
    VkDeviceSize size;
    VkMemoryHeapFlags flags;
}
```

Nested Class Summary

Nested Classes
Modifier and Type Class and 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 and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkMemoryHeap`	`calloc()` Returns a new `VkMemoryHeap` instance allocated with `memCalloc`.
`static VkMemoryHeap.Buffer`	`calloc(int capacity)` Returns a new `VkMemoryHeap.Buffer` instance allocated with `memCalloc`.
`static VkMemoryHeap`	`callocStack()` Returns a new `VkMemoryHeap` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkMemoryHeap.Buffer`	`callocStack(int capacity)` Returns a new `VkMemoryHeap.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkMemoryHeap.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkMemoryHeap.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkMemoryHeap`	`callocStack(MemoryStack stack)` Returns a new `VkMemoryHeap` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkMemoryHeap`	`create()` Returns a new `VkMemoryHeap` instance allocated with `BufferUtils`.
`static VkMemoryHeap.Buffer`	`create(int capacity)` Returns a new `VkMemoryHeap.Buffer` instance allocated with `BufferUtils`.
`static VkMemoryHeap`	`create(long address)` Returns a new `VkMemoryHeap` instance for the specified memory address or `null` if the address is `NULL`.
`static VkMemoryHeap.Buffer`	`create(long address, int capacity)` Create a `VkMemoryHeap.Buffer` instance at the specified memory.
`int`	`flags()` Returns the value of the `flags` field.
`static VkMemoryHeap`	`malloc()` Returns a new `VkMemoryHeap` instance allocated with `memAlloc`.
`static VkMemoryHeap.Buffer`	`malloc(int capacity)` Returns a new `VkMemoryHeap.Buffer` instance allocated with `memAlloc`.
`static VkMemoryHeap`	`mallocStack()` Returns a new `VkMemoryHeap` instance allocated on the thread-local `MemoryStack`.
`static VkMemoryHeap.Buffer`	`mallocStack(int capacity)` Returns a new `VkMemoryHeap.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkMemoryHeap.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkMemoryHeap.Buffer` instance allocated on the specified `MemoryStack`.
`static VkMemoryHeap`	`mallocStack(MemoryStack stack)` Returns a new `VkMemoryHeap` instance allocated on the specified `MemoryStack`.
`long`	`size()` Returns the value of the `size` field.
`int`	`sizeof()` Returns the `sizeof(struct)`.

Methods inherited from class org.lwjgl.system.Struct
clear, free

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- 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 the 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.
  - malloc
```
public static VkMemoryHeap malloc()
```
    Returns a new VkMemoryHeap instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkMemoryHeap calloc()
```
    Returns a new VkMemoryHeap instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkMemoryHeap create()
```
    Returns a new VkMemoryHeap instance allocated with BufferUtils.
  - create
```
public static VkMemoryHeap create(long address)
```
    Returns a new VkMemoryHeap instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkMemoryHeap.Buffer malloc(int capacity)
```
    Returns a new VkMemoryHeap.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkMemoryHeap.Buffer calloc(int capacity)
```
    Returns a new VkMemoryHeap.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkMemoryHeap.Buffer create(int capacity)
```
    Returns a new VkMemoryHeap.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - 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
  - mallocStack
```
public static VkMemoryHeap mallocStack()
```
    Returns a new VkMemoryHeap instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkMemoryHeap callocStack()
```
    Returns a new VkMemoryHeap instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkMemoryHeap mallocStack(MemoryStack stack)
```
    Returns a new VkMemoryHeap instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkMemoryHeap callocStack(MemoryStack stack)
```
    Returns a new VkMemoryHeap instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkMemoryHeap.Buffer mallocStack(int capacity)
```
    Returns a new VkMemoryHeap.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkMemoryHeap.Buffer callocStack(int capacity)
```
    Returns a new VkMemoryHeap.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkMemoryHeap.Buffer mallocStack(int capacity,
                                              MemoryStack stack)
```
    Returns a new VkMemoryHeap.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkMemoryHeap.Buffer callocStack(int capacity,
                                              MemoryStack stack)
```
    Returns a new VkMemoryHeap.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity

Class VkMemoryHeap

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

Constructor Detail

VkMemoryHeap

Method Detail

sizeof

size

flags

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack