Package org.lwjgl.vulkan
Class VkBindBufferMemoryInfo
- 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.NativeResourceStructure specifying how to bind a buffer to memory.Valid Usage
buffermust not already be backed by a memory objectbuffermust not have been created with any sparse memory binding flagsmemoryOffsetmust be less than the size ofmemorymemorymust have been allocated using one of the memory types allowed in thememoryTypeBitsmember of theVkMemoryRequirementsstructure returned from a call tovkGetBufferMemoryRequirementswithbuffermemoryOffsetmust be an integer multiple of thealignmentmember of theVkMemoryRequirementsstructure returned from a call tovkGetBufferMemoryRequirementswithbuffer- The
sizemember of theVkMemoryRequirementsstructure returned from a call tovkGetBufferMemoryRequirementswithbuffermust be less than or equal to the size ofmemoryminusmemoryOffset - If
bufferrequires a dedicated allocation (as reported byGetBufferMemoryRequirements2inVkMemoryDedicatedRequirements::requiresDedicatedAllocationforbuffer),memorymust have been allocated withVkMemoryDedicatedAllocateInfo::bufferequal tobuffer - If the
VkMemoryAllocateInfoprovided whenmemorywas allocated included aVkMemoryDedicatedAllocateInfostructure in itspNextchain, andVkMemoryDedicatedAllocateInfo::bufferwas notNULL_HANDLE, thenbuffermust equalVkMemoryDedicatedAllocateInfo::buffer, andmemoryOffsetmust be zero - If
bufferwas created with theBUFFER_CREATE_PROTECTED_BITbit set, the buffer must be bound to a memory object allocated with a memory type that reportsMEMORY_PROPERTY_PROTECTED_BIT - If
bufferwas created with theBUFFER_CREATE_PROTECTED_BITbit not set, the buffer must not be bound to a memory object allocated with a memory type that reportsMEMORY_PROPERTY_PROTECTED_BIT - If
bufferwas created withVkDedicatedAllocationBufferCreateInfoNV::dedicatedAllocationequal toTRUE,memorymust have been allocated withVkDedicatedAllocationMemoryAllocateInfoNV::bufferequal to a buffer handle created with identical creation parameters tobufferandmemoryOffsetmust be zero - If the value of
VkExportMemoryAllocateInfo::handleTypesused to allocatememoryis not 0, it must include at least one of the handles set inVkExternalMemoryBufferCreateInfo::handleTypeswhenbufferwas created - If
memorywas allocated by a memory import operation, the external handle type of the imported memory must also have been set inVkExternalMemoryBufferCreateInfo::handleTypeswhenbufferwas created - If the
VkPhysicalDeviceBufferDeviceAddressFeatures::bufferDeviceAddressfeature is enabled andbufferwas created with theBUFFER_USAGE_SHADER_DEVICE_ADDRESS_BITbit set,memorymust have been allocated with theMEMORY_ALLOCATE_DEVICE_ADDRESS_BITbit set - If the
pNextchain includes aVkBindBufferMemoryDeviceGroupInfostructure, all instances ofmemoryspecified byVkBindBufferMemoryDeviceGroupInfo::pDeviceIndicesmust have been allocated
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFOpNextmust beNULLor a pointer to a valid instance ofVkBindBufferMemoryDeviceGroupInfo- The
sTypevalue of each struct in thepNextchain must be unique buffermust be a validVkBufferhandlememorymust be a validVkDeviceMemoryhandle- Both of
buffer, andmemorymust have been created, allocated, or retrieved from the sameVkDevice
See Also
BindBufferMemory2,BindBufferMemory2KHRLayout
struct VkBindBufferMemoryInfo { VkStructureTypesType(); void const *pNext(); VkBufferbuffer(); VkDeviceMemorymemory(); VkDeviceSizememoryOffset(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkBindBufferMemoryInfo.BufferAn array ofVkBindBufferMemoryInfostructs.
-
Constructor Summary
Constructors Constructor Description VkBindBufferMemoryInfo(java.nio.ByteBuffer container)Creates aVkBindBufferMemoryInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description longbuffer()the buffer to be attached to memory.VkBindBufferMemoryInfobuffer(long value)Sets the specified value to thebuffer()field.static VkBindBufferMemoryInfocalloc()Returns a newVkBindBufferMemoryInfoinstance allocated withmemCalloc.static VkBindBufferMemoryInfo.Buffercalloc(int capacity)Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated withmemCalloc.static VkBindBufferMemoryInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBindBufferMemoryInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkBindBufferMemoryInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBindBufferMemoryInfocallocStack()Deprecated.static VkBindBufferMemoryInfo.BuffercallocStack(int capacity)Deprecated.static VkBindBufferMemoryInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkBindBufferMemoryInfocallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkBindBufferMemoryInfocreate()Returns a newVkBindBufferMemoryInfoinstance allocated withBufferUtils.static VkBindBufferMemoryInfo.Buffercreate(int capacity)Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated withBufferUtils.static VkBindBufferMemoryInfocreate(long address)Returns a newVkBindBufferMemoryInfoinstance for the specified memory address.static VkBindBufferMemoryInfo.Buffercreate(long address, int capacity)Create aVkBindBufferMemoryInfo.Bufferinstance at the specified memory.static VkBindBufferMemoryInfocreateSafe(long address)static VkBindBufferMemoryInfo.BuffercreateSafe(long address, int capacity)static VkBindBufferMemoryInfomalloc()Returns a newVkBindBufferMemoryInfoinstance allocated withmemAlloc.static VkBindBufferMemoryInfo.Buffermalloc(int capacity)Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated withmemAlloc.static VkBindBufferMemoryInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkBindBufferMemoryInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkBindBufferMemoryInfoinstance allocated on the specifiedMemoryStack.static VkBindBufferMemoryInfomallocStack()Deprecated.static VkBindBufferMemoryInfo.BuffermallocStack(int capacity)Deprecated.static VkBindBufferMemoryInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkBindBufferMemoryInfomallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.longmemory()aVkDeviceMemoryobject describing the device memory to attach.VkBindBufferMemoryInfomemory(long value)Sets the specified value to thememory()field.longmemoryOffset()the start offset of the region ofmemorywhich is to be bound to the buffer.VkBindBufferMemoryInfomemoryOffset(long value)Sets the specified value to thememoryOffset()field.static longnbuffer(long struct)Unsafe version ofbuffer().static voidnbuffer(long struct, long value)Unsafe version ofbuffer.static longnmemory(long struct)Unsafe version ofmemory().static voidnmemory(long struct, long value)Unsafe version ofmemory.static longnmemoryOffset(long struct)Unsafe version ofmemoryOffset().static voidnmemoryOffset(long struct, long value)Unsafe version ofmemoryOffset.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.VkBindBufferMemoryInfopNext(long value)Sets the specified value to thepNext()field.VkBindBufferMemoryInfopNext(VkBindBufferMemoryDeviceGroupInfo value)Prepends the specifiedVkBindBufferMemoryDeviceGroupInfovalue to thepNextchain.VkBindBufferMemoryInfopNext(VkBindBufferMemoryDeviceGroupInfoKHR value)Prepends the specifiedVkBindBufferMemoryDeviceGroupInfoKHRvalue to thepNextchain.VkBindBufferMemoryInfoset(int sType, long pNext, long buffer, long memory, long memoryOffset)Initializes this struct with the specified values.VkBindBufferMemoryInfoset(VkBindBufferMemoryInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkBindBufferMemoryInfosType(int value)Sets the specified value to thesType()field.VkBindBufferMemoryInfosType$Default()Sets theSTRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFOvalue to thesType()field.
-
-
-
Constructor Detail
-
VkBindBufferMemoryInfo
public VkBindBufferMemoryInfo(java.nio.ByteBuffer container)
Creates aVkBindBufferMemoryInfoinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
buffer
public long buffer()
the buffer to be attached to memory.
-
memory
public long memory()
aVkDeviceMemoryobject describing the device memory to attach.
-
memoryOffset
public long memoryOffset()
the start offset of the region ofmemorywhich is to be bound to the buffer. The number of bytes returned in theVkMemoryRequirements::sizemember inmemory, starting frommemoryOffsetbytes, will be bound to the specified buffer.
-
sType
public VkBindBufferMemoryInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkBindBufferMemoryInfo sType$Default()
Sets theSTRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFOvalue to thesType()field.
-
pNext
public VkBindBufferMemoryInfo pNext(long value)
Sets the specified value to thepNext()field.
-
pNext
public VkBindBufferMemoryInfo pNext(VkBindBufferMemoryDeviceGroupInfo value)
Prepends the specifiedVkBindBufferMemoryDeviceGroupInfovalue to thepNextchain.
-
pNext
public VkBindBufferMemoryInfo pNext(VkBindBufferMemoryDeviceGroupInfoKHR value)
Prepends the specifiedVkBindBufferMemoryDeviceGroupInfoKHRvalue to thepNextchain.
-
buffer
public VkBindBufferMemoryInfo buffer(long value)
Sets the specified value to thebuffer()field.
-
memory
public VkBindBufferMemoryInfo memory(long value)
Sets the specified value to thememory()field.
-
memoryOffset
public VkBindBufferMemoryInfo memoryOffset(long value)
Sets the specified value to thememoryOffset()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 newVkBindBufferMemoryInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkBindBufferMemoryInfo calloc()
Returns a newVkBindBufferMemoryInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkBindBufferMemoryInfo create()
Returns a newVkBindBufferMemoryInfoinstance allocated withBufferUtils.
-
create
public static VkBindBufferMemoryInfo create(long address)
Returns a newVkBindBufferMemoryInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkBindBufferMemoryInfo createSafe(long address)
-
malloc
public static VkBindBufferMemoryInfo.Buffer malloc(int capacity)
Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkBindBufferMemoryInfo.Buffer calloc(int capacity)
Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkBindBufferMemoryInfo.Buffer create(int capacity)
Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkBindBufferMemoryInfo.Buffer create(long address, int capacity)
Create aVkBindBufferMemoryInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkBindBufferMemoryInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkBindBufferMemoryInfo mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkBindBufferMemoryInfo callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkBindBufferMemoryInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkBindBufferMemoryInfo callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkBindBufferMemoryInfo.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkBindBufferMemoryInfo.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkBindBufferMemoryInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkBindBufferMemoryInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkBindBufferMemoryInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkBindBufferMemoryInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkBindBufferMemoryInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkBindBufferMemoryInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkBindBufferMemoryInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkBindBufferMemoryInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nbuffer
public static long nbuffer(long struct)
Unsafe version ofbuffer().
-
nmemory
public static long nmemory(long struct)
Unsafe version ofmemory().
-
nmemoryOffset
public static long nmemoryOffset(long struct)
Unsafe version ofmemoryOffset().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nbuffer
public static void nbuffer(long struct, long value)Unsafe version ofbuffer.
-
nmemory
public static void nmemory(long struct, long value)Unsafe version ofmemory.
-
nmemoryOffset
public static void nmemoryOffset(long struct, long value)Unsafe version ofmemoryOffset.
-
-