Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMemoryRequirements

extends Struct<VkMemoryRequirements>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying memory requirements.
See Also

VkMemoryRequirements2, VkVideoSessionMemoryRequirementsKHR, GetBufferMemoryRequirements, GetImageMemoryRequirements

Layout


struct VkMemoryRequirements {
    VkDeviceSize size;
    VkDeviceSize alignment;
    uint32_t memoryTypeBits;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNMENT

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MEMORYTYPEBITS

The struct member offsets.

public static final int
SIZE

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
VkMemoryRequirements(long address, ByteBuffer container)

public
VkMemoryRequirements(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
alignment()

the alignment, in bytes, of the offset within the allocation required for the resource.

public static VkMemoryRequirements
calloc()

Returns a new VkMemoryRequirements instance allocated with memCalloc.

public static VkMemoryRequirements.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkMemoryRequirements.Buffer instance allocated with memCalloc.

public static VkMemoryRequirements
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkMemoryRequirements.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkMemoryRequirements
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryRequirements
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryRequirements.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryRequirements.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkMemoryRequirements
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 VkMemoryRequirements
create()

Returns a new VkMemoryRequirements instance allocated with BufferUtils.

public static VkMemoryRequirements
create(long address)

Returns a new VkMemoryRequirements instance for the specified memory address.

public static VkMemoryRequirements.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkMemoryRequirements.Buffer instance allocated with BufferUtils.

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

Create a VkMemoryRequirements.Buffer instance at the specified memory.

public static VkMemoryRequirements
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkMemoryRequirements
malloc()

Returns a new VkMemoryRequirements instance allocated with memAlloc.

public static VkMemoryRequirements.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkMemoryRequirements.Buffer instance allocated with memAlloc.

public static VkMemoryRequirements
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkMemoryRequirements instance allocated on the specified MemoryStack.

public static VkMemoryRequirements.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkMemoryRequirements
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryRequirements
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryRequirements.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMemoryRequirements.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public int
memoryTypeBits()

a bitmask and contains one bit set for every supported memory type for the resource.

public static long
nalignment(long struct)

Unsafe version of alignment.

public static int
nmemoryTypeBits(long struct)

Unsafe version of memoryTypeBits.

public static long
nsize(long struct)

Unsafe version of size.

public long
size()

the size, in bytes, of the memory allocation required for the resource.

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

ALIGNMENTback to summary
public static final int ALIGNMENT

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

MEMORYTYPEBITSback to summary
public static final int MEMORYTYPEBITS

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkMemoryRequirementsback to summary
protected VkMemoryRequirements(long address, ByteBuffer container)
VkMemoryRequirementsback to summary
public VkMemoryRequirements(ByteBuffer container)

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

alignmentback to summary
public long alignment()

the alignment, in bytes, of the offset within the allocation required for the resource.

Annotations
@NativeType:VkDeviceSize
callocback to summary
public static VkMemoryRequirements calloc()

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

callocback to summary
public static VkMemoryRequirements.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkMemoryRequirements calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkMemoryRequirements.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkMemoryRequirements.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

callocStackback to summary
public static VkMemoryRequirements callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMemoryRequirements callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMemoryRequirements.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkMemoryRequirements.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkMemoryRequirements 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 VkMemoryRequirements create()

Returns a new VkMemoryRequirements instance allocated with BufferUtils.

createback to summary
public static VkMemoryRequirements create(long address)

Returns a new VkMemoryRequirements instance for the specified memory address.

createback to summary
public static VkMemoryRequirements.Buffer create(int capacity)

Returns a new VkMemoryRequirements.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkMemoryRequirements.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMemoryRequirements createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkMemoryRequirements malloc()

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

mallocback to summary
public static VkMemoryRequirements.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMemoryRequirements malloc(MemoryStack stack)

Returns a new VkMemoryRequirements instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkMemoryRequirements.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkMemoryRequirements mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMemoryRequirements mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMemoryRequirements.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkMemoryRequirements.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
memoryTypeBitsback to summary
public int memoryTypeBits()

a bitmask and contains one bit set for every supported memory type for the resource. Bit i is set if and only if the memory type i in the VkPhysicalDeviceMemoryProperties structure for the physical device is supported for the resource.

Annotations
@NativeType:uint32_t
nalignmentback to summary
public static long nalignment(long struct)

Unsafe version of alignment.

nmemoryTypeBitsback to summary
public static int nmemoryTypeBits(long struct)

Unsafe version of memoryTypeBits.

nsizeback to summary
public static long nsize(long struct)

Unsafe version of size.

sizeback to summary
public long size()

the size, in bytes, of the memory allocation required for the resource.

Annotations
@NativeType:VkDeviceSize
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 VkMemoryRequirements.Buffer

extends StructBuffer<VkMemoryRequirements, VkMemoryRequirements.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkMemoryRequirements structs.

Field Summary

Modifier and TypeField and Description
private static final VkMemoryRequirements

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMemoryRequirements.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
public long

Returns:

the value of the VkMemoryRequirements#alignment field.
alignment
()

protected VkMemoryRequirements
public int

Returns:

the value of the VkMemoryRequirements#memoryTypeBits field.
memoryTypeBits
()

protected VkMemoryRequirements.Buffer
public long

Returns:

the value of the VkMemoryRequirements#size field.
size
()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMemoryRequirements ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

alignmentback to summary
public long alignment()
Returns:long

the value of the VkMemoryRequirements#alignment field.

Annotations
@NativeType:VkDeviceSize
getElementFactoryback to summary
protected VkMemoryRequirements getElementFactory()

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

Annotations
@Override
memoryTypeBitsback to summary
public int memoryTypeBits()
Returns:int

the value of the VkMemoryRequirements#memoryTypeBits field.

Annotations
@NativeType:uint32_t
selfback to summary
protected VkMemoryRequirements.Buffer self()

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

Annotations
@Override
sizeback to summary
public long size()
Returns:long

the value of the VkMemoryRequirements#size field.

Annotations
@NativeType:VkDeviceSize