Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSparseBufferMemoryBindInfo

extends Struct<VkSparseBufferMemoryBindInfo>
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 a sparse buffer memory bind operation.
Valid Usage (Implicit)
See Also

VkBindSparseInfo, VkSparseMemoryBind

Layout


struct VkSparseBufferMemoryBindInfo {
    VkBuffer buffer;
    uint32_t bindCount;
    VkSparseMemoryBind 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
BUFFER

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
VkSparseBufferMemoryBindInfo(long address, ByteBuffer container)

public
VkSparseBufferMemoryBindInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int
bindCount()

the number of VkSparseMemoryBind structures in the pBinds array.

public long
buffer()

the VkBuffer object to be bound.

public VkSparseBufferMemoryBindInfo
buffer(long value)

Sets the specified value to the buffer field.

public static VkSparseBufferMemoryBindInfo
calloc()

Returns a new VkSparseBufferMemoryBindInfo instance allocated with memCalloc.

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

Returns a new VkSparseBufferMemoryBindInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkSparseBufferMemoryBindInfo
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkSparseBufferMemoryBindInfo
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 VkSparseBufferMemoryBindInfo
create()

Returns a new VkSparseBufferMemoryBindInfo instance allocated with BufferUtils.

public static VkSparseBufferMemoryBindInfo
create(long address)

Returns a new VkSparseBufferMemoryBindInfo instance for the specified memory address.

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

Returns a new VkSparseBufferMemoryBindInfo.Buffer instance allocated with BufferUtils.

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

Create a VkSparseBufferMemoryBindInfo.Buffer instance at the specified memory.

public static VkSparseBufferMemoryBindInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSparseBufferMemoryBindInfo
malloc()

Returns a new VkSparseBufferMemoryBindInfo instance allocated with memAlloc.

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

Returns a new VkSparseBufferMemoryBindInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkSparseBufferMemoryBindInfo instance allocated on the specified MemoryStack.

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

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

public static VkSparseBufferMemoryBindInfo
mallocStack()

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static VkSparseBufferMemoryBindInfo.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
nbuffer(long struct)

Unsafe version of buffer.

public static void
nbuffer(long struct, long value)

Unsafe version of buffer.

public static VkSparseMemoryBind.Buffer
npBinds(long struct)

Unsafe version of pBinds.

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

Unsafe version of pBinds.

public VkSparseMemoryBind.Buffer
pBinds()

a pointer to an array of VkSparseMemoryBind structures.

public VkSparseBufferMemoryBindInfo
pBinds(VkSparseMemoryBind.Buffer value)

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

public VkSparseBufferMemoryBindInfo
set(long buffer, VkSparseMemoryBind.Buffer pBinds)

Initializes this struct with the specified values.

public VkSparseBufferMemoryBindInfo

Returns:

this struct
set
(VkSparseBufferMemoryBindInfo
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.

BUFFERback to summary
public static final int BUFFER

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

VkSparseBufferMemoryBindInfoback to summary
protected VkSparseBufferMemoryBindInfo(long address, ByteBuffer container)
VkSparseBufferMemoryBindInfoback to summary
public VkSparseBufferMemoryBindInfo(ByteBuffer container)

Creates a VkSparseBufferMemoryBindInfo 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 VkSparseMemoryBind structures in the pBinds array.

Annotations
@NativeType:uint32_t
bufferback to summary
public long buffer()

the VkBuffer object to be bound.

Annotations
@NativeType:VkBuffer
bufferback to summary
public VkSparseBufferMemoryBindInfo buffer(long value)

Sets the specified value to the buffer field.

callocback to summary
public static VkSparseBufferMemoryBindInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSparseBufferMemoryBindInfo calloc(MemoryStack stack)

Returns a new VkSparseBufferMemoryBindInfo 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 VkSparseBufferMemoryBindInfo.Buffer calloc(int capacity, MemoryStack stack)

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSparseBufferMemoryBindInfo.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 VkSparseBufferMemoryBindInfo 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 VkSparseBufferMemoryBindInfo create()

Returns a new VkSparseBufferMemoryBindInfo instance allocated with BufferUtils.

createback to summary
public static VkSparseBufferMemoryBindInfo create(long address)

Returns a new VkSparseBufferMemoryBindInfo instance for the specified memory address.

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

Returns a new VkSparseBufferMemoryBindInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSparseBufferMemoryBindInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSparseBufferMemoryBindInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkSparseBufferMemoryBindInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSparseBufferMemoryBindInfo malloc(MemoryStack stack)

Returns a new VkSparseBufferMemoryBindInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSparseBufferMemoryBindInfo.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.

nbufferback to summary
public static long nbuffer(long struct)

Unsafe version of buffer.

nbufferback to summary
public static void nbuffer(long struct, long value)

Unsafe version of buffer.

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

Unsafe version of pBinds.

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

Unsafe version of pBinds.

pBindsback to summary
public VkSparseMemoryBind.Buffer pBinds()

a pointer to an array of VkSparseMemoryBind structures.

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

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

setback to summary
public VkSparseBufferMemoryBindInfo set(long buffer, VkSparseMemoryBind.Buffer pBinds)

Initializes this struct with the specified values.

setback to summary
public VkSparseBufferMemoryBindInfo set(VkSparseBufferMemoryBindInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkSparseBufferMemoryBindInfo

the source struct

Returns:VkSparseBufferMemoryBindInfo

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 VkSparseBufferMemoryBindInfo.Buffer

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

An array of VkSparseBufferMemoryBindInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkSparseBufferMemoryBindInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSparseBufferMemoryBindInfo.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 VkSparseBufferMemoryBindInfo#bindCount field.
bindCount
()

public long

Returns:

the value of the VkSparseBufferMemoryBindInfo#buffer field.
buffer
()

public VkSparseBufferMemoryBindInfo.Buffer
buffer(long value)

Sets the specified value to the VkSparseBufferMemoryBindInfo#buffer field.

protected VkSparseBufferMemoryBindInfo
public VkSparseMemoryBind.Buffer

Returns:

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

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSparseBufferMemoryBindInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSparseBufferMemoryBindInfo.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 VkSparseBufferMemoryBindInfo#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 VkSparseBufferMemoryBindInfo#bindCount field.

Annotations
@NativeType:uint32_t
bufferback to summary
public long buffer()
Returns:long

the value of the VkSparseBufferMemoryBindInfo#buffer field.

Annotations
@NativeType:VkBuffer
bufferback to summary
public VkSparseBufferMemoryBindInfo.Buffer buffer(long value)

Sets the specified value to the VkSparseBufferMemoryBindInfo#buffer field.

getElementFactoryback to summary
protected VkSparseBufferMemoryBindInfo getElementFactory()

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

Annotations
@Override
pBindsback to summary
public VkSparseMemoryBind.Buffer pBinds()
Returns:VkSparseMemoryBind.Buffer

a VkSparseMemoryBind.Buffer view of the struct array pointed to by the VkSparseBufferMemoryBindInfo#pBinds field.

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

Sets the address of the specified VkSparseMemoryBind.Buffer to the VkSparseBufferMemoryBindInfo#pBinds field.

selfback to summary
protected VkSparseBufferMemoryBindInfo.Buffer self()

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

Annotations
@Override