Structure specifying physical device memory properties.

Description

The VkPhysicalDeviceMemoryProperties structure describes a number of memory heaps as well as a number of memory types that can be used to access memory allocated in those heaps. Each heap describes a memory resource of a particular size, and each memory type describes a set of memory properties (e.g. host cached vs. uncached) that can be used with a given memory heap. Allocations using a particular memory type will consume resources from the heap indicated by that memory type’s heap index. More than one memory type may share each heap, and the heaps and memory types provide a mechanism to advertise an accurate size of the physical memory resources while allowing the memory to be used with a variety of different properties.

The number of memory heaps is given by memoryHeapCount and is less than or equal to MAX_MEMORY_HEAPS. Each heap is described by an element of the memoryHeaps array as a VkMemoryHeap structure. The number of memory types available across all memory heaps is given by memoryTypeCount and is less than or equal to MAX_MEMORY_TYPES. Each memory type is described by an element of the memoryTypes array as a VkMemoryType structure.

At least one heap must include MEMORY_HEAP_DEVICE_LOCAL_BIT in VkMemoryHeap::flags. If there are multiple heaps that all have similar performance characteristics, they may all include MEMORY_HEAP_DEVICE_LOCAL_BIT. In a unified memory architecture (UMA) system there is often only a single memory heap which is considered to be equally “local” to the host and to the device, and such an implementation must advertise the heap as device-local.

Each memory type returned by GetPhysicalDeviceMemoryProperties must have its propertyFlags set to one of the following values:

There must be at least one memory type with both the MEMORY_PROPERTY_HOST_VISIBLE_BIT and MEMORY_PROPERTY_HOST_COHERENT_BIT bits set in its propertyFlags. There must be at least one memory type with the MEMORY_PROPERTY_DEVICE_LOCAL_BIT bit set in its propertyFlags. If the deviceCoherentMemory feature is enabled, there must be at least one memory type with the MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD bit set in its propertyFlags.

For each pair of elements X and Y returned in memoryTypes, X must be placed at a lower index position than Y if:

the set of bit flags returned in the propertyFlags member of X is a strict subset of the set of bit flags returned in the propertyFlags member of Y; or
the propertyFlags members of X and Y are equal, and X belongs to a memory heap with greater performance (as determined in an implementation-specific manner) ; or
the propertyFlags members of Y includes MEMORY_PROPERTY_DEVICE_COHERENT_BIT_AMD or MEMORY_PROPERTY_DEVICE_UNCACHED_BIT_AMD and X does not

Note

There is no ordering requirement between X and Y elements for the case their propertyFlags members are not in a subset relation. That potentially allows more than one possible way to order the same set of memory types. Notice that the list of all allowed memory property flag combinations is written in a valid order. But if instead MEMORY_PROPERTY_DEVICE_LOCAL_BIT was before MEMORY_PROPERTY_HOST_VISIBLE_BIT | MEMORY_PROPERTY_HOST_COHERENT_BIT, the list would still be in a valid order.

There may be a performance penalty for using device coherent or uncached device memory types, and using these accidentally is undesirable. In order to avoid this, memory types with these properties always appear at the end of the list; but are subject to the same rules otherwise.

This ordering requirement enables applications to use a simple search loop to select the desired memory type along the lines of:


// Find a memory in `memoryTypeBitsRequirement` that includes all of `requiredProperties`
int32_t findProperties(const VkPhysicalDeviceMemoryProperties* pMemoryProperties,
                       uint32_t memoryTypeBitsRequirement,
                       VkMemoryPropertyFlags requiredProperties) {
    const uint32_t memoryCount = pMemoryProperties->memoryTypeCount;
    for (uint32_t memoryIndex = 0; memoryIndex < memoryCount; ++memoryIndex) {
        const uint32_t memoryTypeBits = (1 << memoryIndex);
        const bool isRequiredMemoryType = memoryTypeBitsRequirement & memoryTypeBits;

        const VkMemoryPropertyFlags properties =
            pMemoryProperties->memoryTypes[memoryIndex].propertyFlags;
        const bool hasRequiredProperties =
            (properties & requiredProperties) == requiredProperties;

        if (isRequiredMemoryType && hasRequiredProperties)
            return static_cast<int32_t>(memoryIndex);
    }

    // failed to find memory type
    return -1;
}

// Try to find an optimal memory type, or if it does not exist try fallback memory type
// `device` is the VkDevice
// `image` is the VkImage that requires memory to be bound
// `memoryProperties` properties as returned by vkGetPhysicalDeviceMemoryProperties
// `requiredProperties` are the property flags that must be present
// `optimalProperties` are the property flags that are preferred by the application
VkMemoryRequirements memoryRequirements;
vkGetImageMemoryRequirements(device, image, &memoryRequirements);
int32_t memoryType =
    findProperties(&memoryProperties, memoryRequirements.memoryTypeBits, optimalProperties);
if (memoryType == -1) // not found; try fallback properties
    memoryType =
        findProperties(&memoryProperties, memoryRequirements.memoryTypeBits, requiredProperties);

Layout


struct VkPhysicalDeviceMemoryProperties {
    uint32_t memoryTypeCount;
    VkMemoryType memoryTypes[VK_MAX_MEMORY_TYPES];
    uint32_t memoryHeapCount;
    VkMemoryHeap memoryHeaps[VK_MAX_MEMORY_HEAPS];
}

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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	MEMORYHEAPCOUNT The struct member offsets.
public static final int	MEMORYHEAPS The struct member offsets.
public static final int	MEMORYTYPECOUNT The struct member offsets.
public static final int	MEMORYTYPES The struct member offsets.
public static final int	SIZEOF The struct size in bytes.

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

Method Summary

Modifier and Type	Method and Description
public static VkPhysicalDeviceMemoryProperties	calloc() Returns a new `VkPhysicalDeviceMemoryProperties` instance allocated with `memCalloc`.
public static VkPhysicalDeviceMemoryProperties.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkPhysicalDeviceMemoryProperties.Buffer` instance allocated with `memCalloc`.
public static VkPhysicalDeviceMemoryProperties	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPhysicalDeviceMemoryProperties` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPhysicalDeviceMemoryProperties.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPhysicalDeviceMemoryProperties.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPhysicalDeviceMemoryProperties	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceMemoryProperties	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceMemoryProperties.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceMemoryProperties.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkPhysicalDeviceMemoryProperties	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 VkPhysicalDeviceMemoryProperties	create() Returns a new `VkPhysicalDeviceMemoryProperties` instance allocated with `BufferUtils`.
public static VkPhysicalDeviceMemoryProperties	create(long address) Returns a new `VkPhysicalDeviceMemoryProperties` instance for the specified memory address.
public static VkPhysicalDeviceMemoryProperties.Buffer	create(int the buffer capacity capacity) Returns a new `VkPhysicalDeviceMemoryProperties.Buffer` instance allocated with `BufferUtils`.
public static VkPhysicalDeviceMemoryProperties.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkPhysicalDeviceMemoryProperties.Buffer` instance at the specified memory.
public static VkPhysicalDeviceMemoryProperties	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkPhysicalDeviceMemoryProperties.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static VkPhysicalDeviceMemoryProperties	malloc() Returns a new `VkPhysicalDeviceMemoryProperties` instance allocated with `memAlloc`.
public static VkPhysicalDeviceMemoryProperties.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkPhysicalDeviceMemoryProperties.Buffer` instance allocated with `memAlloc`.
public static VkPhysicalDeviceMemoryProperties	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPhysicalDeviceMemoryProperties` instance allocated on the specified `MemoryStack`.
public static VkPhysicalDeviceMemoryProperties.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPhysicalDeviceMemoryProperties.Buffer` instance allocated on the specified `MemoryStack`.
public static VkPhysicalDeviceMemoryProperties	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceMemoryProperties	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceMemoryProperties.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPhysicalDeviceMemoryProperties.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public int	memoryHeapCount() the number of valid elements in the `memoryHeaps` array.
public VkMemoryHeap.Buffer	memoryHeaps() an array of `MAX_MEMORY_HEAPS` `VkMemoryHeap` structures describing the memory heaps from which memory can be allocated.
public VkMemoryHeap	memoryHeaps(int index) an array of `MAX_MEMORY_HEAPS` `VkMemoryHeap` structures describing the memory heaps from which memory can be allocated.
public int	memoryTypeCount() the number of valid elements in the `memoryTypes` array.
public VkMemoryType.Buffer	memoryTypes() an array of `MAX_MEMORY_TYPES` `VkMemoryType` structures describing the memory types that can be used to access memory allocated from the heaps specified by `memoryHeaps`.
public VkMemoryType	memoryTypes(int index) an array of `MAX_MEMORY_TYPES` `VkMemoryType` structures describing the memory types that can be used to access memory allocated from the heaps specified by `memoryHeaps`.
public static int	nmemoryHeapCount(long struct) Unsafe version of `memoryHeapCount`.
public static VkMemoryHeap.Buffer	nmemoryHeaps(long struct) Unsafe version of `memoryHeaps`.
public static VkMemoryHeap	nmemoryHeaps(long struct, int index) Unsafe version of `memoryHeaps`.
public static int	nmemoryTypeCount(long struct) Unsafe version of `memoryTypeCount`.
public static VkMemoryType.Buffer	nmemoryTypes(long struct) Unsafe version of `memoryTypes`.
public static VkMemoryType	nmemoryTypes(long struct, int index) Unsafe version of `memoryTypes`.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.

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

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

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

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

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

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

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

VkPhysicalDeviceMemoryProperties	back to summary
public VkPhysicalDeviceMemoryProperties(ByteBuffer container) Creates a `VkPhysicalDeviceMemoryProperties` 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

calloc	back to summary
public static VkPhysicalDeviceMemoryProperties calloc() Returns a new `VkPhysicalDeviceMemoryProperties` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkPhysicalDeviceMemoryProperties.Buffer calloc(int capacity) Returns a new `VkPhysicalDeviceMemoryProperties.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkPhysicalDeviceMemoryProperties.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkPhysicalDeviceMemoryProperties calloc(MemoryStack stack) Returns a new `VkPhysicalDeviceMemoryProperties` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkPhysicalDeviceMemoryProperties calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkPhysicalDeviceMemoryProperties.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkPhysicalDeviceMemoryProperties.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

callocStack back to summary

callocStack	back to summary
public static VkPhysicalDeviceMemoryProperties callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkPhysicalDeviceMemoryProperties callocStack()

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkPhysicalDeviceMemoryProperties callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkPhysicalDeviceMemoryProperties callocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkPhysicalDeviceMemoryProperties.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkPhysicalDeviceMemoryProperties.Buffer callocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkPhysicalDeviceMemoryProperties.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkPhysicalDeviceMemoryProperties.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkPhysicalDeviceMemoryProperties 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 VkPhysicalDeviceMemoryProperties 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 VkPhysicalDeviceMemoryProperties create() Returns a new `VkPhysicalDeviceMemoryProperties` instance allocated with `BufferUtils`.

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

create back to summary

create	back to summary
public static VkPhysicalDeviceMemoryProperties.Buffer create(int capacity) Returns a new `VkPhysicalDeviceMemoryProperties.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkPhysicalDeviceMemoryProperties.Buffer create(int capacity)

Returns a new VkPhysicalDeviceMemoryProperties.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

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

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

Create a VkPhysicalDeviceMemoryProperties.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 VkPhysicalDeviceMemoryProperties createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkPhysicalDeviceMemoryProperties createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

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

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static VkPhysicalDeviceMemoryProperties malloc() Returns a new `VkPhysicalDeviceMemoryProperties` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkPhysicalDeviceMemoryProperties.Buffer malloc(int capacity) Returns a new `VkPhysicalDeviceMemoryProperties.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkPhysicalDeviceMemoryProperties.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkPhysicalDeviceMemoryProperties malloc(MemoryStack stack) Returns a new `VkPhysicalDeviceMemoryProperties` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkPhysicalDeviceMemoryProperties malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceMemoryProperties instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkPhysicalDeviceMemoryProperties.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkPhysicalDeviceMemoryProperties.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

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

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static VkPhysicalDeviceMemoryProperties mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkPhysicalDeviceMemoryProperties mallocStack()

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkPhysicalDeviceMemoryProperties mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkPhysicalDeviceMemoryProperties mallocStack(MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkPhysicalDeviceMemoryProperties.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkPhysicalDeviceMemoryProperties.Buffer mallocStack(int capacity)

Deprecated

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

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkPhysicalDeviceMemoryProperties.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkPhysicalDeviceMemoryProperties.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations

@Deprecated

memoryHeapCount back to summary

memoryHeapCount	back to summary
public int memoryHeapCount() the number of valid elements in the `memoryHeaps` array. Annotations @NativeType:uint32_t

public int memoryHeapCount()

the number of valid elements in the memoryHeaps array.

Annotations

@NativeType:uint32_t

memoryHeaps back to summary

memoryHeaps	back to summary
public VkMemoryHeap.Buffer memoryHeaps() an array of `MAX_MEMORY_HEAPS` `VkMemoryHeap` structures describing the memory heaps from which memory can be allocated. Annotations @NativeType:VkMemoryHeap[VK_MAX_MEMORY_HEAPS]

public VkMemoryHeap.Buffer memoryHeaps()

an array of MAX_MEMORY_HEAPS VkMemoryHeap structures describing the memory heaps from which memory can be allocated.

Annotations

@NativeType:VkMemoryHeap[VK_MAX_MEMORY_HEAPS]

memoryHeaps	back to summary
public VkMemoryHeap memoryHeaps(int index) an array of `MAX_MEMORY_HEAPS` `VkMemoryHeap` structures describing the memory heaps from which memory can be allocated.

memoryTypeCount back to summary

memoryTypeCount	back to summary
public int memoryTypeCount() the number of valid elements in the `memoryTypes` array. Annotations @NativeType:uint32_t

public int memoryTypeCount()

the number of valid elements in the memoryTypes array.

Annotations

@NativeType:uint32_t

memoryTypes back to summary

memoryTypes	back to summary
public VkMemoryType.Buffer memoryTypes() an array of `MAX_MEMORY_TYPES` `VkMemoryType` structures describing the memory types that can be used to access memory allocated from the heaps specified by `memoryHeaps`. Annotations @NativeType:VkMemoryType[VK_MAX_MEMORY_TYPES]

public VkMemoryType.Buffer memoryTypes()

an array of MAX_MEMORY_TYPES VkMemoryType structures describing the memory types that can be used to access memory allocated from the heaps specified by memoryHeaps.

Annotations

@NativeType:VkMemoryType[VK_MAX_MEMORY_TYPES]

memoryTypes	back to summary
public VkMemoryType memoryTypes(int index) an array of `MAX_MEMORY_TYPES` `VkMemoryType` structures describing the memory types that can be used to access memory allocated from the heaps specified by `memoryHeaps`.

nmemoryHeapCount	back to summary
public static int nmemoryHeapCount(long struct) Unsafe version of `memoryHeapCount`.

nmemoryHeaps	back to summary
public static VkMemoryHeap.Buffer nmemoryHeaps(long struct) Unsafe version of `memoryHeaps`.

nmemoryHeaps	back to summary
public static VkMemoryHeap nmemoryHeaps(long struct, int index) Unsafe version of `memoryHeaps`.

nmemoryTypeCount	back to summary
public static int nmemoryTypeCount(long struct) Unsafe version of `memoryTypeCount`.

nmemoryTypes	back to summary
public static VkMemoryType.Buffer nmemoryTypes(long struct) Unsafe version of `memoryTypes`.

nmemoryTypes	back to summary
public static VkMemoryType nmemoryTypes(long struct, int index) Unsafe version of `memoryTypes`.

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 VkPhysicalDeviceMemoryProperties.Buffer

Class Inheritance

extends StructBuffer<VkPhysicalDeviceMemoryProperties, VkPhysicalDeviceMemoryProperties.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkPhysicalDeviceMemoryProperties.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkPhysicalDeviceMemoryProperties structs.

Field Summary

Modifier and Type	Field and Description
private static final VkPhysicalDeviceMemoryProperties	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkPhysicalDeviceMemoryProperties.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
protected VkPhysicalDeviceMemoryProperties	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public int	Returns: the value of the `VkPhysicalDeviceMemoryProperties#memoryHeapCount` field. memoryHeapCount()
public VkMemoryHeap.Buffer	Returns: a `VkMemoryHeap`.Buffer view of the `VkPhysicalDeviceMemoryProperties#memoryHeaps` field. memoryHeaps()
public VkMemoryHeap	Returns: a `VkMemoryHeap` view of the struct at the specified index of the `VkPhysicalDeviceMemoryProperties#memoryHeaps` field. memoryHeaps(int index)
public int	Returns: the value of the `VkPhysicalDeviceMemoryProperties#memoryTypeCount` field. memoryTypeCount()
public VkMemoryType.Buffer	Returns: a `VkMemoryType`.Buffer view of the `VkPhysicalDeviceMemoryProperties#memoryTypes` field. memoryTypes()
public VkMemoryType	Returns: a `VkMemoryType` view of the struct at the specified index of the `VkPhysicalDeviceMemoryProperties#memoryTypes` field. memoryTypes(int index)
protected VkPhysicalDeviceMemoryProperties.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.

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 VkPhysicalDeviceMemoryProperties ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceMemoryProperties.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 VkPhysicalDeviceMemoryProperties#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

getElementFactory

back to summary

protected VkPhysicalDeviceMemoryProperties getElementFactory()

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

Annotations

@Override

memoryHeapCount	back to summary
public int memoryHeapCount() Returns:int the value of the `VkPhysicalDeviceMemoryProperties#memoryHeapCount` field. Annotations @NativeType:uint32_t

memoryHeaps	back to summary
public VkMemoryHeap.Buffer memoryHeaps() Returns:VkMemoryHeap.Buffer a `VkMemoryHeap`.Buffer view of the `VkPhysicalDeviceMemoryProperties#memoryHeaps` field. Annotations @NativeType:VkMemoryHeap[VK_MAX_MEMORY_HEAPS]

memoryHeaps	back to summary
public VkMemoryHeap memoryHeaps(int index) Returns:VkMemoryHeap a `VkMemoryHeap` view of the struct at the specified index of the `VkPhysicalDeviceMemoryProperties#memoryHeaps` field.

memoryTypeCount	back to summary
public int memoryTypeCount() Returns:int the value of the `VkPhysicalDeviceMemoryProperties#memoryTypeCount` field. Annotations @NativeType:uint32_t

memoryTypes	back to summary
public VkMemoryType.Buffer memoryTypes() Returns:VkMemoryType.Buffer a `VkMemoryType`.Buffer view of the `VkPhysicalDeviceMemoryProperties#memoryTypes` field. Annotations @NativeType:VkMemoryType[VK_MAX_MEMORY_TYPES]

memoryTypes	back to summary
public VkMemoryType memoryTypes(int index) Returns:VkMemoryType a `VkMemoryType` view of the struct at the specified index of the `VkPhysicalDeviceMemoryProperties#memoryTypes` field.