Package org.lwjgl.vulkan

Class VkMemoryRequirements2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMemoryRequirements2>

org.lwjgl.vulkan.VkMemoryRequirements2

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkMemoryRequirements2KHR

public class VkMemoryRequirements2
extends org.lwjgl.system.Struct<VkMemoryRequirements2>
implements org.lwjgl.system.NativeResource

Structure specifying memory requirements.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2
• pNext must be NULL or a pointer to a valid instance of VkMemoryDedicatedRequirements
• The sType value of each struct in the pNext chain must be unique

See Also

VkMemoryRequirements, GetBufferMemoryRequirements2, GetBufferMemoryRequirements2KHR, GetDeviceBufferMemoryRequirements, GetDeviceBufferMemoryRequirementsKHR, GetDeviceImageMemoryRequirements, GetDeviceImageMemoryRequirementsKHR, GetGeneratedCommandsMemoryRequirementsEXT, GetGeneratedCommandsMemoryRequirementsNV, GetImageMemoryRequirements2, GetImageMemoryRequirements2KHR, GetPipelineIndirectMemoryRequirementsNV

Layout

 struct VkMemoryRequirements2 {
     VkStructureType sType();
     void * pNext();
     VkMemoryRequirements memoryRequirements();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	MEMORYREQUIREMENTS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkMemoryRequirements2	calloc()	Returns a new VkMemoryRequirements2 instance allocated with memCalloc.
static VkMemoryRequirements2.Buffer	calloc(int capacity)	Returns a new VkMemoryRequirements2.Buffer instance allocated with memCalloc.
static VkMemoryRequirements2.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryRequirements2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryRequirements2	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryRequirements2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryRequirements2	callocStack()	Deprecated.
static VkMemoryRequirements2.Buffer	callocStack(int capacity)	Deprecated.
static VkMemoryRequirements2.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryRequirements2	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryRequirements2	create()	Returns a new VkMemoryRequirements2 instance allocated with BufferUtils.
static VkMemoryRequirements2.Buffer	create(int capacity)	Returns a new VkMemoryRequirements2.Buffer instance allocated with BufferUtils.
static VkMemoryRequirements2	create(long address)	Returns a new VkMemoryRequirements2 instance for the specified memory address.
static VkMemoryRequirements2.Buffer	create(long address, int capacity)	Create a VkMemoryRequirements2.Buffer instance at the specified memory.
static @Nullable VkMemoryRequirements2	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkMemoryRequirements2.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkMemoryRequirements2	malloc()	Returns a new VkMemoryRequirements2 instance allocated with memAlloc.
static VkMemoryRequirements2.Buffer	malloc(int capacity)	Returns a new VkMemoryRequirements2.Buffer instance allocated with memAlloc.
static VkMemoryRequirements2.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryRequirements2.Buffer instance allocated on the specified MemoryStack.
static VkMemoryRequirements2	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkMemoryRequirements2 instance allocated on the specified MemoryStack.
static VkMemoryRequirements2	mallocStack()	Deprecated.
static VkMemoryRequirements2.Buffer	mallocStack(int capacity)	Deprecated.
static VkMemoryRequirements2.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkMemoryRequirements2	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
VkMemoryRequirements	memoryRequirements()	a VkMemoryRequirements structure describing the memory requirements of the resource.
static VkMemoryRequirements	nmemoryRequirements(long struct)	Unsafe version of memoryRequirements().
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkMemoryRequirements2	pNext(long value)	Sets the specified value to the pNext() field.
VkMemoryRequirements2	pNext(VkMemoryDedicatedRequirements value)	Prepends the specified VkMemoryDedicatedRequirements value to the pNext chain.
VkMemoryRequirements2	pNext(VkMemoryDedicatedRequirementsKHR value)	Prepends the specified VkMemoryDedicatedRequirementsKHR value to the pNext chain.
VkMemoryRequirements2	set(int sType, long pNext)	Initializes this struct with the specified values.
VkMemoryRequirements2	set(VkMemoryRequirements2 src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkMemoryRequirements2	sType(int value)	Sets the specified value to the sType() field.
VkMemoryRequirements2	sType$Default()	Sets the STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2 value to the sType() field.

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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

MEMORYREQUIREMENTS

public static final int MEMORYREQUIREMENTS

The struct member offsets.

Constructor Details

VkMemoryRequirements2

public VkMemoryRequirements2(ByteBuffer container)

Creates a VkMemoryRequirements2 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()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkMemoryRequirements2>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

memoryRequirements

public VkMemoryRequirements memoryRequirements()

a VkMemoryRequirements structure describing the memory requirements of the resource.

sType

public VkMemoryRequirements2 sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkMemoryRequirements2 sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_REQUIREMENTS_2 value to the sType() field.

pNext

public VkMemoryRequirements2 pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkMemoryRequirements2 pNext(VkMemoryDedicatedRequirements value)

Prepends the specified VkMemoryDedicatedRequirements value to the pNext chain.

pNext

public VkMemoryRequirements2 pNext(VkMemoryDedicatedRequirementsKHR value)

Prepends the specified VkMemoryDedicatedRequirementsKHR value to the pNext chain.

set

public VkMemoryRequirements2 set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkMemoryRequirements2 set(VkMemoryRequirements2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMemoryRequirements2 malloc()

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

calloc

public static VkMemoryRequirements2 calloc()

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

create

public static VkMemoryRequirements2 create()

Returns a new VkMemoryRequirements2 instance allocated with BufferUtils.

create

public static VkMemoryRequirements2 create(long address)

Returns a new VkMemoryRequirements2 instance for the specified memory address.

createSafe

public static @Nullable VkMemoryRequirements2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryRequirements2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkMemoryRequirements2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkMemoryRequirements2.Buffer create(int capacity)

Returns a new VkMemoryRequirements2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkMemoryRequirements2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkMemoryRequirements2 mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkMemoryRequirements2 callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkMemoryRequirements2 mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkMemoryRequirements2 callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkMemoryRequirements2.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkMemoryRequirements2.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkMemoryRequirements2 malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkMemoryRequirements2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkMemoryRequirements2 calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkMemoryRequirements2.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkMemoryRequirements2.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nmemoryRequirements

public static VkMemoryRequirements nmemoryRequirements(long struct)

Unsafe version of memoryRequirements().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.