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

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

Access	Constructor and Description
protected	VkMemoryHeap(long address, ByteBuffer container)
public	VkMemoryHeap(ByteBuffer container) Creates a `VkMemoryHeap` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
protected VkMemoryHeap	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkMemoryHeap	create(long address) Returns a new `VkMemoryHeap` instance for the specified memory address.
public static VkMemoryHeap.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkMemoryHeap.Buffer` instance at the specified memory.
public static VkMemoryHeap	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkMemoryHeap.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	flags() a bitmask of `VkMemoryHeapFlagBits` specifying attribute flags for the heap.
public static int	nflags(long struct) Unsafe version of `flags`.
public static long	nsize(long struct) Unsafe version of `size`.
public long	size() the total memory size in bytes in the heap.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

FLAGS	back to summary
public static final int FLAGS The struct member offsets.

SIZE	back to summary
public static final int SIZE The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

Constructor Detail

VkMemoryHeap	back to summary
protected VkMemoryHeap(long address, ByteBuffer container)

VkMemoryHeap back to summary

VkMemoryHeap	back to summary
public VkMemoryHeap(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.

public VkMemoryHeap(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

create back to summary

create	back to summary
protected VkMemoryHeap create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected VkMemoryHeap create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static VkMemoryHeap create(long address) Returns a new `VkMemoryHeap` instance for the specified memory address.

create back to summary

create	back to summary
public static VkMemoryHeap.Buffer create(long address, int capacity) Create a `VkMemoryHeap.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a VkMemoryHeap.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkMemoryHeap createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkMemoryHeap createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkMemoryHeap.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

flags back to summary

flags	back to summary
public int flags() a bitmask of `VkMemoryHeapFlagBits` specifying attribute flags for the heap. Annotations @NativeType:VkMemoryHeapFlags

public int flags()

a bitmask of VkMemoryHeapFlagBits specifying attribute flags for the heap.

Annotations

@NativeType:VkMemoryHeapFlags

nflags	back to summary
public static int nflags(long struct) Unsafe version of `flags`.

nsize	back to summary
public static long nsize(long struct) Unsafe version of `size`.

size	back to summary
public long size() the total memory size in bytes in the heap. Annotations @NativeType:VkDeviceSize

size

back to summary

public long size()

the total memory size in bytes in the heap.

Annotations

@NativeType:VkDeviceSize

sizeof back to summary

sizeof	back to summary
public int sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Doc from org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`. Annotations @Override

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

org.lwjgl.vulkan back to summary

public Class VkMemoryHeap.Buffer

Class Inheritance

extends StructBuffer<VkMemoryHeap, VkMemoryHeap.Buffer>

An array of VkMemoryHeap structs.

Field Summary

Modifier and Type	Field and Description
private static final VkMemoryHeap	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkMemoryHeap.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
public int	Returns: the value of the `VkMemoryHeap#flags` field. flags()
protected VkMemoryHeap	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
protected VkMemoryHeap.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public long	Returns: the value of the `VkMemoryHeap#size` field. size()

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkMemoryHeap ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

Buffer	back to summary
public Buffer(ByteBuffer container) Creates a new `VkMemoryHeap.Buffer` instance backed by the specified container. Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by `VkMemoryHeap#SIZEOF`, and its mark will be undefined. The created buffer instance holds a strong reference to the container object.

public Buffer(ByteBuffer container)

Creates a new VkMemoryHeap.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkMemoryHeap#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

flags	back to summary
public int flags() Returns:int the value of the `VkMemoryHeap#flags` field. Annotations @NativeType:VkMemoryHeapFlags

getElementFactory	back to summary
protected VkMemoryHeap getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory. Annotations @Override

getElementFactory

back to summary

protected VkMemoryHeap getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

self	back to summary
protected VkMemoryHeap.Buffer self() Implements abstract org.lwjgl.system.CustomBuffer.self. Annotations @Override

self

back to summary

protected VkMemoryHeap.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

size	back to summary
public long size() Returns:long the value of the `VkMemoryHeap#size` field. Annotations @NativeType:VkDeviceSize

public Class VkMemoryHeap

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkMemoryHeap.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail