Package org.lwjgl.vulkan

Class VkSparseImageMemoryBind

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSparseImageMemoryBind>

org.lwjgl.vulkan.VkSparseImageMemoryBind

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkSparseImageMemoryBind
extends Struct<VkSparseImageMemoryBind>
implements NativeResource

 struct VkSparseImageMemoryBind {
     {@link VkImageSubresource VkImageSubresource} subresource;
     {@link VkOffset3D VkOffset3D} offset;
     {@link VkExtent3D VkExtent3D} extent;
     VkDeviceMemory memory;
     VkDeviceSize memoryOffset;
     VkSparseMemoryBindFlags flags;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSparseImageMemoryBind.Buffer	An array of VkSparseImageMemoryBind 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	EXTENT	The struct member offsets.
static final int	FLAGS	The struct member offsets.
static final int	MEMORY	The struct member offsets.
static final int	MEMORYOFFSET	The struct member offsets.
static final int	OFFSET	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SUBRESOURCE	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
VkSparseImageMemoryBind(ByteBuffer container)	Creates a VkSparseImageMemoryBind instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkSparseImageMemoryBind	calloc()	Returns a new VkSparseImageMemoryBind instance allocated with memCalloc.
static VkSparseImageMemoryBind.Buffer	calloc(int capacity)	Returns a new VkSparseImageMemoryBind.Buffer instance allocated with memCalloc.
static VkSparseImageMemoryBind.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkSparseImageMemoryBind.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseImageMemoryBind	calloc(MemoryStack stack)	Returns a new VkSparseImageMemoryBind instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSparseImageMemoryBind	callocStack()	Deprecated.
static VkSparseImageMemoryBind.Buffer	callocStack(int capacity)	Deprecated.
static VkSparseImageMemoryBind.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSparseImageMemoryBind	callocStack(MemoryStack stack)	Deprecated.
static VkSparseImageMemoryBind	create()	Returns a new VkSparseImageMemoryBind instance allocated with BufferUtils.
static VkSparseImageMemoryBind.Buffer	create(int capacity)	Returns a new VkSparseImageMemoryBind.Buffer instance allocated with BufferUtils.
static VkSparseImageMemoryBind	create(long address)	Returns a new VkSparseImageMemoryBind instance for the specified memory address.
static VkSparseImageMemoryBind.Buffer	create(long address, int capacity)	Create a VkSparseImageMemoryBind.Buffer instance at the specified memory.
static @Nullable VkSparseImageMemoryBind	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSparseImageMemoryBind.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkExtent3D	extent()
VkSparseImageMemoryBind	extent(Consumer<VkExtent3D> consumer)	Passes the extent field to the specified Consumer.
VkSparseImageMemoryBind	extent(VkExtent3D value)	Copies the specified VkExtent3D to the extent field.
int	flags()
VkSparseImageMemoryBind	flags(int value)	Sets the specified value to the flags field.
static VkSparseImageMemoryBind	malloc()	Returns a new VkSparseImageMemoryBind instance allocated with memAlloc.
static VkSparseImageMemoryBind.Buffer	malloc(int capacity)	Returns a new VkSparseImageMemoryBind.Buffer instance allocated with memAlloc.
static VkSparseImageMemoryBind.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkSparseImageMemoryBind.Buffer instance allocated on the specified MemoryStack.
static VkSparseImageMemoryBind	malloc(MemoryStack stack)	Returns a new VkSparseImageMemoryBind instance allocated on the specified MemoryStack.
static VkSparseImageMemoryBind	mallocStack()	Deprecated.
static VkSparseImageMemoryBind.Buffer	mallocStack(int capacity)	Deprecated.
static VkSparseImageMemoryBind.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkSparseImageMemoryBind	mallocStack(MemoryStack stack)	Deprecated.
long	memory()
VkSparseImageMemoryBind	memory(long value)	Sets the specified value to the memory field.
long	memoryOffset()
VkSparseImageMemoryBind	memoryOffset(long value)	Sets the specified value to the memoryOffset field.
static VkExtent3D	nextent(long struct)	Unsafe version of extent().
static void	nextent(long struct, VkExtent3D value)	Unsafe version of extent.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
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 VkOffset3D	noffset(long struct)	Unsafe version of offset().
static void	noffset(long struct, VkOffset3D value)	Unsafe version of offset.
static VkImageSubresource	nsubresource(long struct)	Unsafe version of subresource().
static void	nsubresource(long struct, VkImageSubresource value)	Unsafe version of subresource.
VkOffset3D	offset()
VkSparseImageMemoryBind	offset(Consumer<VkOffset3D> consumer)	Passes the offset field to the specified Consumer.
VkSparseImageMemoryBind	offset(VkOffset3D value)	Copies the specified VkOffset3D to the offset field.
VkSparseImageMemoryBind	set(VkImageSubresource subresource, VkOffset3D offset, VkExtent3D extent, long memory, long memoryOffset, int flags)	Initializes this struct with the specified values.
VkSparseImageMemoryBind	set(VkSparseImageMemoryBind src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
VkImageSubresource	subresource()
VkSparseImageMemoryBind	subresource(Consumer<VkImageSubresource> consumer)	Passes the subresource field to the specified Consumer.
VkSparseImageMemoryBind	subresource(VkImageSubresource value)	Copies the specified VkImageSubresource to the subresource 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.

SUBRESOURCE

public static final int SUBRESOURCE

The struct member offsets.

OFFSET

public static final int OFFSET

The struct member offsets.

EXTENT

public static final int EXTENT

The struct member offsets.

MEMORY

public static final int MEMORY

The struct member offsets.

MEMORYOFFSET

public static final int MEMORYOFFSET

The struct member offsets.

FLAGS

public static final int FLAGS

The struct member offsets.

Constructor Details

VkSparseImageMemoryBind

public VkSparseImageMemoryBind(ByteBuffer container)

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

subresource

public VkImageSubresource subresource()

Returns:

a VkImageSubresource view of the subresource field.

offset

public VkOffset3D offset()

Returns:

a VkOffset3D view of the offset field.

extent

public VkExtent3D extent()

Returns:

a VkExtent3D view of the extent field.

memory

public long memory()

Returns:

the value of the memory field.

memoryOffset

public long memoryOffset()

Returns:

the value of the memoryOffset field.

flags

public int flags()

Returns:

the value of the flags field.

subresource

public VkSparseImageMemoryBind subresource(VkImageSubresource value)

Copies the specified VkImageSubresource to the subresource field.

subresource

public VkSparseImageMemoryBind subresource(Consumer<VkImageSubresource> consumer)

Passes the subresource field to the specified Consumer.

offset

public VkSparseImageMemoryBind offset(VkOffset3D value)

Copies the specified VkOffset3D to the offset field.

offset

public VkSparseImageMemoryBind offset(Consumer<VkOffset3D> consumer)

Passes the offset field to the specified Consumer.

extent

public VkSparseImageMemoryBind extent(VkExtent3D value)

Copies the specified VkExtent3D to the extent field.

extent

public VkSparseImageMemoryBind extent(Consumer<VkExtent3D> consumer)

Passes the extent field to the specified Consumer.

memory

public VkSparseImageMemoryBind memory(long value)

Sets the specified value to the memory field.

memoryOffset

public VkSparseImageMemoryBind memoryOffset(long value)

Sets the specified value to the memoryOffset field.

flags

public VkSparseImageMemoryBind flags(int value)

Sets the specified value to the flags field.

set

public VkSparseImageMemoryBind set(VkImageSubresource subresource,
 VkOffset3D offset,
 VkExtent3D extent,
 long memory,
 long memoryOffset,
 int flags)

Initializes this struct with the specified values.

set

public VkSparseImageMemoryBind set(VkSparseImageMemoryBind src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSparseImageMemoryBind malloc()

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

calloc

public static VkSparseImageMemoryBind calloc()

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

create

public static VkSparseImageMemoryBind create()

Returns a new VkSparseImageMemoryBind instance allocated with BufferUtils.

create

public static VkSparseImageMemoryBind create(long address)

Returns a new VkSparseImageMemoryBind instance for the specified memory address.

createSafe

public static @Nullable VkSparseImageMemoryBind createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSparseImageMemoryBind.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSparseImageMemoryBind.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSparseImageMemoryBind.Buffer create(int capacity)

Returns a new VkSparseImageMemoryBind.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSparseImageMemoryBind.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkSparseImageMemoryBind mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkSparseImageMemoryBind callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkSparseImageMemoryBind mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkSparseImageMemoryBind callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

malloc

public static VkSparseImageMemoryBind malloc(MemoryStack stack)

Returns a new VkSparseImageMemoryBind instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkSparseImageMemoryBind calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsubresource

public static VkImageSubresource nsubresource(long struct)

Unsafe version of subresource().

noffset

public static VkOffset3D noffset(long struct)

Unsafe version of offset().

nextent

public static VkExtent3D nextent(long struct)

Unsafe version of extent().

nmemory

public static long nmemory(long struct)

Unsafe version of memory().

nmemoryOffset

public static long nmemoryOffset(long struct)

Unsafe version of memoryOffset().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nsubresource

public static void nsubresource(long struct,
 VkImageSubresource value)

Unsafe version of subresource.

noffset

public static void noffset(long struct,
 VkOffset3D value)

Unsafe version of offset.

nextent

public static void nextent(long struct,
 VkExtent3D value)

Unsafe version of extent.

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.