Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkBindBufferMemoryInfo

extends Struct<VkBindBufferMemoryInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkBindBufferMemoryInfoKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying how to bind a buffer to memory.
Valid Usage
Valid Usage (Implicit)
See Also

BindBufferMemory2, BindBufferMemory2KHR

Layout


struct VkBindBufferMemoryInfo {
    VkStructureType sType;
    void const * pNext;
    VkBuffer buffer;
    VkDeviceMemory memory;
    VkDeviceSize memoryOffset;
}

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
BUFFER

The struct member offsets.

public static final int
MEMORY

The struct member offsets.

public static final int
MEMORYOFFSET

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkBindBufferMemoryInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
buffer()

the buffer to be attached to memory.

public VkBindBufferMemoryInfo
buffer(long value)

Sets the specified value to the buffer field.

public static VkBindBufferMemoryInfo
calloc()

Returns a new VkBindBufferMemoryInfo instance allocated with memCalloc.

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

Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkBindBufferMemoryInfo
callocStack()

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

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

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

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

Returns a new VkBindBufferMemoryInfo instance allocated with BufferUtils.

public static VkBindBufferMemoryInfo
create(long address)

Returns a new VkBindBufferMemoryInfo instance for the specified memory address.

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

Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with BufferUtils.

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

Create a VkBindBufferMemoryInfo.Buffer instance at the specified memory.

public static VkBindBufferMemoryInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkBindBufferMemoryInfo
malloc()

Returns a new VkBindBufferMemoryInfo instance allocated with memAlloc.

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

Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkBindBufferMemoryInfo instance allocated on the specified MemoryStack.

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

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

public static VkBindBufferMemoryInfo
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public long
memory()

a VkDeviceMemory object describing the device memory to attach.

public VkBindBufferMemoryInfo
memory(long value)

Sets the specified value to the memory field.

public long
memoryOffset()

the start offset of the region of memory which is to be bound to the buffer.

public VkBindBufferMemoryInfo
memoryOffset(long value)

Sets the specified value to the memoryOffset field.

public static long
nbuffer(long struct)

Unsafe version of buffer.

public static void
nbuffer(long struct, long value)

Unsafe version of buffer.

public static long
nmemory(long struct)

Unsafe version of memory.

public static void
nmemory(long struct, long value)

Unsafe version of memory.

public static long
nmemoryOffset(long struct)

Unsafe version of memoryOffset.

public static void
nmemoryOffset(long struct, long value)

Unsafe version of memoryOffset.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkBindBufferMemoryInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkBindBufferMemoryInfo
pNext(VkBindBufferMemoryDeviceGroupInfo value)

Prepends the specified VkBindBufferMemoryDeviceGroupInfo value to the pNext chain.

public VkBindBufferMemoryInfo
pNext(VkBindBufferMemoryDeviceGroupInfoKHR value)

Prepends the specified VkBindBufferMemoryDeviceGroupInfoKHR value to the pNext chain.

public VkBindBufferMemoryInfo
set(int sType, long pNext, long buffer, long memory, long memoryOffset)

Initializes this struct with the specified values.

public VkBindBufferMemoryInfo

Returns:

this struct
set
(VkBindBufferMemoryInfo
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 int
sType()

a VkStructureType value identifying this structure.

public VkBindBufferMemoryInfo
sType(int value)

Sets the specified value to the sType field.

public VkBindBufferMemoryInfo
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.

BUFFERback to summary
public static final int BUFFER

The struct member offsets.

MEMORYback to summary
public static final int MEMORY

The struct member offsets.

MEMORYOFFSETback to summary
public static final int MEMORYOFFSET

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkBindBufferMemoryInfoback to summary
protected VkBindBufferMemoryInfo(long address, ByteBuffer container)
VkBindBufferMemoryInfoback to summary
public VkBindBufferMemoryInfo(ByteBuffer container)

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

bufferback to summary
public long buffer()

the buffer to be attached to memory.

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

Sets the specified value to the buffer field.

callocback to summary
public static VkBindBufferMemoryInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkBindBufferMemoryInfo calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkBindBufferMemoryInfo instance allocated with BufferUtils.

createback to summary
public static VkBindBufferMemoryInfo create(long address)

Returns a new VkBindBufferMemoryInfo instance for the specified memory address.

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

Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkBindBufferMemoryInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkBindBufferMemoryInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkBindBufferMemoryInfo malloc(MemoryStack stack)

Returns a new VkBindBufferMemoryInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
memoryback to summary
public long memory()

a VkDeviceMemory object describing the device memory to attach.

Annotations
@NativeType:VkDeviceMemory
memoryback to summary
public VkBindBufferMemoryInfo memory(long value)

Sets the specified value to the memory field.

memoryOffsetback to summary
public long memoryOffset()

the start offset of the region of memory which is to be bound to the buffer. The number of bytes returned in the VkMemoryRequirements::size member in memory, starting from memoryOffset bytes, will be bound to the specified buffer.

Annotations
@NativeType:VkDeviceSize
memoryOffsetback to summary
public VkBindBufferMemoryInfo memoryOffset(long value)

Sets the specified value to the memoryOffset field.

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.

nmemoryback to summary
public static long nmemory(long struct)

Unsafe version of memory.

nmemoryback to summary
public static void nmemory(long struct, long value)

Unsafe version of memory.

nmemoryOffsetback to summary
public static long nmemoryOffset(long struct)

Unsafe version of memoryOffset.

nmemoryOffsetback to summary
public static void nmemoryOffset(long struct, long value)

Unsafe version of memoryOffset.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkBindBufferMemoryInfo pNext(long value)

Sets the specified value to the pNext field.

pNextback to summary
public VkBindBufferMemoryInfo pNext(VkBindBufferMemoryDeviceGroupInfo value)

Prepends the specified VkBindBufferMemoryDeviceGroupInfo value to the pNext chain.

pNextback to summary
public VkBindBufferMemoryInfo pNext(VkBindBufferMemoryDeviceGroupInfoKHR value)

Prepends the specified VkBindBufferMemoryDeviceGroupInfoKHR value to the pNext chain.

setback to summary
public VkBindBufferMemoryInfo set(int sType, long pNext, long buffer, long memory, long memoryOffset)

Initializes this struct with the specified values.

setback to summary
public VkBindBufferMemoryInfo set(VkBindBufferMemoryInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkBindBufferMemoryInfo

the source struct

Returns:VkBindBufferMemoryInfo

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
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkBindBufferMemoryInfo sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkBindBufferMemoryInfo sType$Default()

Sets the STRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkBindBufferMemoryInfo.Buffer

extends StructBuffer<VkBindBufferMemoryInfo, VkBindBufferMemoryInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkBindBufferMemoryInfoKHR.Buffer

An array of VkBindBufferMemoryInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkBindBufferMemoryInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkBindBufferMemoryInfo.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 long

Returns:

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

public VkBindBufferMemoryInfo.Buffer
buffer(long value)

Sets the specified value to the VkBindBufferMemoryInfo#buffer field.

protected VkBindBufferMemoryInfo
public long

Returns:

the value of the VkBindBufferMemoryInfo#memory field.
memory
()

public VkBindBufferMemoryInfo.Buffer
memory(long value)

Sets the specified value to the VkBindBufferMemoryInfo#memory field.

public long

Returns:

the value of the VkBindBufferMemoryInfo#memoryOffset field.
memoryOffset
()

public VkBindBufferMemoryInfo.Buffer
memoryOffset(long value)

Sets the specified value to the VkBindBufferMemoryInfo#memoryOffset field.

public long

Returns:

the value of the VkBindBufferMemoryInfo#pNext field.
pNext
()

public VkBindBufferMemoryInfo.Buffer
pNext(long value)

Sets the specified value to the VkBindBufferMemoryInfo#pNext field.

public VkBindBufferMemoryInfo.Buffer
pNext(VkBindBufferMemoryDeviceGroupInfo value)

Prepends the specified VkBindBufferMemoryDeviceGroupInfo value to the pNext chain.

public VkBindBufferMemoryInfo.Buffer
pNext(VkBindBufferMemoryDeviceGroupInfoKHR value)

Prepends the specified VkBindBufferMemoryDeviceGroupInfoKHR value to the pNext chain.

protected VkBindBufferMemoryInfo.Buffer
public int

Returns:

the value of the VkBindBufferMemoryInfo#sType field.
sType
()

public VkBindBufferMemoryInfo.Buffer
sType(int value)

Sets the specified value to the VkBindBufferMemoryInfo#sType field.

public VkBindBufferMemoryInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkBindBufferMemoryInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkBindBufferMemoryInfo.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 VkBindBufferMemoryInfo#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

bufferback to summary
public long buffer()
Returns:long

the value of the VkBindBufferMemoryInfo#buffer field.

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

Sets the specified value to the VkBindBufferMemoryInfo#buffer field.

getElementFactoryback to summary
protected VkBindBufferMemoryInfo getElementFactory()

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

Annotations
@Override
memoryback to summary
public long memory()
Returns:long

the value of the VkBindBufferMemoryInfo#memory field.

Annotations
@NativeType:VkDeviceMemory
memoryback to summary
public VkBindBufferMemoryInfo.Buffer memory(long value)

Sets the specified value to the VkBindBufferMemoryInfo#memory field.

memoryOffsetback to summary
public long memoryOffset()
Returns:long

the value of the VkBindBufferMemoryInfo#memoryOffset field.

Annotations
@NativeType:VkDeviceSize
memoryOffsetback to summary
public VkBindBufferMemoryInfo.Buffer memoryOffset(long value)

Sets the specified value to the VkBindBufferMemoryInfo#memoryOffset field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkBindBufferMemoryInfo#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkBindBufferMemoryInfo.Buffer pNext(long value)

Sets the specified value to the VkBindBufferMemoryInfo#pNext field.

pNextback to summary
public VkBindBufferMemoryInfo.Buffer pNext(VkBindBufferMemoryDeviceGroupInfo value)

Prepends the specified VkBindBufferMemoryDeviceGroupInfo value to the pNext chain.

pNextback to summary
public VkBindBufferMemoryInfo.Buffer pNext(VkBindBufferMemoryDeviceGroupInfoKHR value)

Prepends the specified VkBindBufferMemoryDeviceGroupInfoKHR value to the pNext chain.

selfback to summary
protected VkBindBufferMemoryInfo.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkBindBufferMemoryInfo#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkBindBufferMemoryInfo.Buffer sType(int value)

Sets the specified value to the VkBindBufferMemoryInfo#sType field.

sType$Defaultback to summary
public VkBindBufferMemoryInfo.Buffer sType$Default()

Sets the STRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFO value to the VkBindBufferMemoryInfo#sType field.