Package org.lwjgl.vulkan

Class VkImageMemoryRequirementsInfo2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageMemoryRequirementsInfo2>

org.lwjgl.vulkan.VkImageMemoryRequirementsInfo2

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkImageMemoryRequirementsInfo2KHR

public class VkImageMemoryRequirementsInfo2
extends Struct<VkImageMemoryRequirementsInfo2>
implements NativeResource

(None).

Valid Usage

• If image was created with a multi-planar format and the IMAGE_CREATE_DISJOINT_BIT flag, there must be a VkImagePlaneMemoryRequirementsInfo included in the pNext chain of the VkImageMemoryRequirementsInfo2 structure
• If image was created with IMAGE_CREATE_DISJOINT_BIT and with IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then there must be a VkImagePlaneMemoryRequirementsInfo included in the pNext chain of the VkImageMemoryRequirementsInfo2 structure
• If image was not created with the IMAGE_CREATE_DISJOINT_BIT flag, there must not be a VkImagePlaneMemoryRequirementsInfo included in the pNext chain of the VkImageMemoryRequirementsInfo2 structure
• If image was created with a single-plane format and with any tiling other than IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then there must not be a VkImagePlaneMemoryRequirementsInfo included in the pNext chain of the VkImageMemoryRequirementsInfo2 structure
• If image was created with the EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID external memory handle type, then image must be bound to memory

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_MEMORY_REQUIREMENTS_INFO_2
• pNext must be NULL or a pointer to a valid instance of VkImagePlaneMemoryRequirementsInfo
• The sType value of each struct in the pNext chain must be unique
• image must be a valid VkImage handle

See Also

GetImageMemoryRequirements2, GetImageMemoryRequirements2KHR

Layout

 struct VkImageMemoryRequirementsInfo2 {
     VkStructureType sType();
     void const * pNext();
     VkImage image();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageMemoryRequirementsInfo2.Buffer	An array of VkImageMemoryRequirementsInfo2 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	IMAGE	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
VkImageMemoryRequirementsInfo2(ByteBuffer container)	Creates a VkImageMemoryRequirementsInfo2 instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkImageMemoryRequirementsInfo2	calloc()	Returns a new VkImageMemoryRequirementsInfo2 instance allocated with memCalloc.
static VkImageMemoryRequirementsInfo2.Buffer	calloc(int capacity)	Returns a new VkImageMemoryRequirementsInfo2.Buffer instance allocated with memCalloc.
static VkImageMemoryRequirementsInfo2.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkImageMemoryRequirementsInfo2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageMemoryRequirementsInfo2	calloc(MemoryStack stack)	Returns a new VkImageMemoryRequirementsInfo2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageMemoryRequirementsInfo2	callocStack()	Deprecated.
static VkImageMemoryRequirementsInfo2.Buffer	callocStack(int capacity)	Deprecated.
static VkImageMemoryRequirementsInfo2.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageMemoryRequirementsInfo2	callocStack(MemoryStack stack)	Deprecated.
static VkImageMemoryRequirementsInfo2	create()	Returns a new VkImageMemoryRequirementsInfo2 instance allocated with BufferUtils.
static VkImageMemoryRequirementsInfo2.Buffer	create(int capacity)	Returns a new VkImageMemoryRequirementsInfo2.Buffer instance allocated with BufferUtils.
static VkImageMemoryRequirementsInfo2	create(long address)	Returns a new VkImageMemoryRequirementsInfo2 instance for the specified memory address.
static VkImageMemoryRequirementsInfo2.Buffer	create(long address, int capacity)	Create a VkImageMemoryRequirementsInfo2.Buffer instance at the specified memory.
static VkImageMemoryRequirementsInfo2	createSafe(long address)	Like create, but returns null if address is NULL.
static VkImageMemoryRequirementsInfo2.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	image()	the image to query.
VkImageMemoryRequirementsInfo2	image(long value)	Sets the specified value to the image() field.
static VkImageMemoryRequirementsInfo2	malloc()	Returns a new VkImageMemoryRequirementsInfo2 instance allocated with memAlloc.
static VkImageMemoryRequirementsInfo2.Buffer	malloc(int capacity)	Returns a new VkImageMemoryRequirementsInfo2.Buffer instance allocated with memAlloc.
static VkImageMemoryRequirementsInfo2.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkImageMemoryRequirementsInfo2.Buffer instance allocated on the specified MemoryStack.
static VkImageMemoryRequirementsInfo2	malloc(MemoryStack stack)	Returns a new VkImageMemoryRequirementsInfo2 instance allocated on the specified MemoryStack.
static VkImageMemoryRequirementsInfo2	mallocStack()	Deprecated.
static VkImageMemoryRequirementsInfo2.Buffer	mallocStack(int capacity)	Deprecated.
static VkImageMemoryRequirementsInfo2.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkImageMemoryRequirementsInfo2	mallocStack(MemoryStack stack)	Deprecated.
static long	nimage(long struct)	Unsafe version of image().
static void	nimage(long struct, long value)	Unsafe version of image.
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.
VkImageMemoryRequirementsInfo2	pNext(long value)	Sets the specified value to the pNext() field.
VkImageMemoryRequirementsInfo2	pNext(VkImagePlaneMemoryRequirementsInfo value)	Prepends the specified VkImagePlaneMemoryRequirementsInfo value to the pNext chain.
VkImageMemoryRequirementsInfo2	pNext(VkImagePlaneMemoryRequirementsInfoKHR value)	Prepends the specified VkImagePlaneMemoryRequirementsInfoKHR value to the pNext chain.
VkImageMemoryRequirementsInfo2	set(int sType, long pNext, long image)	Initializes this struct with the specified values.
VkImageMemoryRequirementsInfo2	set(VkImageMemoryRequirementsInfo2 src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkImageMemoryRequirementsInfo2	sType(int value)	Sets the specified value to the sType() field.
VkImageMemoryRequirementsInfo2	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_MEMORY_REQUIREMENTS_INFO_2 value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

IMAGE

public static final int IMAGE

The struct member offsets.

Constructor Details

VkImageMemoryRequirementsInfo2

public VkImageMemoryRequirementsInfo2(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

image

public long image()

the image to query.

sType

public VkImageMemoryRequirementsInfo2 sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageMemoryRequirementsInfo2 sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_MEMORY_REQUIREMENTS_INFO_2 value to the sType() field.

pNext

public VkImageMemoryRequirementsInfo2 pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkImageMemoryRequirementsInfo2 pNext(VkImagePlaneMemoryRequirementsInfo value)

Prepends the specified VkImagePlaneMemoryRequirementsInfo value to the pNext chain.

pNext

public VkImageMemoryRequirementsInfo2 pNext(VkImagePlaneMemoryRequirementsInfoKHR value)

Prepends the specified VkImagePlaneMemoryRequirementsInfoKHR value to the pNext chain.

image

public VkImageMemoryRequirementsInfo2 image(long value)

Sets the specified value to the image() field.

set

public VkImageMemoryRequirementsInfo2 set(int sType,
 long pNext,
 long image)

Initializes this struct with the specified values.

set

public VkImageMemoryRequirementsInfo2 set(VkImageMemoryRequirementsInfo2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageMemoryRequirementsInfo2 malloc()

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

calloc

public static VkImageMemoryRequirementsInfo2 calloc()

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

create

public static VkImageMemoryRequirementsInfo2 create()

Returns a new VkImageMemoryRequirementsInfo2 instance allocated with BufferUtils.

create

public static VkImageMemoryRequirementsInfo2 create(long address)

Returns a new VkImageMemoryRequirementsInfo2 instance for the specified memory address.

createSafe

@Nullable
public static VkImageMemoryRequirementsInfo2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageMemoryRequirementsInfo2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageMemoryRequirementsInfo2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageMemoryRequirementsInfo2.Buffer create(int capacity)

Returns a new VkImageMemoryRequirementsInfo2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImageMemoryRequirementsInfo2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImageMemoryRequirementsInfo2 mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImageMemoryRequirementsInfo2 callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkImageMemoryRequirementsInfo2 mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkImageMemoryRequirementsInfo2 callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkImageMemoryRequirementsInfo2 malloc(MemoryStack stack)

Returns a new VkImageMemoryRequirementsInfo2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImageMemoryRequirementsInfo2 calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkImageMemoryRequirementsInfo2.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().

nimage

public static long nimage(long struct)

Unsafe version of image().

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.

nimage

public static void nimage(long struct,
 long value)

Unsafe version of image.