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

All Implemented Interfaces:: java.lang.AutoCloseable, NativeResource, Pointer

public class VkDescriptorImageInfo
extends Struct

Khronos Reference Page
Vulkan Specification

Valid Usage

Each of sampler and imageView that are valid handles must have been created, allocated or retrieved from the same VkDevice

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 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. One of:

`IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL`	`IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL`
`IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL`	`IMAGE_LAYOUT_GENERAL`
`IMAGE_LAYOUT_PREINITIALIZED`	`IMAGE_LAYOUT_PRESENT_SRC_KHR`
`IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL`	`IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL`
`IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL`	`IMAGE_LAYOUT_UNDEFINED`

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
  Pointer.Default

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  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, MemoryStack stack)` Returns a new `VkDescriptorImageInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDescriptorImageInfo`	`callocStack(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 or `null` if the address is `NULL`.
`static VkDescriptorImageInfo.Buffer`	`create(long address, int capacity)` Create a `VkDescriptorImageInfo.Buffer` instance at the specified memory.
`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, MemoryStack stack)` Returns a new `VkDescriptorImageInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDescriptorImageInfo`	`mallocStack(MemoryStack stack)` Returns a new `VkDescriptorImageInfo` instance allocated on the specified `MemoryStack`.
`VkDescriptorImageInfo`	`nset(long struct)` Unsafe version of `set`.
`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()` Returns the `sizeof(struct)`.

Methods inherited from class org.lwjgl.system.Struct
clear, free

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- 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()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class 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.
  - nset
```
public VkDescriptorImageInfo nset(long struct)
```
    Unsafe version of set.
  - 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 or null if the 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
  - 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(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(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,
                                                       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,
                                                       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

Class VkDescriptorImageInfo

Valid Usage

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

Constructor Detail

VkDescriptorImageInfo

Method Detail

sizeof

sampler

imageView

imageLayout

sampler

imageView

imageLayout

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack