VkBindImageMemoryInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkBindImageMemoryInfoKHR
```
public class VkBindImageMemoryInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying how to bind an image to memory.
Valid Usage
- image must not already be backed by a memory object
- image must not have been created with any sparse memory binding flags
- memoryOffset must be less than the size of memory
- If the pNext chain does not include a VkBindImagePlaneMemoryInfo structure, 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 GetImageMemoryRequirements2 with image
- If the pNext chain does not include a VkBindImagePlaneMemoryInfo structure, memoryOffset must be an integer multiple of the alignment member of the VkMemoryRequirements structure returned from a call to GetImageMemoryRequirements2 with image
- If the pNext chain does not include a VkBindImagePlaneMemoryInfo structure, the difference of the size of memory and memoryOffset must be greater than or equal to the size member of the VkMemoryRequirements structure returned from a call to GetImageMemoryRequirements2 with the same image
- If the pNext chain includes a VkBindImagePlaneMemoryInfo structure, image must have been created with the IMAGE_CREATE_DISJOINT_BIT bit set.
- If the pNext chain includes a VkBindImagePlaneMemoryInfo structure, 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 GetImageMemoryRequirements2 with image and the correct planeAspect for this plane in the VkImagePlaneMemoryRequirementsInfo structure included in the VkImageMemoryRequirementsInfo2 structure’s pNext chain
- If the pNext chain includes a VkBindImagePlaneMemoryInfo structure, memoryOffset must be an integer multiple of the alignment member of the VkMemoryRequirements structure returned from a call to GetImageMemoryRequirements2 with image and the correct planeAspect for this plane in the VkImagePlaneMemoryRequirementsInfo structure included in the VkImageMemoryRequirementsInfo2 structure’s pNext chain
- If the pNext chain includes a VkBindImagePlaneMemoryInfo structure, the difference of the size of memory and memoryOffset must be greater than or equal to the size member of the VkMemoryRequirements structure returned from a call to GetImageMemoryRequirements2 with the same image and the correct planeAspect for this plane in the VkImagePlaneMemoryRequirementsInfo structure included in the VkImageMemoryRequirementsInfo2 structure’s pNext chain
- If image requires a dedicated allocation (as reported by GetImageMemoryRequirements2 in VkMemoryDedicatedRequirements::requiresDedicatedAllocation for image), memory must have been created with VkMemoryDedicatedAllocateInfo::image equal to image and memoryOffset must be zero
- If the dedicated allocation image aliasing feature is not enabled, and the VkMemoryAllocateInfo provided when memory was allocated included a VkMemoryDedicatedAllocateInfo structure in its pNext chain, and VkMemoryDedicatedAllocateInfo::image was not NULL_HANDLE, then image must equal VkMemoryDedicatedAllocateInfo::image and memoryOffset must be zero.
- If the dedicated allocation image aliasing feature is enabled, and the VkMemoryAllocateInfo provided when memory was allocated included a VkMemoryDedicatedAllocateInfo structure in its pNext chain, and VkMemoryDedicatedAllocateInfo::image was not NULL_HANDLE, then memoryOffset must be zero, and image must be either equal to VkMemoryDedicatedAllocateInfo::image or an image that was created using the same parameters in VkImageCreateInfo, with the exception that extent and arrayLayers may differ subject to the following restrictions: every dimension in the extent parameter of the image being bound must be equal to or smaller than the original image for which the allocation was created; and the arrayLayers 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 VkDedicatedAllocationImageCreateInfoNV::dedicatedAllocation equal to TRUE, memory must have been created with VkDedicatedAllocationMemoryAllocateInfoNV::image equal to image and memoryOffset must be zero
- If the pNext chain includes a VkBindImageMemoryDeviceGroupInfo structure, all instances of memory specified by VkBindImageMemoryDeviceGroupInfo::pDeviceIndices must have been allocated
- If the pNext chain includes a VkBindImageMemoryDeviceGroupInfo structure, and VkBindImageMemoryDeviceGroupInfo::splitInstanceBindRegionCount is not zero, then image must have been created with the IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT bit set
- If the pNext chain includes a VkBindImageMemoryDeviceGroupInfo structure, all elements of VkBindImageMemoryDeviceGroupInfo::pSplitInstanceBindRegions must be valid rectangles contained within the dimensions of image
- If the pNext chain includes a VkBindImageMemoryDeviceGroupInfo structure, the union of the areas of all elements of VkBindImageMemoryDeviceGroupInfo::pSplitInstanceBindRegions that correspond to the same instance of image must cover the entire image.
- If image was created with a valid swapchain handle in VkImageSwapchainCreateInfoKHR::swapchain, then the pNext chain must include a VkBindImageMemorySwapchainInfoKHR structure containing the same swapchain handle.
- If the pNext chain includes a VkBindImageMemorySwapchainInfoKHR structure, memory must be NULL_HANDLE
- If the pNext chain does not include a VkBindImageMemorySwapchainInfoKHR structure, memory must be a valid VkDeviceMemory handle
- If the value of VkExportMemoryAllocateInfo::handleTypes used to allocate memory is not 0, it must include at least one of the handles set in VkExternalMemoryImageCreateInfo::handleTypes when image 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 VkExternalMemoryImageCreateInfo::handleTypes when image was created
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_BIND_IMAGE_MEMORY_INFO
- Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkBindImageMemoryDeviceGroupInfo, VkBindImageMemorySwapchainInfoKHR, or VkBindImagePlaneMemoryInfo
- Each sType member in the pNext chain must be unique
- image must be a valid VkImage handle
- Both of image, and memory that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice
See Also

BindImageMemory2, BindImageMemory2KHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- image – the image 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 image. The number of bytes returned in the VkMemoryRequirements::size member in memory, starting from memoryOffset bytes, will be bound to the specified image.
Layout
```
 struct VkBindImageMemoryInfo {
     VkStructureType sType;
     void const * pNext;
     VkImage image;
     VkDeviceMemory memory;
     VkDeviceSize memoryOffset;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkBindImageMemoryInfo.Buffer
An array of VkBindImageMemoryInfo 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`	`VkBindImageMemoryInfo.Buffer` An array of `VkBindImageMemoryInfo` structs.

Field Summary

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

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

IMAGE

MEMORY

MEMORYOFFSET

Constructor Detail

VkBindImageMemoryInfo

Method Detail

sizeof

sType

pNext

image

memory

memoryOffset

sType

pNext

image

memory

memoryOffset

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nimage

nmemory

nmemoryOffset

nsType

npNext

nimage

nmemory

nmemoryOffset