Package org.lwjgl.vulkan
Class VkBindImageMemoryInfo
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkBindImageMemoryInfo>
org.lwjgl.vulkan.VkBindImageMemoryInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
- Direct Known Subclasses:
VkBindImageMemoryInfoKHR
public class VkBindImageMemoryInfo
extends org.lwjgl.system.Struct<VkBindImageMemoryInfo>
implements org.lwjgl.system.NativeResource
Structure specifying how to bind an image to memory.
Valid Usage
imagemust not have been bound to a memory objectimagemust not have been created with any sparse memory binding flagsmemoryOffsetmust be less than the size ofmemory- If
imagerequires a dedicated allocation (as reported byGetImageMemoryRequirements2inVkMemoryDedicatedRequirements::requiresDedicatedAllocationforimage),memorymust have been created withVkMemoryDedicatedAllocateInfo::imageequal toimage - If the
dedicatedAllocationImageAliasingfeature is not enabled, and theVkMemoryAllocateInfoprovided whenmemorywas allocated included aVkMemoryDedicatedAllocateInfostructure in itspNextchain, andVkMemoryDedicatedAllocateInfo::imagewas notNULL_HANDLE, thenimagemust equalVkMemoryDedicatedAllocateInfo::imageandmemoryOffsetmust be zero - If the
dedicatedAllocationImageAliasingfeature is enabled, and theVkMemoryAllocateInfoprovided whenmemorywas allocated included aVkMemoryDedicatedAllocateInfostructure in itspNextchain, andVkMemoryDedicatedAllocateInfo::imagewas notNULL_HANDLE, thenmemoryOffsetmust be zero, andimagemust be either equal toVkMemoryDedicatedAllocateInfo::imageor an image that was created using the same parameters inVkImageCreateInfo, with the exception thatextentandarrayLayersmay differ subject to the following restrictions: every dimension in theextentparameter of the image being bound must be equal to or smaller than the original image for which the allocation was created; and thearrayLayersparameter of the image being bound must be equal to or smaller than the original image for which the allocation was created - If image was created with the
IMAGE_CREATE_PROTECTED_BITbit set, the image must be bound to a memory object allocated with a memory type that reportsMEMORY_PROPERTY_PROTECTED_BIT - If image was created with the
IMAGE_CREATE_PROTECTED_BITbit not set, the image must not be bound to a memory object created with a memory type that reportsMEMORY_PROPERTY_PROTECTED_BIT - If
imagewas created withVkDedicatedAllocationImageCreateInfoNV::dedicatedAllocationequal toTRUE,memorymust have been created withVkDedicatedAllocationMemoryAllocateInfoNV::imageequal to an image handle created with identical creation parameters toimageandmemoryOffsetmust be zero - If the
VK_KHR_dedicated_allocationextension is not enabled,VkPhysicalDeviceProperties::apiVersionis less than Vulkan 1.1, andimagewas not created withVkDedicatedAllocationImageCreateInfoNV::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 inVkExternalMemoryImageCreateInfo::handleTypeswhenimagewas created - If
memorywas created by a memory import operation, that is notVkImportAndroidHardwareBufferInfoANDROIDwith a non-NULLbuffervalue, the external handle type of the imported memory must also have been set inVkExternalMemoryImageCreateInfo::handleTypeswhenimagewas created - If
memorywas created with theVkImportAndroidHardwareBufferInfoANDROIDmemory import operation with a non-NULLbuffervalue,EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROIDmust also have been set inVkExternalMemoryImageCreateInfo::handleTypeswhenimagewas created - If the
imagewas created with theIMAGE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXTbit set,memorymust have been allocated with theMEMORY_ALLOCATE_DEVICE_ADDRESS_BITbit set - If the
imagewas created with theIMAGE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXTbit set,memorymust have been allocated with theMEMORY_ALLOCATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BITbit set - If the
pNextchain does not include aVkBindImagePlaneMemoryInfostructure,memorymust have been allocated using one of the memory types allowed in thememoryTypeBitsmember of theVkMemoryRequirementsstructure returned from a call toGetImageMemoryRequirements2withimage - If the
pNextchain does not include aVkBindImagePlaneMemoryInfostructure,memoryOffsetmust be an integer multiple of thealignmentmember of theVkMemoryRequirementsstructure returned from a call toGetImageMemoryRequirements2withimage - If the
pNextchain does not include aVkBindImagePlaneMemoryInfostructure, the difference of the size ofmemoryandmemoryOffsetmust be greater than or equal to thesizemember of theVkMemoryRequirementsstructure returned from a call toGetImageMemoryRequirements2with the sameimage - If the
pNextchain includes aVkBindImagePlaneMemoryInfostructure,imagemust have been created with theIMAGE_CREATE_DISJOINT_BITbit set - If
imagewas created with theIMAGE_CREATE_DISJOINT_BITbit set, then thepNextchain must include aVkBindImagePlaneMemoryInfostructure - If the
pNextchain includes aVkBindImagePlaneMemoryInfostructure,memorymust have been allocated using one of the memory types allowed in thememoryTypeBitsmember of theVkMemoryRequirementsstructure returned from a call toGetImageMemoryRequirements2withimageand whereVkBindImagePlaneMemoryInfo::planeAspectcorresponds to theVkImagePlaneMemoryRequirementsInfo::planeAspectin theVkImageMemoryRequirementsInfo2structure’spNextchain - If the
pNextchain includes aVkBindImagePlaneMemoryInfostructure,memoryOffsetmust be an integer multiple of thealignmentmember of theVkMemoryRequirementsstructure returned from a call toGetImageMemoryRequirements2withimageand whereVkBindImagePlaneMemoryInfo::planeAspectcorresponds to theVkImagePlaneMemoryRequirementsInfo::planeAspectin theVkImageMemoryRequirementsInfo2structure’spNextchain - If the
pNextchain includes aVkBindImagePlaneMemoryInfostructure, the difference of the size ofmemoryandmemoryOffsetmust be greater than or equal to thesizemember of theVkMemoryRequirementsstructure returned from a call toGetImageMemoryRequirements2with the sameimageand whereVkBindImagePlaneMemoryInfo::planeAspectcorresponds to theVkImagePlaneMemoryRequirementsInfo::planeAspectin theVkImageMemoryRequirementsInfo2structure’spNextchain - If the
pNextchain includes aVkBindImageMemoryDeviceGroupInfostructure, all instances ofmemoryspecified byVkBindImageMemoryDeviceGroupInfo::pDeviceIndicesmust have been allocated - If the
pNextchain includes aVkBindImageMemoryDeviceGroupInfostructure, andVkBindImageMemoryDeviceGroupInfo::splitInstanceBindRegionCountis not zero, thenimagemust have been created with theIMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BITbit set - If the
pNextchain includes aVkBindImageMemoryDeviceGroupInfostructure, all elements ofVkBindImageMemoryDeviceGroupInfo::pSplitInstanceBindRegionsmust be valid rectangles contained within the dimensions ofimage - If the
pNextchain includes aVkBindImageMemoryDeviceGroupInfostructure, the union of the areas of all elements ofVkBindImageMemoryDeviceGroupInfo::pSplitInstanceBindRegionsthat correspond to the same instance ofimagemust cover the entire image - If
imagewas created with a valid swapchain handle inVkImageSwapchainCreateInfoKHR::swapchain, then thepNextchain must include aVkBindImageMemorySwapchainInfoKHRstructure containing the same swapchain handle - If the
pNextchain includes aVkBindImageMemorySwapchainInfoKHRstructure,memorymust beNULL_HANDLE - If the
pNextchain does not include aVkBindImageMemorySwapchainInfoKHRstructure,memorymust be a validVkDeviceMemoryhandle
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_BIND_IMAGE_MEMORY_INFO- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkBindImageMemoryDeviceGroupInfo,VkBindImageMemorySwapchainInfoKHR,VkBindImagePlaneMemoryInfo, orVkBindMemoryStatus - The
sTypevalue of each struct in thepNextchain must be unique imagemust be a validVkImagehandle- Both of
image, andmemorythat are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the sameVkDevice
See Also
BindImageMemory2, BindImageMemory2KHR
Layout
struct VkBindImageMemoryInfo {
VkStructureType sType();
void const * pNext();
VkImage image();
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
ConstructorsConstructorDescriptionVkBindImageMemoryInfo(ByteBuffer container) Creates aVkBindImageMemoryInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkBindImageMemoryInfocalloc()Returns a newVkBindImageMemoryInfoinstance allocated withmemCalloc.static VkBindImageMemoryInfo.Buffercalloc(int capacity) Returns a newVkBindImageMemoryInfo.Bufferinstance allocated withmemCalloc.static VkBindImageMemoryInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkBindImageMemoryInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBindImageMemoryInfocalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkBindImageMemoryInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkBindImageMemoryInfoDeprecated.static VkBindImageMemoryInfo.BuffercallocStack(int capacity) Deprecated.static VkBindImageMemoryInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkBindImageMemoryInfocallocStack(org.lwjgl.system.MemoryStack stack) Deprecated.static VkBindImageMemoryInfocreate()Returns a newVkBindImageMemoryInfoinstance allocated withBufferUtils.static VkBindImageMemoryInfo.Buffercreate(int capacity) Returns a newVkBindImageMemoryInfo.Bufferinstance allocated withBufferUtils.static VkBindImageMemoryInfocreate(long address) Returns a newVkBindImageMemoryInfoinstance for the specified memory address.static VkBindImageMemoryInfo.Buffercreate(long address, int capacity) Create aVkBindImageMemoryInfo.Bufferinstance at the specified memory.static @Nullable VkBindImageMemoryInfocreateSafe(long address) static @Nullable VkBindImageMemoryInfo.BuffercreateSafe(long address, int capacity) longimage()the image to be attached to memory.image(long value) Sets the specified value to theimage()field.static VkBindImageMemoryInfomalloc()Returns a newVkBindImageMemoryInfoinstance allocated withmemAlloc.static VkBindImageMemoryInfo.Buffermalloc(int capacity) Returns a newVkBindImageMemoryInfo.Bufferinstance allocated withmemAlloc.static VkBindImageMemoryInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkBindImageMemoryInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkBindImageMemoryInfomalloc(org.lwjgl.system.MemoryStack stack) Returns a newVkBindImageMemoryInfoinstance allocated on the specifiedMemoryStack.static VkBindImageMemoryInfoDeprecated.static VkBindImageMemoryInfo.BuffermallocStack(int capacity) Deprecated.static VkBindImageMemoryInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.static VkBindImageMemoryInfomallocStack(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 image.memoryOffset(long value) Sets the specified value to thememoryOffset()field.static longnimage(long struct) Unsafe version ofimage().static voidnimage(long struct, long value) Unsafe version ofimage.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 specifiedVkBindImageMemoryDeviceGroupInfovalue to thepNextchain.Prepends the specifiedVkBindImageMemoryDeviceGroupInfoKHRvalue to thepNextchain.Prepends the specifiedVkBindImageMemorySwapchainInfoKHRvalue to thepNextchain.pNext(VkBindImagePlaneMemoryInfo value) Prepends the specifiedVkBindImagePlaneMemoryInfovalue to thepNextchain.Prepends the specifiedVkBindImagePlaneMemoryInfoKHRvalue to thepNextchain.pNext(VkBindMemoryStatus value) Prepends the specifiedVkBindMemoryStatusvalue to thepNextchain.pNext(VkBindMemoryStatusKHR value) Prepends the specifiedVkBindMemoryStatusKHRvalue to thepNextchain.set(int sType, long pNext, long image, long memory, long memoryOffset) Initializes this struct with the specified values.set(VkBindImageMemoryInfo src) 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_IMAGE_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. -
IMAGE
public static final int IMAGEThe struct member offsets. -
MEMORY
public static final int MEMORYThe struct member offsets. -
MEMORYOFFSET
public static final int MEMORYOFFSETThe struct member offsets.
-
-
Constructor Details
-
VkBindImageMemoryInfo
Creates aVkBindImageMemoryInfoinstance 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<VkBindImageMemoryInfo>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
image
public long image()the image 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 image. The number of bytes returned in theVkMemoryRequirements::sizemember inmemory, starting frommemoryOffsetbytes, will be bound to the specified image. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_BIND_IMAGE_MEMORY_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkBindImageMemoryDeviceGroupInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkBindImageMemoryDeviceGroupInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkBindImageMemorySwapchainInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkBindImagePlaneMemoryInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkBindImagePlaneMemoryInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkBindMemoryStatusvalue to thepNextchain. -
pNext
Prepends the specifiedVkBindMemoryStatusKHRvalue to thepNextchain. -
image
Sets the specified value to theimage()field. -
memory
Sets the specified value to thememory()field. -
memoryOffset
Sets the specified value to thememoryOffset()field. -
set
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 newVkBindImageMemoryInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkBindImageMemoryInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkBindImageMemoryInfoinstance allocated withBufferUtils. -
create
Returns a newVkBindImageMemoryInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkBindImageMemoryInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkBindImageMemoryInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkBindImageMemoryInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkBindImageMemoryInfo.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 VkBindImageMemoryInfo.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 VkBindImageMemoryInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead. -
malloc
Returns a newVkBindImageMemoryInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkBindImageMemoryInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
Returns a newVkBindImageMemoryInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
Returns a newVkBindImageMemoryInfo.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(). -
nimage
public static long nimage(long struct) Unsafe version ofimage(). -
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. -
nimage
public static void nimage(long struct, long value) Unsafe version ofimage. -
nmemory
public static void nmemory(long struct, long value) Unsafe version ofmemory. -
nmemoryOffset
public static void nmemoryOffset(long struct, long value) Unsafe version ofmemoryOffset.
-