Package org.lwjgl.vulkan

Class VkDeviceImageMemoryRequirements

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDeviceImageMemoryRequirements>

org.lwjgl.vulkan.VkDeviceImageMemoryRequirements

All Implemented Interfaces:

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

Direct Known Subclasses:

VkDeviceImageMemoryRequirementsKHR

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

(None).

Valid Usage

• The pCreateInfo→pNext chain must not contain a VkImageSwapchainCreateInfoKHR structure
• The pCreateInfo→pNext chain must not contain a VkImageDrmFormatModifierExplicitCreateInfoEXT structure
• Applications also must not call GetDeviceImageMemoryRequirements with a VkImageCreateInfo whose pNext chain includes a VkExternalFormatANDROID structure with non-zero externalFormat
• If pCreateInfo→format specifies a multi-planar format and pCreateInfo→flags has IMAGE_CREATE_DISJOINT_BIT set then planeAspect must not be IMAGE_ASPECT_NONE_KHR
• If pCreateInfo→flags has IMAGE_CREATE_DISJOINT_BIT set and if the pCreateInfo→tiling is IMAGE_TILING_LINEAR or IMAGE_TILING_OPTIMAL, then planeAspect must be a single valid multi-planar aspect mask bit
• If pCreateInfo→tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then planeAspect must be a single valid memory plane for the image (that is, aspectMask must specify a plane index that is less than the VkDrmFormatModifierPropertiesEXT::drmFormatModifierPlaneCount associated with the image’s format and VkImageDrmFormatModifierPropertiesEXT::drmFormatModifier)

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEVICE_IMAGE_MEMORY_REQUIREMENTS
• pNext must be NULL
• pCreateInfo must be a valid pointer to a valid VkImageCreateInfo structure
• If planeAspect is not 0, planeAspect must be a valid VkImageAspectFlagBits value

See Also

VkImageCreateInfo, GetDeviceImageMemoryRequirements, GetDeviceImageMemoryRequirementsKHR, GetDeviceImageSparseMemoryRequirements, GetDeviceImageSparseMemoryRequirementsKHR

Layout

 struct VkDeviceImageMemoryRequirements {
     VkStructureType sType();
     void const * pNext();
     VkImageCreateInfo const * pCreateInfo();
     VkImageAspectFlagBits planeAspect();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDeviceImageMemoryRequirements.Buffer	An array of VkDeviceImageMemoryRequirements 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	PCREATEINFO	The struct member offsets.
static final int	PLANEASPECT	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
VkDeviceImageMemoryRequirements(ByteBuffer container)	Creates a VkDeviceImageMemoryRequirements instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDeviceImageMemoryRequirements	calloc()	Returns a new VkDeviceImageMemoryRequirements instance allocated with memCalloc.
static VkDeviceImageMemoryRequirements.Buffer	calloc(int capacity)	Returns a new VkDeviceImageMemoryRequirements.Buffer instance allocated with memCalloc.
static VkDeviceImageMemoryRequirements.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceImageMemoryRequirements.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceImageMemoryRequirements	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceImageMemoryRequirements instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceImageMemoryRequirements	create()	Returns a new VkDeviceImageMemoryRequirements instance allocated with BufferUtils.
static VkDeviceImageMemoryRequirements.Buffer	create(int capacity)	Returns a new VkDeviceImageMemoryRequirements.Buffer instance allocated with BufferUtils.
static VkDeviceImageMemoryRequirements	create(long address)	Returns a new VkDeviceImageMemoryRequirements instance for the specified memory address.
static VkDeviceImageMemoryRequirements.Buffer	create(long address, int capacity)	Create a VkDeviceImageMemoryRequirements.Buffer instance at the specified memory.
static @Nullable VkDeviceImageMemoryRequirements	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDeviceImageMemoryRequirements.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDeviceImageMemoryRequirements	malloc()	Returns a new VkDeviceImageMemoryRequirements instance allocated with memAlloc.
static VkDeviceImageMemoryRequirements.Buffer	malloc(int capacity)	Returns a new VkDeviceImageMemoryRequirements.Buffer instance allocated with memAlloc.
static VkDeviceImageMemoryRequirements.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceImageMemoryRequirements.Buffer instance allocated on the specified MemoryStack.
static VkDeviceImageMemoryRequirements	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceImageMemoryRequirements instance allocated on the specified MemoryStack.
static VkImageCreateInfo	npCreateInfo(long struct)	Unsafe version of pCreateInfo().
static void	npCreateInfo(long struct, VkImageCreateInfo value)	Unsafe version of pCreateInfo.
static int	nplaneAspect(long struct)	Unsafe version of planeAspect().
static void	nplaneAspect(long struct, int value)	Unsafe version of planeAspect.
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.
VkImageCreateInfo	pCreateInfo()	a pointer to a VkImageCreateInfo structure containing parameters affecting creation of the image to query.
VkDeviceImageMemoryRequirements	pCreateInfo(VkImageCreateInfo value)	Sets the address of the specified VkImageCreateInfo to the pCreateInfo() field.
int	planeAspect()	a VkImageAspectFlagBits value specifying the aspect corresponding to the image plane to query.
VkDeviceImageMemoryRequirements	planeAspect(int value)	Sets the specified value to the planeAspect() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDeviceImageMemoryRequirements	pNext(long value)	Sets the specified value to the pNext() field.
VkDeviceImageMemoryRequirements	set(int sType, long pNext, VkImageCreateInfo pCreateInfo, int planeAspect)	Initializes this struct with the specified values.
VkDeviceImageMemoryRequirements	set(VkDeviceImageMemoryRequirements src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDeviceImageMemoryRequirements	sType(int value)	Sets the specified value to the sType() field.
VkDeviceImageMemoryRequirements	sType$Default()	Sets the STRUCTURE_TYPE_DEVICE_IMAGE_MEMORY_REQUIREMENTS value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

PCREATEINFO

public static final int PCREATEINFO

The struct member offsets.

PLANEASPECT

public static final int PLANEASPECT

The struct member offsets.

Constructor Details

VkDeviceImageMemoryRequirements

public VkDeviceImageMemoryRequirements(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

pCreateInfo

public VkImageCreateInfo pCreateInfo()

a pointer to a VkImageCreateInfo structure containing parameters affecting creation of the image to query.

planeAspect

public int planeAspect()

a VkImageAspectFlagBits value specifying the aspect corresponding to the image plane to query. This parameter is ignored unless pCreateInfo→tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, or pCreateInfo→flags has IMAGE_CREATE_DISJOINT_BIT set.

sType

public VkDeviceImageMemoryRequirements sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDeviceImageMemoryRequirements sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_IMAGE_MEMORY_REQUIREMENTS value to the sType() field.

pNext

public VkDeviceImageMemoryRequirements pNext(long value)

Sets the specified value to the pNext() field.

pCreateInfo

public VkDeviceImageMemoryRequirements pCreateInfo(VkImageCreateInfo value)

Sets the address of the specified VkImageCreateInfo to the pCreateInfo() field.

planeAspect

public VkDeviceImageMemoryRequirements planeAspect(int value)

Sets the specified value to the planeAspect() field.

set

public VkDeviceImageMemoryRequirements set(int sType,
 long pNext,
 VkImageCreateInfo pCreateInfo,
 int planeAspect)

Initializes this struct with the specified values.

set

public VkDeviceImageMemoryRequirements set(VkDeviceImageMemoryRequirements src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDeviceImageMemoryRequirements malloc()

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

calloc

public static VkDeviceImageMemoryRequirements calloc()

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

create

public static VkDeviceImageMemoryRequirements create()

Returns a new VkDeviceImageMemoryRequirements instance allocated with BufferUtils.

create

public static VkDeviceImageMemoryRequirements create(long address)

Returns a new VkDeviceImageMemoryRequirements instance for the specified memory address.

createSafe

public static @Nullable VkDeviceImageMemoryRequirements createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDeviceImageMemoryRequirements.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDeviceImageMemoryRequirements.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDeviceImageMemoryRequirements.Buffer create(int capacity)

Returns a new VkDeviceImageMemoryRequirements.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDeviceImageMemoryRequirements.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkDeviceImageMemoryRequirements instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

npCreateInfo

public static VkImageCreateInfo npCreateInfo(long struct)

Unsafe version of pCreateInfo().

nplaneAspect

public static int nplaneAspect(long struct)

Unsafe version of planeAspect().

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.

npCreateInfo

public static void npCreateInfo(long struct,
 VkImageCreateInfo value)

Unsafe version of pCreateInfo.

nplaneAspect

public static void nplaneAspect(long struct,
 int value)

Unsafe version of planeAspect.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate