VkPhysicalDeviceImageFormatInfo2 (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkPhysicalDeviceImageFormatInfo2KHR
```
public class VkPhysicalDeviceImageFormatInfo2
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying image creation parameters.
Description

The members of VkPhysicalDeviceImageFormatInfo2 correspond to the arguments to GetPhysicalDeviceImageFormatProperties, with sType and pNext added for extensibility.

Valid Usage
- tiling must be IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT if and only if the pNext chain includes VkPhysicalDeviceImageDrmFormatModifierInfoEXT.
- If tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT and flags contains IMAGE_CREATE_MUTABLE_FORMAT_BIT, then the pNext chain must include VkImageFormatListCreateInfoKHR with non-zero viewFormatCount.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_IMAGE_FORMAT_INFO_2
- 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 VkImageFormatListCreateInfoKHR, VkImageStencilUsageCreateInfoEXT, VkPhysicalDeviceExternalImageFormatInfo, VkPhysicalDeviceImageDrmFormatModifierInfoEXT, or VkPhysicalDeviceImageViewImageFormatInfoEXT
- Each sType member in the pNext chain must be unique
- format must be a valid VkFormat value
- type must be a valid VkImageType value
- tiling must be a valid VkImageTiling value
- usage must be a valid combination of VkImageUsageFlagBits values
- usage must not be 0
- flags must be a valid combination of VkImageCreateFlagBits values
See Also

GetPhysicalDeviceImageFormatProperties2, GetPhysicalDeviceImageFormatProperties2KHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure. The pNext chain of VkPhysicalDeviceImageFormatInfo2 is used to provide additional image parameters to vkGetPhysicalDeviceImageFormatProperties2.
- format – a VkFormat value indicating the image format, corresponding to VkImageCreateInfo::format.
- type – a VkImageType value indicating the image type, corresponding to VkImageCreateInfo::imageType.
- tiling – a VkImageTiling value indicating the image tiling, corresponding to VkImageCreateInfo::tiling.
- usage – a bitmask of VkImageUsageFlagBits indicating the intended usage of the image, corresponding to VkImageCreateInfo::usage.
- flags – a bitmask of VkImageCreateFlagBits indicating additional parameters of the image, corresponding to VkImageCreateInfo::flags.
Layout
```
 struct VkPhysicalDeviceImageFormatInfo2 {
     VkStructureType sType;
     void const * pNext;
     VkFormat format;
     VkImageType type;
     VkImageTiling tiling;
     VkImageUsageFlags usage;
     VkImageCreateFlags flags;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

Class VkPhysicalDeviceImageFormatInfo2

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

STYPE

PNEXT

FORMAT

TYPE

TILING

USAGE

FLAGS

Constructor Detail

VkPhysicalDeviceImageFormatInfo2

Method Detail

sizeof

sType

pNext

format

type

tiling

usage

flags

sType

pNext

format

type

tiling

usage

flags

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nformat

ntype

ntiling

nusage

nflags

nsType

npNext

nformat

ntype

ntiling

nusage

nflags