Package org.lwjgl.vulkan

Class VkImagePlaneMemoryRequirementsInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImagePlaneMemoryRequirementsInfo>

org.lwjgl.vulkan.VkImagePlaneMemoryRequirementsInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkImagePlaneMemoryRequirementsInfoKHR

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

Structure specifying image plane for memory requirements.

Valid Usage

• If the image’s tiling is IMAGE_TILING_LINEAR or IMAGE_TILING_OPTIMAL, then planeAspect must be a single valid multi-planar aspect mask bit
• If the image’s 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_IMAGE_PLANE_MEMORY_REQUIREMENTS_INFO
• planeAspect must be a valid VkImageAspectFlagBits value

Layout

 struct VkImagePlaneMemoryRequirementsInfo {
     VkStructureType sType();
     void const * pNext();
     VkImageAspectFlagBits planeAspect();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkImagePlaneMemoryRequirementsInfo	calloc()	Returns a new VkImagePlaneMemoryRequirementsInfo instance allocated with memCalloc.
static VkImagePlaneMemoryRequirementsInfo.Buffer	calloc(int capacity)	Returns a new VkImagePlaneMemoryRequirementsInfo.Buffer instance allocated with memCalloc.
static VkImagePlaneMemoryRequirementsInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImagePlaneMemoryRequirementsInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImagePlaneMemoryRequirementsInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImagePlaneMemoryRequirementsInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImagePlaneMemoryRequirementsInfo	callocStack()	Deprecated.
static VkImagePlaneMemoryRequirementsInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkImagePlaneMemoryRequirementsInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImagePlaneMemoryRequirementsInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImagePlaneMemoryRequirementsInfo	create()	Returns a new VkImagePlaneMemoryRequirementsInfo instance allocated with BufferUtils.
static VkImagePlaneMemoryRequirementsInfo.Buffer	create(int capacity)	Returns a new VkImagePlaneMemoryRequirementsInfo.Buffer instance allocated with BufferUtils.
static VkImagePlaneMemoryRequirementsInfo	create(long address)	Returns a new VkImagePlaneMemoryRequirementsInfo instance for the specified memory address.
static VkImagePlaneMemoryRequirementsInfo.Buffer	create(long address, int capacity)	Create a VkImagePlaneMemoryRequirementsInfo.Buffer instance at the specified memory.
static @Nullable VkImagePlaneMemoryRequirementsInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImagePlaneMemoryRequirementsInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkImagePlaneMemoryRequirementsInfo	malloc()	Returns a new VkImagePlaneMemoryRequirementsInfo instance allocated with memAlloc.
static VkImagePlaneMemoryRequirementsInfo.Buffer	malloc(int capacity)	Returns a new VkImagePlaneMemoryRequirementsInfo.Buffer instance allocated with memAlloc.
static VkImagePlaneMemoryRequirementsInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImagePlaneMemoryRequirementsInfo.Buffer instance allocated on the specified MemoryStack.
static VkImagePlaneMemoryRequirementsInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImagePlaneMemoryRequirementsInfo instance allocated on the specified MemoryStack.
static VkImagePlaneMemoryRequirementsInfo	mallocStack()	Deprecated.
static VkImagePlaneMemoryRequirementsInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkImagePlaneMemoryRequirementsInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkImagePlaneMemoryRequirementsInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
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.
int	planeAspect()	a VkImageAspectFlagBits value specifying the aspect corresponding to the image plane to query.
VkImagePlaneMemoryRequirementsInfo	planeAspect(int value)	Sets the specified value to the planeAspect() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkImagePlaneMemoryRequirementsInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkImagePlaneMemoryRequirementsInfo	set(int sType, long pNext, int planeAspect)	Initializes this struct with the specified values.
VkImagePlaneMemoryRequirementsInfo	set(VkImagePlaneMemoryRequirementsInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkImagePlaneMemoryRequirementsInfo	sType(int value)	Sets the specified value to the sType() field.
VkImagePlaneMemoryRequirementsInfo	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_PLANE_MEMORY_REQUIREMENTS_INFO 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.

PLANEASPECT

public static final int PLANEASPECT

The struct member offsets.

Constructor Details

VkImagePlaneMemoryRequirementsInfo

public VkImagePlaneMemoryRequirementsInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

planeAspect

public int planeAspect()

a VkImageAspectFlagBits value specifying the aspect corresponding to the image plane to query.

sType

public VkImagePlaneMemoryRequirementsInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImagePlaneMemoryRequirementsInfo sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_PLANE_MEMORY_REQUIREMENTS_INFO value to the sType() field.

pNext

public VkImagePlaneMemoryRequirementsInfo pNext(long value)

Sets the specified value to the pNext() field.

planeAspect

public VkImagePlaneMemoryRequirementsInfo planeAspect(int value)

Sets the specified value to the planeAspect() field.

set

public VkImagePlaneMemoryRequirementsInfo set(int sType,
 long pNext,
 int planeAspect)

Initializes this struct with the specified values.

set

public VkImagePlaneMemoryRequirementsInfo set(VkImagePlaneMemoryRequirementsInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImagePlaneMemoryRequirementsInfo malloc()

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

calloc

public static VkImagePlaneMemoryRequirementsInfo calloc()

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

create

public static VkImagePlaneMemoryRequirementsInfo create()

Returns a new VkImagePlaneMemoryRequirementsInfo instance allocated with BufferUtils.

create

public static VkImagePlaneMemoryRequirementsInfo create(long address)

Returns a new VkImagePlaneMemoryRequirementsInfo instance for the specified memory address.

createSafe

public static @Nullable VkImagePlaneMemoryRequirementsInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImagePlaneMemoryRequirementsInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImagePlaneMemoryRequirementsInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImagePlaneMemoryRequirementsInfo.Buffer create(int capacity)

Returns a new VkImagePlaneMemoryRequirementsInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkImagePlaneMemoryRequirementsInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkImagePlaneMemoryRequirementsInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkImagePlaneMemoryRequirementsInfo callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkImagePlaneMemoryRequirementsInfo.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 VkImagePlaneMemoryRequirementsInfo.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 VkImagePlaneMemoryRequirementsInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkImagePlaneMemoryRequirementsInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

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.

nplaneAspect

public static void nplaneAspect(long struct,
 int value)

Unsafe version of planeAspect.