VkDescriptorImageInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDescriptorImageInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying descriptor image info.
Description

Members of VkDescriptorImageInfo that are not used in an update (as described above) are ignored.

Valid Usage
- imageView must not be 2D or 2D array image view created from a 3D image
- If imageView is created from a depth/stencil image, the aspectMask used to create the imageView must include either IMAGE_ASPECT_DEPTH_BIT or IMAGE_ASPECT_STENCIL_BIT but not both.
- imageLayout must match the actual VkImageLayout of each subresource accessible from imageView at the time this descriptor is accessed as defined by the image layout matching rules
- If sampler is used and the VkFormat of the image is a multi-planar format, the image must have been created with IMAGE_CREATE_MUTABLE_FORMAT_BIT, and the aspectMask of the imageView must be IMAGE_ASPECT_PLANE_0_BIT, IMAGE_ASPECT_PLANE_1_BIT or (for three-plane formats only) IMAGE_ASPECT_PLANE_2_BIT
Valid Usage (Implicit)
- Both of imageView, and sampler that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice
See Also

VkWriteDescriptorSet

Member documentation
- sampler – a sampler handle, and is used in descriptor updates for types DESCRIPTOR_TYPE_SAMPLER and DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER if the binding being updated does not use immutable samplers.
- imageView – an image view handle, and is used in descriptor updates for types DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and DESCRIPTOR_TYPE_INPUT_ATTACHMENT.
- imageLayout – the layout that the image subresources accessible from imageView will be in at the time this descriptor is accessed. imageLayout is used in descriptor updates for types DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, and DESCRIPTOR_TYPE_INPUT_ATTACHMENT.
Layout
```
 struct VkDescriptorImageInfo {
     VkSampler sampler;
     VkImageView imageView;
     VkImageLayout imageLayout;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`IMAGELAYOUT` The struct member offsets.
`static int`	`IMAGEVIEW` The struct member offsets.
`static int`	`SAMPLER` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkDescriptorImageInfo(java.nio.ByteBuffer container)` Creates a `VkDescriptorImageInfo` 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 VkDescriptorImageInfo`	`calloc()` Returns a new `VkDescriptorImageInfo` instance allocated with `memCalloc`.
`static VkDescriptorImageInfo.Buffer`	`calloc(int capacity)` Returns a new `VkDescriptorImageInfo.Buffer` instance allocated with `memCalloc`.
`static VkDescriptorImageInfo`	`callocStack()` Returns a new `VkDescriptorImageInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorImageInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkDescriptorImageInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorImageInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorImageInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorImageInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorImageInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorImageInfo`	`create()` Returns a new `VkDescriptorImageInfo` instance allocated with `BufferUtils`.
`static VkDescriptorImageInfo.Buffer`	`create(int capacity)` Returns a new `VkDescriptorImageInfo.Buffer` instance allocated with `BufferUtils`.
`static VkDescriptorImageInfo`	`create(long address)` Returns a new `VkDescriptorImageInfo` instance for the specified memory address.
`static VkDescriptorImageInfo.Buffer`	`create(long address, int capacity)` Create a `VkDescriptorImageInfo.Buffer` instance at the specified memory.
`static VkDescriptorImageInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDescriptorImageInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`imageLayout()` Returns the value of the `imageLayout` field.
`VkDescriptorImageInfo`	`imageLayout(int value)` Sets the specified value to the `imageLayout` field.
`long`	`imageView()` Returns the value of the `imageView` field.
`VkDescriptorImageInfo`	`imageView(long value)` Sets the specified value to the `imageView` field.
`static VkDescriptorImageInfo`	`malloc()` Returns a new `VkDescriptorImageInfo` instance allocated with `memAlloc`.
`static VkDescriptorImageInfo.Buffer`	`malloc(int capacity)` Returns a new `VkDescriptorImageInfo.Buffer` instance allocated with `memAlloc`.
`static VkDescriptorImageInfo`	`mallocStack()` Returns a new `VkDescriptorImageInfo` instance allocated on the thread-local `MemoryStack`.
`static VkDescriptorImageInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkDescriptorImageInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDescriptorImageInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorImageInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDescriptorImageInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDescriptorImageInfo` instance allocated on the specified `MemoryStack`.
`static int`	`nimageLayout(long struct)` Unsafe version of `imageLayout()`.
`static void`	`nimageLayout(long struct, int value)` Unsafe version of `imageLayout`.
`static long`	`nimageView(long struct)` Unsafe version of `imageView()`.
`static void`	`nimageView(long struct, long value)` Unsafe version of `imageView`.
`static long`	`nsampler(long struct)` Unsafe version of `sampler()`.
`static void`	`nsampler(long struct, long value)` Unsafe version of `sampler`.
`long`	`sampler()` Returns the value of the `sampler` field.
`VkDescriptorImageInfo`	`sampler(long value)` Sets the specified value to the `sampler` field.
`VkDescriptorImageInfo`	`set(long sampler, long imageView, int imageLayout)` Initializes this struct with the specified values.
`VkDescriptorImageInfo`	`set(VkDescriptorImageInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`

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.
  - SAMPLER
```
public static final int SAMPLER
```
    The struct member offsets.
  - IMAGEVIEW
```
public static final int IMAGEVIEW
```
    The struct member offsets.
  - IMAGELAYOUT
```
public static final int IMAGELAYOUT
```
    The struct member offsets.
- Constructor Detail
  - VkDescriptorImageInfo
```
public VkDescriptorImageInfo(java.nio.ByteBuffer container)
```
    Creates a VkDescriptorImageInfo 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
  - sampler
```
public long sampler()
```
    Returns the value of the sampler field.
  - imageView
```
public long imageView()
```
    Returns the value of the imageView field.
  - imageLayout
```
public int imageLayout()
```
    Returns the value of the imageLayout field.
  - sampler
```
public VkDescriptorImageInfo sampler(long value)
```
    Sets the specified value to the sampler field.
  - imageView
```
public VkDescriptorImageInfo imageView(long value)
```
    Sets the specified value to the imageView field.
  - imageLayout
```
public VkDescriptorImageInfo imageLayout(int value)
```
    Sets the specified value to the imageLayout field.
  - set
```
public VkDescriptorImageInfo set(long sampler,
                                 long imageView,
                                 int imageLayout)
```
    Initializes this struct with the specified values.
  - set
```
public VkDescriptorImageInfo set(VkDescriptorImageInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkDescriptorImageInfo malloc()
```
    Returns a new VkDescriptorImageInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDescriptorImageInfo calloc()
```
    Returns a new VkDescriptorImageInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDescriptorImageInfo create()
```
    Returns a new VkDescriptorImageInfo instance allocated with BufferUtils.
  - create
```
public static VkDescriptorImageInfo create(long address)
```
    Returns a new VkDescriptorImageInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkDescriptorImageInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkDescriptorImageInfo.Buffer malloc(int capacity)
```
    Returns a new VkDescriptorImageInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDescriptorImageInfo.Buffer calloc(int capacity)
```
    Returns a new VkDescriptorImageInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDescriptorImageInfo.Buffer create(int capacity)
```
    Returns a new VkDescriptorImageInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDescriptorImageInfo.Buffer create(long address,
                                                  int capacity)
```
    Create a VkDescriptorImageInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkDescriptorImageInfo.Buffer createSafe(long address,
                                                                int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkDescriptorImageInfo mallocStack()
```
    Returns a new VkDescriptorImageInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDescriptorImageInfo callocStack()
```
    Returns a new VkDescriptorImageInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDescriptorImageInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorImageInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDescriptorImageInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorImageInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkDescriptorImageInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkDescriptorImageInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDescriptorImageInfo.Buffer callocStack(int capacity)
```
    Returns a new VkDescriptorImageInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDescriptorImageInfo.Buffer mallocStack(int capacity,
                                                       org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorImageInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDescriptorImageInfo.Buffer callocStack(int capacity,
                                                       org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDescriptorImageInfo.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
  - nsampler
```
public static long nsampler(long struct)
```
    Unsafe version of sampler().
  - nimageView
```
public static long nimageView(long struct)
```
    Unsafe version of imageView().
  - nimageLayout
```
public static int nimageLayout(long struct)
```
    Unsafe version of imageLayout().
  - nsampler
```
public static void nsampler(long struct,
                            long value)
```
    Unsafe version of sampler.
  - nimageView
```
public static void nimageView(long struct,
                              long value)
```
    Unsafe version of imageView.
  - nimageLayout
```
public static void nimageLayout(long struct,
                                int value)
```
    Unsafe version of imageLayout.

Class VkDescriptorImageInfo

Description

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

SAMPLER

IMAGEVIEW

IMAGELAYOUT

Constructor Detail

VkDescriptorImageInfo

Method Detail

sizeof

sampler

imageView

imageLayout

sampler

imageView

imageLayout

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsampler

nimageView

nimageLayout

nsampler

nimageView

nimageLayout