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

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkImageFormatProperties
extends Struct
```
Khronos Reference Page
Vulkan Specification
Contains additional capabilities for certain types of images.

Member documentation
- maxExtent – the maximum image dimensions
- maxMipLevels – the maximum number of mipmap levels
- maxArrayLayers – the maximum number of array layers
- sampleCounts – a bitmask of VkSampleCountFlagBits specifying all the supported sample counts for this image. One or more of:
  SAMPLE_COUNT_16_BIT SAMPLE_COUNT_1_BIT SAMPLE_COUNT_2_BIT SAMPLE_COUNT_32_BIT
  SAMPLE_COUNT_4_BIT SAMPLE_COUNT_64_BIT SAMPLE_COUNT_8_BIT
- maxResourceSize – an upper bound on the total image size in bytes, inclusive of all image subresources
Layout
```
struct VkImageFormatProperties {
    VkExtent3D maxExtent;
    uint32_t maxMipLevels;
    uint32_t maxArrayLayers;
    VkSampleCountFlags sampleCounts;
    VkDeviceSize maxResourceSize;
}
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkImageFormatProperties.Buffer
An array of VkImageFormatProperties 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
`VkImageFormatProperties(java.nio.ByteBuffer container)` Creates a `VkImageFormatProperties` 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 VkImageFormatProperties`	`calloc()` Returns a new `VkImageFormatProperties` instance allocated with `memCalloc`.
`static VkImageFormatProperties.Buffer`	`calloc(int capacity)` Returns a new `VkImageFormatProperties.Buffer` instance allocated with `memCalloc`.
`static VkImageFormatProperties`	`callocStack()` Returns a new `VkImageFormatProperties` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageFormatProperties.Buffer`	`callocStack(int capacity)` Returns a new `VkImageFormatProperties.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkImageFormatProperties.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkImageFormatProperties.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageFormatProperties`	`callocStack(MemoryStack stack)` Returns a new `VkImageFormatProperties` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageFormatProperties`	`create()` Returns a new `VkImageFormatProperties` instance allocated with `BufferUtils`.
`static VkImageFormatProperties.Buffer`	`create(int capacity)` Returns a new `VkImageFormatProperties.Buffer` instance allocated with `BufferUtils`.
`static VkImageFormatProperties`	`create(long address)` Returns a new `VkImageFormatProperties` instance for the specified memory address or `null` if the address is `NULL`.
`static VkImageFormatProperties.Buffer`	`create(long address, int capacity)` Create a `VkImageFormatProperties.Buffer` instance at the specified memory.
`static VkImageFormatProperties`	`malloc()` Returns a new `VkImageFormatProperties` instance allocated with `memAlloc`.
`static VkImageFormatProperties.Buffer`	`malloc(int capacity)` Returns a new `VkImageFormatProperties.Buffer` instance allocated with `memAlloc`.
`static VkImageFormatProperties`	`mallocStack()` Returns a new `VkImageFormatProperties` instance allocated on the thread-local `MemoryStack`.
`static VkImageFormatProperties.Buffer`	`mallocStack(int capacity)` Returns a new `VkImageFormatProperties.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkImageFormatProperties.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkImageFormatProperties.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImageFormatProperties`	`mallocStack(MemoryStack stack)` Returns a new `VkImageFormatProperties` instance allocated on the specified `MemoryStack`.
`int`	`maxArrayLayers()` Returns the value of the `maxArrayLayers` field.
`VkExtent3D`	`maxExtent()` Returns a `VkExtent3D` view of the `maxExtent` field.
`int`	`maxMipLevels()` Returns the value of the `maxMipLevels` field.
`long`	`maxResourceSize()` Returns the value of the `maxResourceSize` field.
`int`	`sampleCounts()` Returns the value of the `sampleCounts` field.
`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
  - VkImageFormatProperties
```
public VkImageFormatProperties(java.nio.ByteBuffer container)
```
    Creates a VkImageFormatProperties 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
  - maxExtent
```
public VkExtent3D maxExtent()
```
    Returns a VkExtent3D view of the maxExtent field.
  - maxMipLevels
```
public int maxMipLevels()
```
    Returns the value of the maxMipLevels field.
  - maxArrayLayers
```
public int maxArrayLayers()
```
    Returns the value of the maxArrayLayers field.
  - sampleCounts
```
public int sampleCounts()
```
    Returns the value of the sampleCounts field.
  - maxResourceSize
```
public long maxResourceSize()
```
    Returns the value of the maxResourceSize field.
  - malloc
```
public static VkImageFormatProperties malloc()
```
    Returns a new VkImageFormatProperties instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkImageFormatProperties calloc()
```
    Returns a new VkImageFormatProperties instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkImageFormatProperties create()
```
    Returns a new VkImageFormatProperties instance allocated with BufferUtils.
  - create
```
public static VkImageFormatProperties create(long address)
```
    Returns a new VkImageFormatProperties instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkImageFormatProperties.Buffer malloc(int capacity)
```
    Returns a new VkImageFormatProperties.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkImageFormatProperties.Buffer calloc(int capacity)
```
    Returns a new VkImageFormatProperties.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageFormatProperties.Buffer create(int capacity)
```
    Returns a new VkImageFormatProperties.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkImageFormatProperties.Buffer create(long address,
                                                    int capacity)
```
    Create a VkImageFormatProperties.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImageFormatProperties mallocStack()
```
    Returns a new VkImageFormatProperties instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkImageFormatProperties callocStack()
```
    Returns a new VkImageFormatProperties instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkImageFormatProperties mallocStack(MemoryStack stack)
```
    Returns a new VkImageFormatProperties instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkImageFormatProperties callocStack(MemoryStack stack)
```
    Returns a new VkImageFormatProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkImageFormatProperties.Buffer mallocStack(int capacity)
```
    Returns a new VkImageFormatProperties.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageFormatProperties.Buffer callocStack(int capacity)
```
    Returns a new VkImageFormatProperties.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkImageFormatProperties.Buffer mallocStack(int capacity,
                                                         MemoryStack stack)
```
    Returns a new VkImageFormatProperties.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkImageFormatProperties.Buffer callocStack(int capacity,
                                                         MemoryStack stack)
```
    Returns a new VkImageFormatProperties.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

`SAMPLE_COUNT_16_BIT`	`SAMPLE_COUNT_1_BIT`	`SAMPLE_COUNT_2_BIT`	`SAMPLE_COUNT_32_BIT`
`SAMPLE_COUNT_4_BIT`	`SAMPLE_COUNT_64_BIT`	`SAMPLE_COUNT_8_BIT`

Class VkImageFormatProperties

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

VkImageFormatProperties

Method Detail

sizeof

maxExtent

maxMipLevels

maxArrayLayers

sampleCounts

maxResourceSize

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack