VkBindBufferMemoryInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkBindBufferMemoryInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkBindBufferMemoryInfoKHR
```
public class VkBindBufferMemoryInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying how to bind a buffer to memory.
Valid Usage
- buffer must not already be backed by a memory object
- buffer must not have been created with any sparse memory binding flags
- memoryOffset must be less than the size of memory
- memory must have been allocated using one of the memory types allowed in the memoryTypeBits member of the VkMemoryRequirements structure returned from a call to vkGetBufferMemoryRequirements with buffer
- memoryOffset must be an integer multiple of the alignment member of the VkMemoryRequirements structure returned from a call to vkGetBufferMemoryRequirements with buffer
- The size member of the VkMemoryRequirements structure returned from a call to vkGetBufferMemoryRequirements with buffer must be less than or equal to the size of memory minus memoryOffset
- If buffer requires a dedicated allocation(as reported by GetBufferMemoryRequirements2 in VkMemoryDedicatedRequirements::requiresDedicatedAllocation for buffer), memory must have been created with VkMemoryDedicatedAllocateInfo::buffer equal to buffer and memoryOffset must be zero
- If the VkMemoryAllocateInfo provided when memory was allocated included a VkMemoryDedicatedAllocateInfo structure in its pNext chain, and VkMemoryDedicatedAllocateInfo::buffer was not NULL_HANDLE, then buffer must equal VkMemoryDedicatedAllocateInfo::buffer and memoryOffset must be zero.
- If buffer was created with VkDedicatedAllocationBufferCreateInfoNV::dedicatedAllocation equal to TRUE, memory must have been created with VkDedicatedAllocationMemoryAllocateInfoNV::buffer equal to buffer and memoryOffset must be zero
- If the pNext chain includes a VkBindBufferMemoryDeviceGroupInfo structure, all instances of memory specified by VkBindBufferMemoryDeviceGroupInfo::pDeviceIndices must have been allocated
- If the value of VkExportMemoryAllocateInfo::handleTypes used to allocate memory is not 0, it must include at least one of the handles set in VkExternalMemoryBufferCreateInfo::handleTypes when buffer was created
- If memory was created by a memory import operation, the external handle type of the imported memory must also have been set in VkExternalMemoryBufferCreateInfo::handleTypes when buffer was created
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFO
- pNext must be NULL or a pointer to a valid instance of VkBindBufferMemoryDeviceGroupInfo
- buffer must be a valid VkBuffer handle
- memory must be a valid VkDeviceMemory handle
- Both of buffer, and memory must have been created, allocated, or retrieved from the same VkDevice
See Also

BindBufferMemory2, BindBufferMemory2KHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- buffer – the buffer to be attached to memory.
- memory – a VkDeviceMemory object describing the device memory to attach.
- 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.
Layout
```
 struct VkBindBufferMemoryInfo {
     VkStructureType sType;
     void const * pNext;
     VkBuffer buffer;
     VkDeviceMemory memory;
     VkDeviceSize memoryOffset;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkBindBufferMemoryInfo.Buffer
An array of VkBindBufferMemoryInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkBindBufferMemoryInfo.Buffer` An array of `VkBindBufferMemoryInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`BUFFER` The struct member offsets.
`static int`	`MEMORY` The struct member offsets.
`static int`	`MEMORYOFFSET` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` 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 and Description
`VkBindBufferMemoryInfo(java.nio.ByteBuffer container)` Creates a `VkBindBufferMemoryInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`buffer()` Returns the value of the `buffer` field.
`VkBindBufferMemoryInfo`	`buffer(long value)` Sets the specified value to the `buffer` field.
`static VkBindBufferMemoryInfo`	`calloc()` Returns a new `VkBindBufferMemoryInfo` instance allocated with `memCalloc`.
`static VkBindBufferMemoryInfo.Buffer`	`calloc(int capacity)` Returns a new `VkBindBufferMemoryInfo.Buffer` instance allocated with `memCalloc`.
`static VkBindBufferMemoryInfo`	`callocStack()` Returns a new `VkBindBufferMemoryInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBindBufferMemoryInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkBindBufferMemoryInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkBindBufferMemoryInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkBindBufferMemoryInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBindBufferMemoryInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkBindBufferMemoryInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkBindBufferMemoryInfo`	`create()` Returns a new `VkBindBufferMemoryInfo` instance allocated with `BufferUtils`.
`static VkBindBufferMemoryInfo.Buffer`	`create(int capacity)` Returns a new `VkBindBufferMemoryInfo.Buffer` instance allocated with `BufferUtils`.
`static VkBindBufferMemoryInfo`	`create(long address)` Returns a new `VkBindBufferMemoryInfo` instance for the specified memory address.
`static VkBindBufferMemoryInfo.Buffer`	`create(long address, int capacity)` Create a `VkBindBufferMemoryInfo.Buffer` instance at the specified memory.
`static VkBindBufferMemoryInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkBindBufferMemoryInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkBindBufferMemoryInfo`	`malloc()` Returns a new `VkBindBufferMemoryInfo` instance allocated with `memAlloc`.
`static VkBindBufferMemoryInfo.Buffer`	`malloc(int capacity)` Returns a new `VkBindBufferMemoryInfo.Buffer` instance allocated with `memAlloc`.
`static VkBindBufferMemoryInfo`	`mallocStack()` Returns a new `VkBindBufferMemoryInfo` instance allocated on the thread-local `MemoryStack`.
`static VkBindBufferMemoryInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkBindBufferMemoryInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkBindBufferMemoryInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkBindBufferMemoryInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkBindBufferMemoryInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkBindBufferMemoryInfo` instance allocated on the specified `MemoryStack`.
`long`	`memory()` Returns the value of the `memory` field.
`VkBindBufferMemoryInfo`	`memory(long value)` Sets the specified value to the `memory` field.
`long`	`memoryOffset()` Returns the value of the `memoryOffset` field.
`VkBindBufferMemoryInfo`	`memoryOffset(long value)` Sets the specified value to the `memoryOffset` field.
`static long`	`nbuffer(long struct)` Unsafe version of `buffer()`.
`static void`	`nbuffer(long struct, long value)` Unsafe version of `buffer`.
`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()` Returns the value of the `pNext` field.
`VkBindBufferMemoryInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkBindBufferMemoryInfo`	`set(int sType, long pNext, long buffer, long memory, long memoryOffset)` Initializes this struct with the specified values.
`VkBindBufferMemoryInfo`	`set(VkBindBufferMemoryInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkBindBufferMemoryInfo`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - 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.
  - BUFFER
```
public static final int BUFFER
```
    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 Detail
  - VkBindBufferMemoryInfo
```
public VkBindBufferMemoryInfo(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - buffer
```
public long buffer()
```
    Returns the value of the buffer field.
  - memory
```
public long memory()
```
    Returns the value of the memory field.
  - memoryOffset
```
public long memoryOffset()
```
    Returns the value of the memoryOffset field.
  - sType
```
public VkBindBufferMemoryInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkBindBufferMemoryInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - buffer
```
public VkBindBufferMemoryInfo buffer(long value)
```
    Sets the specified value to the buffer field.
  - memory
```
public VkBindBufferMemoryInfo memory(long value)
```
    Sets the specified value to the memory field.
  - memoryOffset
```
public VkBindBufferMemoryInfo memoryOffset(long value)
```
    Sets the specified value to the memoryOffset field.
  - set
```
public VkBindBufferMemoryInfo set(int sType,
                                  long pNext,
                                  long buffer,
                                  long memory,
                                  long memoryOffset)
```
    Initializes this struct with the specified values.
  - set
```
public VkBindBufferMemoryInfo set(VkBindBufferMemoryInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkBindBufferMemoryInfo malloc()
```
    Returns a new VkBindBufferMemoryInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkBindBufferMemoryInfo calloc()
```
    Returns a new VkBindBufferMemoryInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkBindBufferMemoryInfo create()
```
    Returns a new VkBindBufferMemoryInfo instance allocated with BufferUtils.
  - create
```
public static VkBindBufferMemoryInfo create(long address)
```
    Returns a new VkBindBufferMemoryInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkBindBufferMemoryInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkBindBufferMemoryInfo.Buffer malloc(int capacity)
```
    Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkBindBufferMemoryInfo.Buffer calloc(int capacity)
```
    Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBindBufferMemoryInfo.Buffer create(int capacity)
```
    Returns a new VkBindBufferMemoryInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkBindBufferMemoryInfo.Buffer create(long address,
                                                   int capacity)
```
    Create a VkBindBufferMemoryInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkBindBufferMemoryInfo.Buffer createSafe(long address,
                                                                 int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkBindBufferMemoryInfo mallocStack()
```
    Returns a new VkBindBufferMemoryInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkBindBufferMemoryInfo callocStack()
```
    Returns a new VkBindBufferMemoryInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkBindBufferMemoryInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBindBufferMemoryInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkBindBufferMemoryInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBindBufferMemoryInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkBindBufferMemoryInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkBindBufferMemoryInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBindBufferMemoryInfo.Buffer callocStack(int capacity)
```
    Returns a new VkBindBufferMemoryInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkBindBufferMemoryInfo.Buffer mallocStack(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBindBufferMemoryInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkBindBufferMemoryInfo.Buffer callocStack(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkBindBufferMemoryInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nbuffer
```
public static long nbuffer(long struct)
```
    Unsafe version of buffer().
  - 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.
  - nbuffer
```
public static void nbuffer(long struct,
                           long value)
```
    Unsafe version of buffer.
  - 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.

Class VkBindBufferMemoryInfo

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

BUFFER

MEMORY

MEMORYOFFSET

Constructor Detail

VkBindBufferMemoryInfo

Method Detail

sizeof

sType

pNext

buffer

memory

memoryOffset

sType

pNext

buffer

memory

memoryOffset

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nbuffer

nmemory

nmemoryOffset

nsType

npNext

nbuffer

nmemory

nmemoryOffset