VkImageFormatProperties (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkImageFormatProperties
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying an image format properties.
Description

Note

There is no mechanism to query the size of an image before creating it, to compare that size against maxResourceSize. If an application attempts to create an image that exceeds this limit, the creation will fail and CreateImage will return ERROR_OUT_OF_DEVICE_MEMORY. While the advertised limit must be at least 2³¹, it may not be possible to create an image that approaches that size, particularly for IMAGE_TYPE_1D.

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

Note

Filling VkImageFormatProperties 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.

See Also

VkExtent3D, VkExternalImageFormatPropertiesNV, VkImageFormatProperties2, GetPhysicalDeviceImageFormatProperties

Member documentation
- maxExtent – are the maximum image dimensions. See the Allowed Extent Values section below for how these values are constrained by type.
- maxMipLevels – the maximum number of mipmap levels. maxMipLevels must be equal to the number of levels in the complete mipmap chain based on the maxExtent.width, maxExtent.height, and maxExtent.depth, except when one of the following conditions is true, in which case it may instead be 1:
  - vkGetPhysicalDeviceImageFormatProperties::tiling was IMAGE_TILING_LINEAR
  - VkPhysicalDeviceImageFormatInfo2::tiling was IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT
  - the VkPhysicalDeviceImageFormatInfo2::pNext chain included a VkPhysicalDeviceExternalImageFormatInfo structure with a handle type included in the handleTypes member for which mipmap image support is not required
  - image format is one of those listed in Formats requiring sampler Y'C_BC_R conversion for IMAGE_ASPECT_COLOR_BIT image views
  - flags contains IMAGE_CREATE_SUBSAMPLED_BIT_EXT
- maxArrayLayers – the maximum number of array layers. maxArrayLayers must be no less than VkPhysicalDeviceLimits::maxImageArrayLayers, except when one of the following conditions is true, in which case it may instead be 1:
  - tiling is IMAGE_TILING_LINEAR
  - tiling is IMAGE_TILING_OPTIMAL and type is IMAGE_TYPE_3D
  - format is one of those listed in Formats requiring sampler Y'C_BC_R conversion for IMAGE_ASPECT_COLOR_BIT image views
  - If tiling is IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT, then maxArrayLayers must not be 0.
- sampleCounts – a bitmask of VkSampleCountFlagBits specifying all the supported sample counts for this image as described below.
- maxResourceSize – an upper bound on the total image size in bytes, inclusive of all image subresources. Implementations may have an address space limit on total size of a resource, which is advertised by this property. maxResourceSize must be at least 2³¹.
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
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkImageFormatProperties.Buffer` An array of `VkImageFormatProperties` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`MAXARRAYLAYERS` The struct member offsets.
`static int`	`MAXEXTENT` The struct member offsets.
`static int`	`MAXMIPLEVELS` The struct member offsets.
`static int`	`MAXRESOURCESIZE` The struct member offsets.
`static int`	`SAMPLECOUNTS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, 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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageFormatProperties.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkImageFormatProperties`	`callocStack(org.lwjgl.system.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.
`static VkImageFormatProperties.Buffer`	`create(long address, int capacity)` Create a `VkImageFormatProperties.Buffer` instance at the specified memory.
`static VkImageFormatProperties`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkImageFormatProperties.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkImageFormatProperties.Buffer` instance allocated on the specified `MemoryStack`.
`static VkImageFormatProperties`	`mallocStack(org.lwjgl.system.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.
`static int`	`nmaxArrayLayers(long struct)` Unsafe version of `maxArrayLayers()`.
`static VkExtent3D`	`nmaxExtent(long struct)` Unsafe version of `maxExtent()`.
`static int`	`nmaxMipLevels(long struct)` Unsafe version of `maxMipLevels()`.
`static long`	`nmaxResourceSize(long struct)` Unsafe version of `maxResourceSize()`.
`static int`	`nsampleCounts(long struct)` Unsafe version of `sampleCounts()`.
`int`	`sampleCounts()` Returns the value of the `sampleCounts` field.
`int`	`sizeof()`

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.
  - MAXEXTENT
```
public static final int MAXEXTENT
```
    The struct member offsets.
  - MAXMIPLEVELS
```
public static final int MAXMIPLEVELS
```
    The struct member offsets.
  - MAXARRAYLAYERS
```
public static final int MAXARRAYLAYERS
```
    The struct member offsets.
  - SAMPLECOUNTS
```
public static final int SAMPLECOUNTS
```
    The struct member offsets.
  - MAXRESOURCESIZE
```
public static final int MAXRESOURCESIZE
```
    The struct member offsets.
- 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.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.
  - createSafe
```
@Nullable
public static VkImageFormatProperties createSafe(long address)
```
    Like create, but returns null if 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
  - createSafe
```
@Nullable
public static VkImageFormatProperties.Buffer createSafe(long address,
                                                                  int capacity)
```
    Like create, but returns null if address is NULL.
  - 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(org.lwjgl.system.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(org.lwjgl.system.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,
                                                         org.lwjgl.system.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,
                                                         org.lwjgl.system.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
  - nmaxExtent
```
public static VkExtent3D nmaxExtent(long struct)
```
    Unsafe version of maxExtent().
  - nmaxMipLevels
```
public static int nmaxMipLevels(long struct)
```
    Unsafe version of maxMipLevels().
  - nmaxArrayLayers
```
public static int nmaxArrayLayers(long struct)
```
    Unsafe version of maxArrayLayers().
  - nsampleCounts
```
public static int nsampleCounts(long struct)
```
    Unsafe version of sampleCounts().
  - nmaxResourceSize
```
public static long nmaxResourceSize(long struct)
```
    Unsafe version of maxResourceSize().

Class VkImageFormatProperties

Description

Note

Note

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

MAXEXTENT

MAXMIPLEVELS

MAXARRAYLAYERS

SAMPLECOUNTS

MAXRESOURCESIZE

Constructor Detail

VkImageFormatProperties

Method Detail

sizeof

maxExtent

maxMipLevels

maxArrayLayers

sampleCounts

maxResourceSize

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nmaxExtent

nmaxMipLevels

nmaxArrayLayers

nsampleCounts

nmaxResourceSize