Package org.lwjgl.vulkan
Class VkBindBufferMemoryInfo
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkBindBufferMemoryInfo>
org.lwjgl.vulkan.VkBindBufferMemoryInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkBindBufferMemoryInfoKHR
public class VkBindBufferMemoryInfo
extends org.lwjgl.system.Struct<VkBindBufferMemoryInfo>
implements org.lwjgl.system.NativeResource
Structure specifying how to bind a buffer to memory.
Valid Usage
buffermust not have been bound to 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
VK_KHR_dedicated_allocationextension is not enabled,VkPhysicalDeviceProperties::apiVersionis less than Vulkan 1.1, andbufferwas not created withVkDedicatedAllocationBufferCreateInfoNV::dedicatedAllocationequal toTRUE,memorymust not have been allocated dedicated for a specific buffer or image - 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, that is notVkImportAndroidHardwareBufferInfoANDROIDwith a non-NULLbuffervalue, the external handle type of the imported memory must also have been set inVkExternalMemoryBufferCreateInfo::handleTypeswhenbufferwas created - If
memorywas allocated with theVkImportAndroidHardwareBufferInfoANDROIDmemory import operation with a non-NULLbuffervalue,EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROIDmust 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
VkPhysicalDeviceBufferDeviceAddressFeatures::bufferDeviceAddressCaptureReplayfeature is enabled andbufferwas created with theBUFFER_CREATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BITbit set,memorymust have been allocated with theMEMORY_ALLOCATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BITbit set - If the
bufferwas created with theBUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXTbit set,memorymust have been allocated with theMEMORY_ALLOCATE_DEVICE_ADDRESS_BITbit set - If the
bufferwas created with theBUFFER_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXTbit set,memorymust have been allocated with theMEMORY_ALLOCATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BITbit set - If the
pNextchain includes aVkBindBufferMemoryDeviceGroupInfostructure, all instances ofmemoryspecified byVkBindBufferMemoryDeviceGroupInfo::pDeviceIndicesmust have been allocated
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFO- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkBindBufferMemoryDeviceGroupInfoorVkBindMemoryStatus - 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, BindBufferMemory2KHR
Layout
struct VkBindBufferMemoryInfo {
VkStructureType sType();
void const * pNext();
VkBuffer buffer();
VkDeviceMemory memory();
VkDeviceSize memoryOffset();
}-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkBindBufferMemoryInfo(ByteBuffer container) Creates aVkBindBufferMemoryInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionlongbuffer()the buffer to be attached to memory.buffer(long value) Sets the specified value to thebuffer()field.static VkBindBufferMemoryInfocalloc()Returns a newVkBindBufferMemoryInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated withmemCalloc.calloc(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 VkBindBufferMemoryInfoDeprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkBindBufferMemoryInfocallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkBindBufferMemoryInfocreate()Returns a newVkBindBufferMemoryInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated withBufferUtils.static VkBindBufferMemoryInfocreate(long address) Returns a newVkBindBufferMemoryInfoinstance for the specified memory address.create(long address, int capacity) Create aVkBindBufferMemoryInfo.Bufferinstance at the specified memory.static @Nullable VkBindBufferMemoryInfocreateSafe(long address) static @Nullable VkBindBufferMemoryInfo.BuffercreateSafe(long address, int capacity) static VkBindBufferMemoryInfomalloc()Returns a newVkBindBufferMemoryInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated withmemAlloc.malloc(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 VkBindBufferMemoryInfoDeprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkBindBufferMemoryInfomallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.longmemory()aVkDeviceMemoryobject describing the device memory to attach.memory(long value) Sets the specified value to thememory()field.longthe start offset of the region ofmemorywhich is to be bound to the buffer.memoryOffset(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.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkBindBufferMemoryDeviceGroupInfovalue to thepNextchain.Prepends the specifiedVkBindBufferMemoryDeviceGroupInfoKHRvalue to thepNextchain.pNext(VkBindMemoryStatus value) Prepends the specifiedVkBindMemoryStatusvalue to thepNextchain.pNext(VkBindMemoryStatusKHR value) Prepends the specifiedVkBindMemoryStatusKHRvalue to thepNextchain.set(int sType, long pNext, long buffer, long memory, long memoryOffset) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFOvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
BUFFER
public static final int BUFFERThe struct member offsets. -
MEMORY
public static final int MEMORYThe struct member offsets. -
MEMORYOFFSET
public static final int MEMORYOFFSETThe struct member offsets.
-
-
Constructor Details
-
VkBindBufferMemoryInfo
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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkBindBufferMemoryInfo>
-
sType
public int sType()aVkStructureTypevalue identifying 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
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_BIND_BUFFER_MEMORY_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkBindBufferMemoryDeviceGroupInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkBindBufferMemoryDeviceGroupInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkBindMemoryStatusvalue to thepNextchain. -
pNext
Prepends the specifiedVkBindMemoryStatusKHRvalue to thepNextchain. -
buffer
Sets the specified value to thebuffer()field. -
memory
Sets the specified value to thememory()field. -
memoryOffset
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
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkBindBufferMemoryInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkBindBufferMemoryInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkBindBufferMemoryInfoinstance allocated withBufferUtils. -
create
Returns a newVkBindBufferMemoryInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkBindBufferMemoryInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkBindBufferMemoryInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
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
Returns a newVkBindBufferMemoryInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
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:
capacity- the buffer capacitystack- the stack from which to allocate
-
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:
capacity- the buffer capacitystack- the stack from which to allocate
-
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.
-