Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMemoryType

extends Struct<VkMemoryType>
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Structure specifying memory type.
See Also

VkPhysicalDeviceMemoryProperties

Layout


struct VkMemoryType {
    VkMemoryPropertyFlags propertyFlags;
    uint32_t heapIndex;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkMemoryType.Buffer

An array of VkMemoryType structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
HEAPINDEX

The struct member offsets.

public static final int
PROPERTYFLAGS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkMemoryType(long address, ByteBuffer container)

public
VkMemoryType(ByteBuffer container)

Creates a VkMemoryType instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
protected VkMemoryType
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 VkMemoryType
create(long address)

Returns a new VkMemoryType instance for the specified memory address.

public static VkMemoryType.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkMemoryType.Buffer instance at the specified memory.

public static VkMemoryType
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
heapIndex()

describes which memory heap this memory type corresponds to, and must be less than memoryHeapCount from the VkPhysicalDeviceMemoryProperties structure.

public static int
nheapIndex(long struct)

Unsafe version of heapIndex.

public static int
npropertyFlags(long struct)

Unsafe version of propertyFlags.

public int
propertyFlags()

a bitmask of VkMemoryPropertyFlagBits of properties for this memory type.

public int
sizeof()

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

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

HEAPINDEXback to summary
public static final int HEAPINDEX

The struct member offsets.

PROPERTYFLAGSback to summary
public static final int PROPERTYFLAGS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkMemoryTypeback to summary
protected VkMemoryType(long address, ByteBuffer container)
VkMemoryTypeback to summary
public VkMemoryType(ByteBuffer container)

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

createback to summary
protected VkMemoryType 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
createback to summary
public static VkMemoryType create(long address)

Returns a new VkMemoryType instance for the specified memory address.

createback to summary
public static VkMemoryType.Buffer create(long address, int capacity)

Create a VkMemoryType.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMemoryType createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkMemoryType.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
heapIndexback to summary
public int heapIndex()

describes which memory heap this memory type corresponds to, and must be less than memoryHeapCount from the VkPhysicalDeviceMemoryProperties structure.

Annotations
@NativeType:uint32_t
nheapIndexback to summary
public static int nheapIndex(long struct)

Unsafe version of heapIndex.

npropertyFlagsback to summary
public static int npropertyFlags(long struct)

Unsafe version of propertyFlags.

propertyFlagsback to summary
public int propertyFlags()

a bitmask of VkMemoryPropertyFlagBits of properties for this memory type.

Annotations
@NativeType:VkMemoryPropertyFlags
sizeofback to summary
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 VkMemoryType.Buffer

extends StructBuffer<VkMemoryType, VkMemoryType.Buffer>
Class Inheritance

An array of VkMemoryType structs.

Field Summary

Modifier and TypeField and Description
private static final VkMemoryType

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMemoryType.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 TypeMethod and Description
protected VkMemoryType
public int

Returns:

the value of the VkMemoryType#heapIndex field.
heapIndex
()

public int

Returns:

the value of the VkMemoryType#propertyFlags field.
propertyFlags
()

protected VkMemoryType.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMemoryType ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkMemoryType.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 VkMemoryType#SIZEOF, and its mark will be undefined.

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

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

Method Detail

getElementFactoryback to summary
protected VkMemoryType getElementFactory()

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

Annotations
@Override
heapIndexback to summary
public int heapIndex()
Returns:int

the value of the VkMemoryType#heapIndex field.

Annotations
@NativeType:uint32_t
propertyFlagsback to summary
public int propertyFlags()
Returns:int

the value of the VkMemoryType#propertyFlags field.

Annotations
@NativeType:VkMemoryPropertyFlags
selfback to summary
protected VkMemoryType.Buffer self()

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

Annotations
@Override