VkImageFormatListCreateInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkImageFormatListCreateInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Specify that an image can be used with a particular set of formats.
Description

If viewFormatCount is zero, pViewFormats is ignored and the image is created as if the VkImageFormatListCreateInfoKHR structure were not included in the pNext list of VkImageCreateInfo.

Valid Usage
- If viewFormatCount is not 0, all of the formats in the pViewFormats array must be compatible with the format specified in the format field of VkImageCreateInfo, as described in the compatibility table.
- If VkImageCreateInfo::flags does not contain IMAGE_CREATE_MUTABLE_FORMAT_BIT, viewFormatCount must be 0 or 1.
- If viewFormatCount is not 0, VkImageCreateInfo::format must be in pViewFormats.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_IMAGE_FORMAT_LIST_CREATE_INFO_KHR
- If viewFormatCount is not 0, pViewFormats must be a valid pointer to an array of viewFormatCount valid VkFormat values
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- viewFormatCount – the number of entries in the pViewFormats array.
- pViewFormats – an array which lists of all formats which can be used when creating views of this image.
Layout
```
 struct VkImageFormatListCreateInfoKHR {
     VkStructureType sType;
     void const * pNext;
     uint32_t viewFormatCount;
     VkFormat const * pViewFormats;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`PNEXT` The struct member offsets.
`static int`	`PVIEWFORMATS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.
`static int`	`VIEWFORMATCOUNT` 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
`VkImageFormatListCreateInfoKHR(java.nio.ByteBuffer container)` Creates a `VkImageFormatListCreateInfoKHR` 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 VkImageFormatListCreateInfoKHR`	`calloc()` Returns a new `VkImageFormatListCreateInfoKHR` instance allocated with `memCalloc`.
`static VkImageFormatListCreateInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkImageFormatListCreateInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkImageFormatListCreateInfoKHR`	`callocStack()` Returns a new `VkImageFormatListCreateInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageFormatListCreateInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkImageFormatListCreateInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageFormatListCreateInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageFormatListCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageFormatListCreateInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageFormatListCreateInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageFormatListCreateInfoKHR`	`create()` Returns a new `VkImageFormatListCreateInfoKHR` instance allocated with `BufferUtils`.
`static VkImageFormatListCreateInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkImageFormatListCreateInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkImageFormatListCreateInfoKHR`	`create(long address)` Returns a new `VkImageFormatListCreateInfoKHR` instance for the specified memory address.
`static VkImageFormatListCreateInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkImageFormatListCreateInfoKHR.Buffer` instance at the specified memory.
`static VkImageFormatListCreateInfoKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkImageFormatListCreateInfoKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkImageFormatListCreateInfoKHR`	`malloc()` Returns a new `VkImageFormatListCreateInfoKHR` instance allocated with `memAlloc`.
`static VkImageFormatListCreateInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkImageFormatListCreateInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkImageFormatListCreateInfoKHR`	`mallocStack()` Returns a new `VkImageFormatListCreateInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkImageFormatListCreateInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkImageFormatListCreateInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkImageFormatListCreateInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageFormatListCreateInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImageFormatListCreateInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageFormatListCreateInfoKHR` instance allocated on the specified `MemoryStack`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static java.nio.IntBuffer`	`npViewFormats(long struct)` Unsafe version of `pViewFormats`.
`static void`	`npViewFormats(long struct, java.nio.IntBuffer value)` Unsafe version of `pViewFormats`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`static int`	`nviewFormatCount(long struct)` Unsafe version of `viewFormatCount()`.
`static void`	`nviewFormatCount(long struct, int value)` Sets the specified value to the `viewFormatCount` field of the specified `struct`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkImageFormatListCreateInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`java.nio.IntBuffer`	`pViewFormats()` Returns a `IntBuffer` view of the data pointed to by the `pViewFormats` field.
`VkImageFormatListCreateInfoKHR`	`pViewFormats(java.nio.IntBuffer value)` Sets the address of the specified `IntBuffer` to the `pViewFormats` field.
`VkImageFormatListCreateInfoKHR`	`set(int sType, long pNext, java.nio.IntBuffer pViewFormats)` Initializes this struct with the specified values.
`VkImageFormatListCreateInfoKHR`	`set(VkImageFormatListCreateInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkImageFormatListCreateInfoKHR`	`sType(int value)` Sets the specified value to the `sType` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.
`int`	`viewFormatCount()` Returns the value of the `viewFormatCount` 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.
  - VIEWFORMATCOUNT
```
public static final int VIEWFORMATCOUNT
```
    The struct member offsets.
  - PVIEWFORMATS
```
public static final int PVIEWFORMATS
```
    The struct member offsets.
- Constructor Detail
  - VkImageFormatListCreateInfoKHR
```
public VkImageFormatListCreateInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkImageFormatListCreateInfoKHR 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.
  - viewFormatCount
```
public int viewFormatCount()
```
    Returns the value of the viewFormatCount field.
  - pViewFormats
```
@Nullable
public java.nio.IntBuffer pViewFormats()
```
    Returns a IntBuffer view of the data pointed to by the pViewFormats field.
  - sType
```
public VkImageFormatListCreateInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkImageFormatListCreateInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - pViewFormats
```
public VkImageFormatListCreateInfoKHR pViewFormats(@Nullable
                                                   java.nio.IntBuffer value)
```
    Sets the address of the specified IntBuffer to the pViewFormats field.
  - set
```
public VkImageFormatListCreateInfoKHR set(int sType,
                                          long pNext,
                                          @Nullable
                                          java.nio.IntBuffer pViewFormats)
```
    Initializes this struct with the specified values.
  - set
```
public VkImageFormatListCreateInfoKHR set(VkImageFormatListCreateInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkImageFormatListCreateInfoKHR malloc()
```
    Returns a new VkImageFormatListCreateInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkImageFormatListCreateInfoKHR calloc()
```
    Returns a new VkImageFormatListCreateInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkImageFormatListCreateInfoKHR create()
```
    Returns a new VkImageFormatListCreateInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkImageFormatListCreateInfoKHR create(long address)
```
    Returns a new VkImageFormatListCreateInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkImageFormatListCreateInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkImageFormatListCreateInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkImageFormatListCreateInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkImageFormatListCreateInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkImageFormatListCreateInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageFormatListCreateInfoKHR.Buffer create(int capacity)
```
    Returns a new VkImageFormatListCreateInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageFormatListCreateInfoKHR.Buffer create(long address,
                                                           int capacity)
```
    Create a VkImageFormatListCreateInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkImageFormatListCreateInfoKHR.Buffer createSafe(long address,
                                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkImageFormatListCreateInfoKHR mallocStack()
```
    Returns a new VkImageFormatListCreateInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkImageFormatListCreateInfoKHR callocStack()
```
    Returns a new VkImageFormatListCreateInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkImageFormatListCreateInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageFormatListCreateInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkImageFormatListCreateInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageFormatListCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkImageFormatListCreateInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkImageFormatListCreateInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageFormatListCreateInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkImageFormatListCreateInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImageFormatListCreateInfoKHR.Buffer mallocStack(int capacity,
                                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageFormatListCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageFormatListCreateInfoKHR.Buffer callocStack(int capacity,
                                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkImageFormatListCreateInfoKHR.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().
  - nviewFormatCount
```
public static int nviewFormatCount(long struct)
```
    Unsafe version of viewFormatCount().
  - npViewFormats
```
@Nullable
public static java.nio.IntBuffer npViewFormats(long struct)
```
    Unsafe version of pViewFormats.
  - 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.
  - nviewFormatCount
```
public static void nviewFormatCount(long struct,
                                    int value)
```
    Sets the specified value to the viewFormatCount field of the specified struct.
  - npViewFormats
```
public static void npViewFormats(long struct,
                                 @Nullable
                                 java.nio.IntBuffer value)
```
    Unsafe version of pViewFormats.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkImageFormatListCreateInfoKHR

Description

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

VIEWFORMATCOUNT

PVIEWFORMATS

Constructor Detail

VkImageFormatListCreateInfoKHR

Method Detail

sizeof

sType

pNext

viewFormatCount

pViewFormats

sType

pNext

pViewFormats

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nviewFormatCount

npViewFormats

nsType

npNext

nviewFormatCount

npViewFormats

validate

validate