Package org.lwjgl.vulkan

Class VkPhysicalDeviceMemoryProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceMemoryProperties>

org.lwjgl.vulkan.VkPhysicalDeviceMemoryProperties

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkPhysicalDeviceMemoryProperties
extends Struct<VkPhysicalDeviceMemoryProperties>
implements NativeResource

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

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

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceMemoryProperties	calloc()	Returns a new VkPhysicalDeviceMemoryProperties instance allocated with memCalloc.
static VkPhysicalDeviceMemoryProperties.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceMemoryProperties.Buffer instance allocated with memCalloc.
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.
static VkPhysicalDeviceMemoryProperties	calloc(MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceMemoryProperties	callocStack()	Deprecated.
static VkPhysicalDeviceMemoryProperties.Buffer	callocStack(int capacity)	Deprecated.
static VkPhysicalDeviceMemoryProperties.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkPhysicalDeviceMemoryProperties	callocStack(MemoryStack stack)	Deprecated.
static VkPhysicalDeviceMemoryProperties	create()	Returns a new VkPhysicalDeviceMemoryProperties instance allocated with BufferUtils.
static VkPhysicalDeviceMemoryProperties.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceMemoryProperties.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceMemoryProperties	create(long address)	Returns a new VkPhysicalDeviceMemoryProperties instance for the specified memory address.
static VkPhysicalDeviceMemoryProperties.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceMemoryProperties.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceMemoryProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceMemoryProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceMemoryProperties	malloc()	Returns a new VkPhysicalDeviceMemoryProperties instance allocated with memAlloc.
static VkPhysicalDeviceMemoryProperties.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceMemoryProperties.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceMemoryProperties.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryProperties.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceMemoryProperties	malloc(MemoryStack stack)	Returns a new VkPhysicalDeviceMemoryProperties instance allocated on the specified MemoryStack.
static VkPhysicalDeviceMemoryProperties	mallocStack()	Deprecated.
static VkPhysicalDeviceMemoryProperties.Buffer	mallocStack(int capacity)	Deprecated.
static VkPhysicalDeviceMemoryProperties.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkPhysicalDeviceMemoryProperties	mallocStack(MemoryStack stack)	Deprecated.
int	memoryHeapCount()
VkMemoryHeap.Buffer	memoryHeaps()
VkMemoryHeap	memoryHeaps(int index)
int	memoryTypeCount()
VkMemoryType.Buffer	memoryTypes()
VkMemoryType	memoryTypes(int index)
static int	nmemoryHeapCount(long struct)	Unsafe version of memoryHeapCount().
static VkMemoryHeap.Buffer	nmemoryHeaps(long struct)	Unsafe version of memoryHeaps().
static VkMemoryHeap	nmemoryHeaps(long struct, int index)	Unsafe version of memoryHeaps.
static int	nmemoryTypeCount(long struct)	Unsafe version of memoryTypeCount().
static VkMemoryType.Buffer	nmemoryTypes(long struct)	Unsafe version of memoryTypes().
static VkMemoryType	nmemoryTypes(long struct, int index)	Unsafe version of memoryTypes.
int	sizeof()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

MEMORYTYPECOUNT

public static final int MEMORYTYPECOUNT

The struct member offsets.

MEMORYTYPES

public static final int MEMORYTYPES

The struct member offsets.

MEMORYHEAPCOUNT

public static final int MEMORYHEAPCOUNT

The struct member offsets.

MEMORYHEAPS

public static final int MEMORYHEAPS

The struct member offsets.

Constructor Details

VkPhysicalDeviceMemoryProperties

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkPhysicalDeviceMemoryProperties>

memoryTypeCount

public int memoryTypeCount()

Returns:

the value of the memoryTypeCount field.

memoryTypes

public VkMemoryType.Buffer memoryTypes()

Returns:

a VkMemoryType.Buffer view of the memoryTypes field.

memoryTypes

public VkMemoryType memoryTypes(int index)

Returns:

a VkMemoryType view of the struct at the specified index of the memoryTypes field.

memoryHeapCount

public int memoryHeapCount()

Returns:

the value of the memoryHeapCount field.

memoryHeaps

public VkMemoryHeap.Buffer memoryHeaps()

Returns:

a VkMemoryHeap.Buffer view of the memoryHeaps field.

memoryHeaps

public VkMemoryHeap memoryHeaps(int index)

Returns:

a VkMemoryHeap view of the struct at the specified index of the memoryHeaps field.

malloc

public static VkPhysicalDeviceMemoryProperties malloc()

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

calloc

public static VkPhysicalDeviceMemoryProperties calloc()

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

create

public static VkPhysicalDeviceMemoryProperties create()

Returns a new VkPhysicalDeviceMemoryProperties instance allocated with BufferUtils.

create

public static VkPhysicalDeviceMemoryProperties create(long address)

Returns a new VkPhysicalDeviceMemoryProperties instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceMemoryProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceMemoryProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceMemoryProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceMemoryProperties.Buffer create(int capacity)

Returns a new VkPhysicalDeviceMemoryProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceMemoryProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPhysicalDeviceMemoryProperties mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceMemoryProperties callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceMemoryProperties mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceMemoryProperties callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceMemoryProperties.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceMemoryProperties.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkPhysicalDeviceMemoryProperties malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceMemoryProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

nmemoryTypeCount

public static int nmemoryTypeCount(long struct)

Unsafe version of memoryTypeCount().

nmemoryTypes

public static VkMemoryType.Buffer nmemoryTypes(long struct)

Unsafe version of memoryTypes().

nmemoryTypes

public static VkMemoryType nmemoryTypes(long struct,
 int index)

Unsafe version of memoryTypes.

nmemoryHeapCount

public static int nmemoryHeapCount(long struct)

Unsafe version of memoryHeapCount().

nmemoryHeaps

public static VkMemoryHeap.Buffer nmemoryHeaps(long struct)

Unsafe version of memoryHeaps().

nmemoryHeaps

public static VkMemoryHeap nmemoryHeaps(long struct,
 int index)

Unsafe version of memoryHeaps.