Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSparseImageMemoryBindInfo

extends Struct<VkSparseImageMemoryBindInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying sparse image memory bind information.
Valid Usage
Valid Usage (Implicit)
See Also

VkBindSparseInfo, VkSparseImageMemoryBind

Layout


struct VkSparseImageMemoryBindInfo {
    VkImage image;
    uint32_t bindCount;
    VkSparseImageMemoryBind const * pBinds;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BINDCOUNT

The struct member offsets.

public static final int
IMAGE

The struct member offsets.

public static final int
PBINDS

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkSparseImageMemoryBindInfo(long address, ByteBuffer container)

public
VkSparseImageMemoryBindInfo(ByteBuffer container)

Creates a VkSparseImageMemoryBindInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
bindCount()

the number of VkSparseImageMemoryBind structures in pBinds array

public static VkSparseImageMemoryBindInfo
calloc()

Returns a new VkSparseImageMemoryBindInfo instance allocated with memCalloc.

public static VkSparseImageMemoryBindInfo.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated with memCalloc.

public static VkSparseImageMemoryBindInfo
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static VkSparseImageMemoryBindInfo.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkSparseImageMemoryBindInfo
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryBindInfo
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryBindInfo.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryBindInfo.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkSparseImageMemoryBindInfo
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkSparseImageMemoryBindInfo
create()

Returns a new VkSparseImageMemoryBindInfo instance allocated with BufferUtils.

public static VkSparseImageMemoryBindInfo
create(long address)

Returns a new VkSparseImageMemoryBindInfo instance for the specified memory address.

public static VkSparseImageMemoryBindInfo.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated with BufferUtils.

public static VkSparseImageMemoryBindInfo.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkSparseImageMemoryBindInfo.Buffer instance at the specified memory.

public static VkSparseImageMemoryBindInfo
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkSparseImageMemoryBindInfo.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public long
image()

the VkImage object to be bound

public VkSparseImageMemoryBindInfo
image(long value)

Sets the specified value to the image field.

public static VkSparseImageMemoryBindInfo
malloc()

Returns a new VkSparseImageMemoryBindInfo instance allocated with memAlloc.

public static VkSparseImageMemoryBindInfo.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated with memAlloc.

public static VkSparseImageMemoryBindInfo
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkSparseImageMemoryBindInfo instance allocated on the specified MemoryStack.

public static VkSparseImageMemoryBindInfo.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static VkSparseImageMemoryBindInfo
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryBindInfo
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryBindInfo.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseImageMemoryBindInfo.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nbindCount(long struct)

Unsafe version of bindCount.

public static void
nbindCount(long struct, int value)

Sets the specified value to the bindCount field of the specified struct.

public static long
nimage(long struct)

Unsafe version of image.

public static void
nimage(long struct, long value)

Unsafe version of image.

public static VkSparseImageMemoryBind.Buffer
npBinds(long struct)

Unsafe version of pBinds.

public static void
npBinds(long struct, VkSparseImageMemoryBind.Buffer value)

Unsafe version of pBinds.

public VkSparseImageMemoryBind.Buffer
pBinds()

a pointer to an array of VkSparseImageMemoryBind structures

public VkSparseImageMemoryBindInfo
pBinds(VkSparseImageMemoryBind.Buffer value)

Sets the address of the specified VkSparseImageMemoryBind.Buffer to the pBinds field.

public VkSparseImageMemoryBindInfo
set(long image, VkSparseImageMemoryBind.Buffer pBinds)

Initializes this struct with the specified values.

public VkSparseImageMemoryBindInfo

Returns:

this struct
set
(VkSparseImageMemoryBindInfo
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

BINDCOUNTback to summary
public static final int BINDCOUNT

The struct member offsets.

IMAGEback to summary
public static final int IMAGE

The struct member offsets.

PBINDSback to summary
public static final int PBINDS

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkSparseImageMemoryBindInfoback to summary
protected VkSparseImageMemoryBindInfo(long address, ByteBuffer container)
VkSparseImageMemoryBindInfoback to summary
public VkSparseImageMemoryBindInfo(ByteBuffer container)

Creates a VkSparseImageMemoryBindInfo 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 Detail

bindCountback to summary
public int bindCount()

the number of VkSparseImageMemoryBind structures in pBinds array

Annotations
@NativeType:uint32_t
callocback to summary
public static VkSparseImageMemoryBindInfo calloc()

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

callocback to summary
public static VkSparseImageMemoryBindInfo.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSparseImageMemoryBindInfo calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkSparseImageMemoryBindInfo.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkSparseImageMemoryBindInfo callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSparseImageMemoryBindInfo callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSparseImageMemoryBindInfo.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSparseImageMemoryBindInfo.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
createback to summary
protected VkSparseImageMemoryBindInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkSparseImageMemoryBindInfo create()

Returns a new VkSparseImageMemoryBindInfo instance allocated with BufferUtils.

createback to summary
public static VkSparseImageMemoryBindInfo create(long address)

Returns a new VkSparseImageMemoryBindInfo instance for the specified memory address.

createback to summary
public static VkSparseImageMemoryBindInfo.Buffer create(int capacity)

Returns a new VkSparseImageMemoryBindInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkSparseImageMemoryBindInfo.Buffer create(long address, int capacity)

Create a VkSparseImageMemoryBindInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSparseImageMemoryBindInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkSparseImageMemoryBindInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
imageback to summary
public long image()

the VkImage object to be bound

Annotations
@NativeType:VkImage
imageback to summary
public VkSparseImageMemoryBindInfo image(long value)

Sets the specified value to the image field.

mallocback to summary
public static VkSparseImageMemoryBindInfo malloc()

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

mallocback to summary
public static VkSparseImageMemoryBindInfo.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSparseImageMemoryBindInfo malloc(MemoryStack stack)

Returns a new VkSparseImageMemoryBindInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkSparseImageMemoryBindInfo.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkSparseImageMemoryBindInfo mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSparseImageMemoryBindInfo mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSparseImageMemoryBindInfo.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSparseImageMemoryBindInfo.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
nbindCountback to summary
public static int nbindCount(long struct)

Unsafe version of bindCount.

nbindCountback to summary
public static void nbindCount(long struct, int value)

Sets the specified value to the bindCount field of the specified struct.

nimageback to summary
public static long nimage(long struct)

Unsafe version of image.

nimageback to summary
public static void nimage(long struct, long value)

Unsafe version of image.

npBindsback to summary
public static VkSparseImageMemoryBind.Buffer npBinds(long struct)

Unsafe version of pBinds.

npBindsback to summary
public static void npBinds(long struct, VkSparseImageMemoryBind.Buffer value)

Unsafe version of pBinds.

pBindsback to summary
public VkSparseImageMemoryBind.Buffer pBinds()

a pointer to an array of VkSparseImageMemoryBind structures

Annotations
@NativeType:VkSparseImageMemoryBind const *
pBindsback to summary
public VkSparseImageMemoryBindInfo pBinds(VkSparseImageMemoryBind.Buffer value)

Sets the address of the specified VkSparseImageMemoryBind.Buffer to the pBinds field.

setback to summary
public VkSparseImageMemoryBindInfo set(long image, VkSparseImageMemoryBind.Buffer pBinds)

Initializes this struct with the specified values.

setback to summary
public VkSparseImageMemoryBindInfo set(VkSparseImageMemoryBindInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkSparseImageMemoryBindInfo

the source struct

Returns:VkSparseImageMemoryBindInfo

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkSparseImageMemoryBindInfo.Buffer

extends StructBuffer<VkSparseImageMemoryBindInfo, VkSparseImageMemoryBindInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkSparseImageMemoryBindInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkSparseImageMemoryBindInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSparseImageMemoryBindInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the VkSparseImageMemoryBindInfo#bindCount field.
bindCount
()

protected VkSparseImageMemoryBindInfo
public long

Returns:

the value of the VkSparseImageMemoryBindInfo#image field.
image
()

public VkSparseImageMemoryBindInfo.Buffer
image(long value)

Sets the specified value to the VkSparseImageMemoryBindInfo#image field.

public VkSparseImageMemoryBind.Buffer

Returns:

a VkSparseImageMemoryBind.Buffer view of the struct array pointed to by the VkSparseImageMemoryBindInfo#pBinds field.
pBinds
()

public VkSparseImageMemoryBindInfo.Buffer
protected VkSparseImageMemoryBindInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSparseImageMemoryBindInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSparseImageMemoryBindInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkSparseImageMemoryBindInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

bindCountback to summary
public int bindCount()
Returns:int

the value of the VkSparseImageMemoryBindInfo#bindCount field.

Annotations
@NativeType:uint32_t
getElementFactoryback to summary
protected VkSparseImageMemoryBindInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
imageback to summary
public long image()
Returns:long

the value of the VkSparseImageMemoryBindInfo#image field.

Annotations
@NativeType:VkImage
imageback to summary
public VkSparseImageMemoryBindInfo.Buffer image(long value)

Sets the specified value to the VkSparseImageMemoryBindInfo#image field.

pBindsback to summary
public VkSparseImageMemoryBind.Buffer pBinds()
Returns:VkSparseImageMemoryBind.Buffer

a VkSparseImageMemoryBind.Buffer view of the struct array pointed to by the VkSparseImageMemoryBindInfo#pBinds field.

Annotations
@NativeType:VkSparseImageMemoryBind const *
pBindsback to summary
public VkSparseImageMemoryBindInfo.Buffer pBinds(VkSparseImageMemoryBind.Buffer value)

Sets the address of the specified VkSparseImageMemoryBind.Buffer to the VkSparseImageMemoryBindInfo#pBinds field.

selfback to summary
protected VkSparseImageMemoryBindInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override