VkImageFormatProperties2 (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

Direct Known Subclasses:

VkImageFormatProperties2KHR
```
public class VkImageFormatProperties2
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying an image format properties.
Description

If the combination of parameters to vkGetPhysicalDeviceImageFormatProperties2 is not supported by the implementation for use in CreateImage, then all members of imageFormatProperties will be filled with zero.

Note

Filling imageFormatProperties with zero for unsupported formats is an exception to the usual rule that output structures have undefined contents on error. This exception was unintentional, but is preserved for backwards compatibility. This exeption only applies to imageFormatProperties, not sType, pNext, or any structures chained from pNext.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_IMAGE_FORMAT_PROPERTIES_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 VkExternalImageFormatProperties, VkFilterCubicImageViewImageFormatPropertiesEXT, VkSamplerYcbcrConversionImageFormatProperties, or VkTextureLODGatherFormatPropertiesAMD
- Each sType member in the pNext chain must be unique
See Also

VkImageFormatProperties, GetPhysicalDeviceImageFormatProperties2, GetPhysicalDeviceImageFormatProperties2KHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure. The pNext chain of VkImageFormatProperties2 is used to allow the specification of additional capabilities to be returned from vkGetPhysicalDeviceImageFormatProperties2.
- imageFormatProperties – a VkImageFormatProperties structure in which capabilities are returned.
Layout
```
 struct VkImageFormatProperties2 {
     VkStructureType sType;
     void * pNext;
     VkImageFormatProperties imageFormatProperties;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

Class VkImageFormatProperties2

Description

Note

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

IMAGEFORMATPROPERTIES

Constructor Detail

VkImageFormatProperties2

Method Detail

sizeof

sType

pNext

imageFormatProperties

sType

pNext

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nimageFormatProperties

nsType

npNext