Package org.lwjgl.vulkan
Class VkBindImageMemoryInfo
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
- Direct Known Subclasses:
VkBindImageMemoryInfoKHR
Structure specifying how to bind an image to memory.
Valid Usage
image
must not have been bound to a memory objectimage
must not have been created with any sparse memory binding flagsmemoryOffset
must be less than the size ofmemory
- If
image
requires a dedicated allocation (as reported byGetImageMemoryRequirements2
inVkMemoryDedicatedRequirements
::requiresDedicatedAllocation
forimage
),memory
must have been created withVkMemoryDedicatedAllocateInfo
::image
equal toimage
- If the
dedicatedAllocationImageAliasing
feature is not enabled, and theVkMemoryAllocateInfo
provided whenmemory
was allocated included aVkMemoryDedicatedAllocateInfo
structure in itspNext
chain, andVkMemoryDedicatedAllocateInfo
::image
was notNULL_HANDLE
, thenimage
must equalVkMemoryDedicatedAllocateInfo
::image
andmemoryOffset
must be zero - If the
dedicatedAllocationImageAliasing
feature is enabled, and theVkMemoryAllocateInfo
provided whenmemory
was allocated included aVkMemoryDedicatedAllocateInfo
structure in itspNext
chain, andVkMemoryDedicatedAllocateInfo
::image
was notNULL_HANDLE
, thenmemoryOffset
must be zero, andimage
must be either equal toVkMemoryDedicatedAllocateInfo
::image
or an image that was created using the same parameters inVkImageCreateInfo
, with the exception thatextent
andarrayLayers
may differ subject to the following restrictions: every dimension in theextent
parameter of the image being bound must be equal to or smaller than the original image for which the allocation was created; and thearrayLayers
parameter 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_BIT
bit 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_BIT
bit not set, the image must not be bound to a memory object created with a memory type that reportsMEMORY_PROPERTY_PROTECTED_BIT
- If
image
was created withVkDedicatedAllocationImageCreateInfoNV
::dedicatedAllocation
equal toTRUE
,memory
must have been created withVkDedicatedAllocationMemoryAllocateInfoNV
::image
equal to an image handle created with identical creation parameters toimage
andmemoryOffset
must be zero - If the
VK_KHR_dedicated_allocation
extension is not enabled,VkPhysicalDeviceProperties
::apiVersion
is less than Vulkan 1.1, andimage
was not created withVkDedicatedAllocationImageCreateInfoNV
::dedicatedAllocation
equal toTRUE
,memory
must not have been allocated dedicated for a specific buffer or image - If the value of
VkExportMemoryAllocateInfo
::handleTypes
used to allocatememory
is not 0, it must include at least one of the handles set inVkExternalMemoryImageCreateInfo
::handleTypes
whenimage
was created - If
memory
was created by a memory import operation, that is notVkImportAndroidHardwareBufferInfoANDROID
with a non-NULL
buffer
value, the external handle type of the imported memory must also have been set inVkExternalMemoryImageCreateInfo
::handleTypes
whenimage
was created - If
memory
was created with theVkImportAndroidHardwareBufferInfoANDROID
memory import operation with a non-NULL
buffer
value,EXTERNAL_MEMORY_HANDLE_TYPE_ANDROID_HARDWARE_BUFFER_BIT_ANDROID
must also have been set inVkExternalMemoryImageCreateInfo
::handleTypes
whenimage
was created - If the
image
was created with theIMAGE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT
bit set,memory
must have been allocated with theMEMORY_ALLOCATE_DEVICE_ADDRESS_BIT
bit set - If the
image
was created with theIMAGE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT
bit set,memory
must have been allocated with theMEMORY_ALLOCATE_DEVICE_ADDRESS_CAPTURE_REPLAY_BIT
bit set - If the
pNext
chain does not include aVkBindImagePlaneMemoryInfo
structure,memory
must have been allocated using one of the memory types allowed in thememoryTypeBits
member of theVkMemoryRequirements
structure returned from a call toGetImageMemoryRequirements2
withimage
- If the
pNext
chain does not include aVkBindImagePlaneMemoryInfo
structure,memoryOffset
must be an integer multiple of thealignment
member of theVkMemoryRequirements
structure returned from a call toGetImageMemoryRequirements2
withimage
- If the
pNext
chain does not include aVkBindImagePlaneMemoryInfo
structure, the difference of the size ofmemory
andmemoryOffset
must be greater than or equal to thesize
member of theVkMemoryRequirements
structure returned from a call toGetImageMemoryRequirements2
with the sameimage
- If the
pNext
chain includes aVkBindImagePlaneMemoryInfo
structure,image
must have been created with theIMAGE_CREATE_DISJOINT_BIT
bit set - If
image
was created with theIMAGE_CREATE_DISJOINT_BIT
bit set, then thepNext
chain must include aVkBindImagePlaneMemoryInfo
structure - If the
pNext
chain includes aVkBindImagePlaneMemoryInfo
structure,memory
must have been allocated using one of the memory types allowed in thememoryTypeBits
member of theVkMemoryRequirements
structure returned from a call toGetImageMemoryRequirements2
withimage
and whereVkBindImagePlaneMemoryInfo
::planeAspect
corresponds to theVkImagePlaneMemoryRequirementsInfo
::planeAspect
in theVkImageMemoryRequirementsInfo2
structure’spNext
chain - If the
pNext
chain includes aVkBindImagePlaneMemoryInfo
structure,memoryOffset
must be an integer multiple of thealignment
member of theVkMemoryRequirements
structure returned from a call toGetImageMemoryRequirements2
withimage
and whereVkBindImagePlaneMemoryInfo
::planeAspect
corresponds to theVkImagePlaneMemoryRequirementsInfo
::planeAspect
in theVkImageMemoryRequirementsInfo2
structure’spNext
chain - If the
pNext
chain includes aVkBindImagePlaneMemoryInfo
structure, the difference of the size ofmemory
andmemoryOffset
must be greater than or equal to thesize
member of theVkMemoryRequirements
structure returned from a call toGetImageMemoryRequirements2
with the sameimage
and whereVkBindImagePlaneMemoryInfo
::planeAspect
corresponds to theVkImagePlaneMemoryRequirementsInfo
::planeAspect
in theVkImageMemoryRequirementsInfo2
structure’spNext
chain - If the
pNext
chain includes aVkBindImageMemoryDeviceGroupInfo
structure, all instances ofmemory
specified byVkBindImageMemoryDeviceGroupInfo
::pDeviceIndices
must have been allocated - If the
pNext
chain includes aVkBindImageMemoryDeviceGroupInfo
structure, andVkBindImageMemoryDeviceGroupInfo
::splitInstanceBindRegionCount
is not zero, thenimage
must have been created with theIMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT
bit set - If the
pNext
chain includes aVkBindImageMemoryDeviceGroupInfo
structure, all elements ofVkBindImageMemoryDeviceGroupInfo
::pSplitInstanceBindRegions
must be valid rectangles contained within the dimensions ofimage
- If the
pNext
chain includes aVkBindImageMemoryDeviceGroupInfo
structure, the union of the areas of all elements ofVkBindImageMemoryDeviceGroupInfo
::pSplitInstanceBindRegions
that correspond to the same instance ofimage
must cover the entire image - If
image
was created with a valid swapchain handle inVkImageSwapchainCreateInfoKHR
::swapchain
, then thepNext
chain must include aVkBindImageMemorySwapchainInfoKHR
structure containing the same swapchain handle - If the
pNext
chain includes aVkBindImageMemorySwapchainInfoKHR
structure,memory
must beNULL_HANDLE
- If the
pNext
chain does not include aVkBindImageMemorySwapchainInfoKHR
structure,memory
must be a validVkDeviceMemory
handle
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_BIND_IMAGE_MEMORY_INFO
- Each
pNext
member of any structure (including this one) in thepNext
chain must be eitherNULL
or a pointer to a valid instance ofVkBindImageMemoryDeviceGroupInfo
,VkBindImageMemorySwapchainInfoKHR
, orVkBindImagePlaneMemoryInfo
- The
sType
value of each struct in thepNext
chain must be unique image
must be a validVkImage
handle- Both of
image
, andmemory
that 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 classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkBindImageMemoryInfo
(ByteBuffer container) Creates aVkBindImageMemoryInfo
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkBindImageMemoryInfo
calloc()
Returns a newVkBindImageMemoryInfo
instance allocated withmemCalloc
.static VkBindImageMemoryInfo.Buffer
calloc
(int capacity) Returns a newVkBindImageMemoryInfo.Buffer
instance allocated withmemCalloc
.static VkBindImageMemoryInfo.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newVkBindImageMemoryInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBindImageMemoryInfo
calloc
(MemoryStack stack) Returns a newVkBindImageMemoryInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkBindImageMemoryInfo
Deprecated.static VkBindImageMemoryInfo.Buffer
callocStack
(int capacity) Deprecated.static VkBindImageMemoryInfo.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static VkBindImageMemoryInfo
callocStack
(MemoryStack stack) Deprecated.static VkBindImageMemoryInfo
create()
Returns a newVkBindImageMemoryInfo
instance allocated withBufferUtils
.static VkBindImageMemoryInfo.Buffer
create
(int capacity) Returns a newVkBindImageMemoryInfo.Buffer
instance allocated withBufferUtils
.static VkBindImageMemoryInfo
create
(long address) Returns a newVkBindImageMemoryInfo
instance for the specified memory address.static VkBindImageMemoryInfo.Buffer
create
(long address, int capacity) Create aVkBindImageMemoryInfo.Buffer
instance at the specified memory.static VkBindImageMemoryInfo
createSafe
(long address) static VkBindImageMemoryInfo.Buffer
createSafe
(long address, int capacity) long
image()
the image to be attached to memory.image
(long value) Sets the specified value to theimage()
field.static VkBindImageMemoryInfo
malloc()
Returns a newVkBindImageMemoryInfo
instance allocated withmemAlloc
.static VkBindImageMemoryInfo.Buffer
malloc
(int capacity) Returns a newVkBindImageMemoryInfo.Buffer
instance allocated withmemAlloc
.static VkBindImageMemoryInfo.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newVkBindImageMemoryInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkBindImageMemoryInfo
malloc
(MemoryStack stack) Returns a newVkBindImageMemoryInfo
instance allocated on the specifiedMemoryStack
.static VkBindImageMemoryInfo
Deprecated.static VkBindImageMemoryInfo.Buffer
mallocStack
(int capacity) Deprecated.static VkBindImageMemoryInfo.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkBindImageMemoryInfo
mallocStack
(MemoryStack stack) Deprecated.long
memory()
aVkDeviceMemory
object describing the device memory to attach.memory
(long value) Sets the specified value to thememory()
field.long
the start offset of the region ofmemory
which is to be bound to the image.memoryOffset
(long value) Sets the specified value to thememoryOffset()
field.static long
nimage
(long struct) Unsafe version ofimage()
.static void
nimage
(long struct, long value) Unsafe version ofimage
.static long
nmemory
(long struct) Unsafe version ofmemory()
.static void
nmemory
(long struct, long value) Unsafe version ofmemory
.static long
nmemoryOffset
(long struct) Unsafe version ofmemoryOffset()
.static void
nmemoryOffset
(long struct, long value) Unsafe version ofmemoryOffset
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.Prepends the specifiedVkBindImageMemoryDeviceGroupInfo
value to thepNext
chain.Prepends the specifiedVkBindImageMemoryDeviceGroupInfoKHR
value to thepNext
chain.Prepends the specifiedVkBindImageMemorySwapchainInfoKHR
value to thepNext
chain.pNext
(VkBindImagePlaneMemoryInfo value) Prepends the specifiedVkBindImagePlaneMemoryInfo
value to thepNext
chain.Prepends the specifiedVkBindImagePlaneMemoryInfoKHR
value to thepNext
chain.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.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_BIND_IMAGE_MEMORY_INFO
value to thesType()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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 aVkBindImageMemoryInfo
instance at the current position of the specifiedByteBuffer
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkBindImageMemoryInfo>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
image
public long image()the image to be attached to memory. -
memory
public long memory()aVkDeviceMemory
object describing the device memory to attach. -
memoryOffset
public long memoryOffset()the start offset of the region ofmemory
which is to be bound to the image. The number of bytes returned in theVkMemoryRequirements
::size
member inmemory
, starting frommemoryOffset
bytes, will be bound to the specified image. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_BIND_IMAGE_MEMORY_INFO
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
pNext
Prepends the specifiedVkBindImageMemoryDeviceGroupInfo
value to thepNext
chain. -
pNext
Prepends the specifiedVkBindImageMemoryDeviceGroupInfoKHR
value to thepNext
chain. -
pNext
Prepends the specifiedVkBindImageMemorySwapchainInfoKHR
value to thepNext
chain. -
pNext
Prepends the specifiedVkBindImagePlaneMemoryInfo
value to thepNext
chain. -
pNext
Prepends the specifiedVkBindImagePlaneMemoryInfoKHR
value to thepNext
chain. -
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 newVkBindImageMemoryInfo
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkBindImageMemoryInfo
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkBindImageMemoryInfo
instance allocated withBufferUtils
. -
create
Returns a newVkBindImageMemoryInfo
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkBindImageMemoryInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkBindImageMemoryInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkBindImageMemoryInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkBindImageMemoryInfo.Buffer
instance 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.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkBindImageMemoryInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkBindImageMemoryInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkBindImageMemoryInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkBindImageMemoryInfo.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-