VkBindImagePlaneMemoryInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkBindImagePlaneMemoryInfoKHR
```
public class VkBindImagePlaneMemoryInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying how to bind an image plane to memory.
Valid Usage
- If the image’s tiling is IMAGE_TILING_LINEAR or IMAGE_TILING_OPTIMAL, then planeAspect must be a single valid format plane for the image. (That is, planeAspect must be IMAGE_ASPECT_PLANE_0_BIT or IMAGE_ASPECT_PLANE_1_BIT for “_2PLANE” formats and planeAspect must be IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT, or IMAGE_ASPECT_PLANE_2_BIT for “_3PLANE” formats.)
- If the image’s tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then planeAspect must be a single valid memory plane for the image. (That is, aspectMask must specify a plane index that is less than the drmFormatModifierPlaneCount associated with the image’s format and drmFormatModifier.)
- A single call to BindImageMemory2 must bind all or none of the planes of an image (i.e. bindings to all planes of an image must be made in a single BindImageMemory2 call), as separate bindings
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_BIND_IMAGE_PLANE_MEMORY_INFO
- planeAspect must be a valid VkImageAspectFlagBits value
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- planeAspect – the aspect of the disjoint image plane to bind.
Layout
```
 struct VkBindImagePlaneMemoryInfo {
     VkStructureType sType;
     void const * pNext;
     VkImageAspectFlagBits planeAspect;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

Class VkBindImagePlaneMemoryInfo

Valid Usage

Valid Usage (Implicit)

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

PLANEASPECT

Constructor Detail

VkBindImagePlaneMemoryInfo

Method Detail

sizeof

sType

pNext

planeAspect

sType

pNext

planeAspect

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nplaneAspect

nsType

npNext

nplaneAspect