Class VkBindImageMemoryInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkBindImageMemoryInfo>

org.lwjgl.vulkan.VkBindImageMemoryInfo

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkBindImageMemoryInfoKHR

public class VkBindImageMemoryInfo
extends Struct<VkBindImageMemoryInfo>
implements NativeResource

struct VkBindImageMemoryInfo {
    VkStructureType sType;
    void const * pNext;
    VkImage image;
    VkDeviceMemory memory;
    VkDeviceSize memoryOffset;
}

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkBindImageMemoryInfo	calloc()	Returns a new VkBindImageMemoryInfo instance allocated with memCalloc.
static VkBindImageMemoryInfo.Buffer	calloc(int capacity)	Returns a new VkBindImageMemoryInfo.Buffer instance allocated with memCalloc.
static VkBindImageMemoryInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkBindImageMemoryInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindImageMemoryInfo	calloc(MemoryStack stack)	Returns a new VkBindImageMemoryInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkBindImageMemoryInfo	create()	Returns a new VkBindImageMemoryInfo instance allocated with BufferUtils.
static VkBindImageMemoryInfo.Buffer	create(int capacity)	Returns a new VkBindImageMemoryInfo.Buffer instance allocated with BufferUtils.
static VkBindImageMemoryInfo	create(long address)	Returns a new VkBindImageMemoryInfo instance for the specified memory address.
static VkBindImageMemoryInfo.Buffer	create(long address, int capacity)	Create a VkBindImageMemoryInfo.Buffer instance at the specified memory.
static @Nullable VkBindImageMemoryInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkBindImageMemoryInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	image()
VkBindImageMemoryInfo	image(long value)	Sets the specified value to the image field.
static VkBindImageMemoryInfo	malloc()	Returns a new VkBindImageMemoryInfo instance allocated with memAlloc.
static VkBindImageMemoryInfo.Buffer	malloc(int capacity)	Returns a new VkBindImageMemoryInfo.Buffer instance allocated with memAlloc.
static VkBindImageMemoryInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkBindImageMemoryInfo.Buffer instance allocated on the specified MemoryStack.
static VkBindImageMemoryInfo	malloc(MemoryStack stack)	Returns a new VkBindImageMemoryInfo instance allocated on the specified MemoryStack.
long	memory()
VkBindImageMemoryInfo	memory(long value)	Sets the specified value to the memory field.
long	memoryOffset()
VkBindImageMemoryInfo	memoryOffset(long value)	Sets the specified value to the memoryOffset field.
static long	nimage(long struct)	Unsafe version of image().
static void	nimage(long struct, long value)	Unsafe version of image.
static long	nmemory(long struct)	Unsafe version of memory().
static void	nmemory(long struct, long value)	Unsafe version of memory.
static long	nmemoryOffset(long struct)	Unsafe version of memoryOffset().
static void	nmemoryOffset(long struct, long value)	Unsafe version of memoryOffset.
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()
VkBindImageMemoryInfo	pNext(long value)	Sets the specified value to the pNext field.
VkBindImageMemoryInfo	pNext(VkBindImageMemoryDeviceGroupInfo value)	Prepends the specified VkBindImageMemoryDeviceGroupInfo value to the pNext chain.
VkBindImageMemoryInfo	pNext(VkBindImageMemoryDeviceGroupInfoKHR value)	Prepends the specified VkBindImageMemoryDeviceGroupInfoKHR value to the pNext chain.
VkBindImageMemoryInfo	pNext(VkBindImageMemorySwapchainInfoKHR value)	Prepends the specified VkBindImageMemorySwapchainInfoKHR value to the pNext chain.
VkBindImageMemoryInfo	pNext(VkBindImagePlaneMemoryInfo value)	Prepends the specified VkBindImagePlaneMemoryInfo value to the pNext chain.
VkBindImageMemoryInfo	pNext(VkBindImagePlaneMemoryInfoKHR value)	Prepends the specified VkBindImagePlaneMemoryInfoKHR value to the pNext chain.
VkBindImageMemoryInfo	pNext(VkBindMemoryStatus value)	Prepends the specified VkBindMemoryStatus value to the pNext chain.
VkBindImageMemoryInfo	pNext(VkBindMemoryStatusKHR value)	Prepends the specified VkBindMemoryStatusKHR value to the pNext chain.
VkBindImageMemoryInfo	set(int sType, long pNext, long image, long memory, long memoryOffset)	Initializes this struct with the specified values.
VkBindImageMemoryInfo	set(VkBindImageMemoryInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkBindImageMemoryInfo	sType(int value)	Sets the specified value to the sType field.
VkBindImageMemoryInfo	sType$Default()	Sets the STRUCTURE_TYPE_BIND_IMAGE_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.

IMAGE

public static final int IMAGE

The struct member offsets.

MEMORY

public static final int MEMORY

The struct member offsets.

MEMORYOFFSET

public static final int MEMORYOFFSET

The struct member offsets.

Constructor Details

VkBindImageMemoryInfo

public VkBindImageMemoryInfo(ByteBuffer container)

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

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.

image

@NativeType("VkImage")
public long image()

Returns:

the value of the image field.

memory

@NativeType("VkDeviceMemory")
public long memory()

Returns:

the value of the memory field.

memoryOffset

@NativeType("VkDeviceSize")
public long memoryOffset()

Returns:

the value of the memoryOffset field.

sType

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

Sets the specified value to the sType field.

sType$Default

public VkBindImageMemoryInfo sType$Default()

Sets the STRUCTURE_TYPE_BIND_IMAGE_MEMORY_INFO value to the sType field.

pNext

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

Sets the specified value to the pNext field.

pNext

public VkBindImageMemoryInfo pNext(VkBindImageMemoryDeviceGroupInfo value)

Prepends the specified VkBindImageMemoryDeviceGroupInfo value to the pNext chain.

pNext

public VkBindImageMemoryInfo pNext(VkBindImageMemoryDeviceGroupInfoKHR value)

Prepends the specified VkBindImageMemoryDeviceGroupInfoKHR value to the pNext chain.

pNext

public VkBindImageMemoryInfo pNext(VkBindImageMemorySwapchainInfoKHR value)

Prepends the specified VkBindImageMemorySwapchainInfoKHR value to the pNext chain.

pNext

public VkBindImageMemoryInfo pNext(VkBindImagePlaneMemoryInfo value)

Prepends the specified VkBindImagePlaneMemoryInfo value to the pNext chain.

pNext

public VkBindImageMemoryInfo pNext(VkBindImagePlaneMemoryInfoKHR value)

Prepends the specified VkBindImagePlaneMemoryInfoKHR value to the pNext chain.

pNext

public VkBindImageMemoryInfo pNext(VkBindMemoryStatus value)

Prepends the specified VkBindMemoryStatus value to the pNext chain.

pNext

public VkBindImageMemoryInfo pNext(VkBindMemoryStatusKHR value)

Prepends the specified VkBindMemoryStatusKHR value to the pNext chain.

image

public VkBindImageMemoryInfo image(@NativeType("VkImage")
 long value)

Sets the specified value to the image field.

memory

public VkBindImageMemoryInfo memory(@NativeType("VkDeviceMemory")
 long value)

Sets the specified value to the memory field.

memoryOffset

public VkBindImageMemoryInfo memoryOffset(@NativeType("VkDeviceSize")
 long value)

Sets the specified value to the memoryOffset field.

set

public VkBindImageMemoryInfo set(int sType,
 long pNext,
 long image,
 long memory,
 long memoryOffset)

Initializes this struct with the specified values.

set

public VkBindImageMemoryInfo set(VkBindImageMemoryInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkBindImageMemoryInfo malloc()

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

calloc

public static VkBindImageMemoryInfo calloc()

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

create

public static VkBindImageMemoryInfo create()

Returns a new VkBindImageMemoryInfo instance allocated with BufferUtils.

create

public static VkBindImageMemoryInfo create(long address)

Returns a new VkBindImageMemoryInfo instance for the specified memory address.

createSafe

public static @Nullable VkBindImageMemoryInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkBindImageMemoryInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkBindImageMemoryInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkBindImageMemoryInfo.Buffer create(int capacity)

Returns a new VkBindImageMemoryInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkBindImageMemoryInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkBindImageMemoryInfo malloc(MemoryStack stack)

Returns a new VkBindImageMemoryInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkBindImageMemoryInfo calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmemory

public static long nmemory(long struct)

Unsafe version of memory().

nmemoryOffset

public static long nmemoryOffset(long struct)

Unsafe version of memoryOffset().

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.

nmemory

public static void nmemory(long struct,
 long value)

Unsafe version of memory.

nmemoryOffset

public static void nmemoryOffset(long struct,
 long value)

Unsafe version of memoryOffset.