Class VkBindImagePlaneMemoryInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBindImagePlaneMemoryInfo>

org.lwjgl.vulkan.VkBindImagePlaneMemoryInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkBindImagePlaneMemoryInfoKHR

public class VkBindImagePlaneMemoryInfo
extends Struct<VkBindImagePlaneMemoryInfo>
implements NativeResource

struct VkBindImagePlaneMemoryInfo {
    VkStructureType sType;
    void const * pNext;
    VkImageAspectFlagBits planeAspect;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

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 Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkBindImagePlaneMemoryInfo	calloc()	Returns a new VkBindImagePlaneMemoryInfo instance allocated with memCalloc.
static VkBindImagePlaneMemoryInfo.Buffer	calloc(int capacity)	Returns a new VkBindImagePlaneMemoryInfo.Buffer instance allocated with memCalloc.
static VkBindImagePlaneMemoryInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkBindImagePlaneMemoryInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindImagePlaneMemoryInfo	calloc(MemoryStack stack)	Returns a new VkBindImagePlaneMemoryInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindImagePlaneMemoryInfo	create()	Returns a new VkBindImagePlaneMemoryInfo instance allocated with BufferUtils.
static VkBindImagePlaneMemoryInfo.Buffer	create(int capacity)	Returns a new VkBindImagePlaneMemoryInfo.Buffer instance allocated with BufferUtils.
static VkBindImagePlaneMemoryInfo	create(long address)	Returns a new VkBindImagePlaneMemoryInfo instance for the specified memory address.
static VkBindImagePlaneMemoryInfo.Buffer	create(long address, int capacity)	Create a VkBindImagePlaneMemoryInfo.Buffer instance at the specified memory.
static @Nullable VkBindImagePlaneMemoryInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkBindImagePlaneMemoryInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkBindImagePlaneMemoryInfo	malloc()	Returns a new VkBindImagePlaneMemoryInfo instance allocated with memAlloc.
static VkBindImagePlaneMemoryInfo.Buffer	malloc(int capacity)	Returns a new VkBindImagePlaneMemoryInfo.Buffer instance allocated with memAlloc.
static VkBindImagePlaneMemoryInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkBindImagePlaneMemoryInfo.Buffer instance allocated on the specified MemoryStack.
static VkBindImagePlaneMemoryInfo	malloc(MemoryStack stack)	Returns a new VkBindImagePlaneMemoryInfo instance allocated on the specified MemoryStack.
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()
VkBindImagePlaneMemoryInfo	planeAspect(int value)	Sets the specified value to the planeAspect field.
long	pNext()
VkBindImagePlaneMemoryInfo	pNext(long value)	Sets the specified value to the pNext field.
VkBindImagePlaneMemoryInfo	set(int sType, long pNext, int planeAspect)	Initializes this struct with the specified values.
VkBindImagePlaneMemoryInfo	set(VkBindImagePlaneMemoryInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkBindImagePlaneMemoryInfo	sType(int value)	Sets the specified value to the sType field.
VkBindImagePlaneMemoryInfo	sType$Default()	Sets the STRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO value to the sType field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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

VkBindImagePlaneMemoryInfo

public VkBindImagePlaneMemoryInfo(ByteBuffer container)

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

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

planeAspect

@NativeType("VkImageAspectFlagBits")
public int planeAspect()

Returns:

the value of the planeAspect field.

sType

public VkBindImagePlaneMemoryInfo sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkBindImagePlaneMemoryInfo sType$Default()

Sets the STRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO value to the sType field.

pNext

public VkBindImagePlaneMemoryInfo pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

planeAspect

public VkBindImagePlaneMemoryInfo planeAspect(@NativeType("VkImageAspectFlagBits")
 int value)

Sets the specified value to the planeAspect field.

set

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

Initializes this struct with the specified values.

set

public VkBindImagePlaneMemoryInfo set(VkBindImagePlaneMemoryInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBindImagePlaneMemoryInfo malloc()

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

calloc

public static VkBindImagePlaneMemoryInfo calloc()

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

create

public static VkBindImagePlaneMemoryInfo create()

Returns a new VkBindImagePlaneMemoryInfo instance allocated with BufferUtils.

create

public static VkBindImagePlaneMemoryInfo create(long address)

Returns a new VkBindImagePlaneMemoryInfo instance for the specified memory address.

createSafe

public static @Nullable VkBindImagePlaneMemoryInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBindImagePlaneMemoryInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBindImagePlaneMemoryInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBindImagePlaneMemoryInfo.Buffer create(int capacity)

Returns a new VkBindImagePlaneMemoryInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkBindImagePlaneMemoryInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkBindImagePlaneMemoryInfo malloc(MemoryStack stack)

Returns a new VkBindImagePlaneMemoryInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkBindImagePlaneMemoryInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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