VkFormatProperties (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

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

Note

If no format feature flags are supported, the format itself is not supported, and images of that format cannot be created.

If format is a block-compressed format, then bufferFeatures must not support any features for the format.

If format is not a multi-plane format then linearTilingFeatures and optimalTilingFeatures must not contain FORMAT_FEATURE_DISJOINT_BIT.

See Also

VkFormatProperties2, GetPhysicalDeviceFormatProperties

Member documentation
- linearTilingFeatures – a bitmask of VkFormatFeatureFlagBits specifying features supported by images created with a tiling parameter of IMAGE_TILING_LINEAR.
- optimalTilingFeatures – a bitmask of VkFormatFeatureFlagBits specifying features supported by images created with a tiling parameter of IMAGE_TILING_OPTIMAL.
- bufferFeatures – a bitmask of VkFormatFeatureFlagBits specifying features supported by buffers.
Layout
```
 struct VkFormatProperties {
     VkFormatFeatureFlags linearTilingFeatures;
     VkFormatFeatureFlags optimalTilingFeatures;
     VkFormatFeatureFlags bufferFeatures;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`BUFFERFEATURES` The struct member offsets.
`static int`	`LINEARTILINGFEATURES` The struct member offsets.
`static int`	`OPTIMALTILINGFEATURES` 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
`VkFormatProperties(java.nio.ByteBuffer container)` Creates a `VkFormatProperties` 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
`int`	`bufferFeatures()` Returns the value of the `bufferFeatures` field.
`static VkFormatProperties`	`calloc()` Returns a new `VkFormatProperties` instance allocated with `memCalloc`.
`static VkFormatProperties.Buffer`	`calloc(int capacity)` Returns a new `VkFormatProperties.Buffer` instance allocated with `memCalloc`.
`static VkFormatProperties`	`callocStack()` Returns a new `VkFormatProperties` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkFormatProperties.Buffer`	`callocStack(int capacity)` Returns a new `VkFormatProperties.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkFormatProperties.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkFormatProperties.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkFormatProperties`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkFormatProperties` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkFormatProperties`	`create()` Returns a new `VkFormatProperties` instance allocated with `BufferUtils`.
`static VkFormatProperties.Buffer`	`create(int capacity)` Returns a new `VkFormatProperties.Buffer` instance allocated with `BufferUtils`.
`static VkFormatProperties`	`create(long address)` Returns a new `VkFormatProperties` instance for the specified memory address.
`static VkFormatProperties.Buffer`	`create(long address, int capacity)` Create a `VkFormatProperties.Buffer` instance at the specified memory.
`static VkFormatProperties`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkFormatProperties.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`linearTilingFeatures()` Returns the value of the `linearTilingFeatures` field.
`static VkFormatProperties`	`malloc()` Returns a new `VkFormatProperties` instance allocated with `memAlloc`.
`static VkFormatProperties.Buffer`	`malloc(int capacity)` Returns a new `VkFormatProperties.Buffer` instance allocated with `memAlloc`.
`static VkFormatProperties`	`mallocStack()` Returns a new `VkFormatProperties` instance allocated on the thread-local `MemoryStack`.
`static VkFormatProperties.Buffer`	`mallocStack(int capacity)` Returns a new `VkFormatProperties.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkFormatProperties.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkFormatProperties.Buffer` instance allocated on the specified `MemoryStack`.
`static VkFormatProperties`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkFormatProperties` instance allocated on the specified `MemoryStack`.
`static int`	`nbufferFeatures(long struct)` Unsafe version of `bufferFeatures()`.
`static int`	`nlinearTilingFeatures(long struct)` Unsafe version of `linearTilingFeatures()`.
`static int`	`noptimalTilingFeatures(long struct)` Unsafe version of `optimalTilingFeatures()`.
`int`	`optimalTilingFeatures()` Returns the value of the `optimalTilingFeatures` 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.
  - LINEARTILINGFEATURES
```
public static final int LINEARTILINGFEATURES
```
    The struct member offsets.
  - OPTIMALTILINGFEATURES
```
public static final int OPTIMALTILINGFEATURES
```
    The struct member offsets.
  - BUFFERFEATURES
```
public static final int BUFFERFEATURES
```
    The struct member offsets.
- Constructor Detail
  - VkFormatProperties
```
public VkFormatProperties(java.nio.ByteBuffer container)
```
    Creates a VkFormatProperties 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
  - linearTilingFeatures
```
public int linearTilingFeatures()
```
    Returns the value of the linearTilingFeatures field.
  - optimalTilingFeatures
```
public int optimalTilingFeatures()
```
    Returns the value of the optimalTilingFeatures field.
  - bufferFeatures
```
public int bufferFeatures()
```
    Returns the value of the bufferFeatures field.
  - malloc
```
public static VkFormatProperties malloc()
```
    Returns a new VkFormatProperties instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkFormatProperties calloc()
```
    Returns a new VkFormatProperties instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkFormatProperties create()
```
    Returns a new VkFormatProperties instance allocated with BufferUtils.
  - create
```
public static VkFormatProperties create(long address)
```
    Returns a new VkFormatProperties instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkFormatProperties createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkFormatProperties.Buffer malloc(int capacity)
```
    Returns a new VkFormatProperties.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkFormatProperties.Buffer calloc(int capacity)
```
    Returns a new VkFormatProperties.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkFormatProperties.Buffer create(int capacity)
```
    Returns a new VkFormatProperties.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkFormatProperties.Buffer create(long address,
                                               int capacity)
```
    Create a VkFormatProperties.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkFormatProperties.Buffer createSafe(long address,
                                                             int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkFormatProperties mallocStack()
```
    Returns a new VkFormatProperties instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkFormatProperties callocStack()
```
    Returns a new VkFormatProperties instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkFormatProperties mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFormatProperties instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkFormatProperties callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFormatProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkFormatProperties.Buffer mallocStack(int capacity)
```
    Returns a new VkFormatProperties.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkFormatProperties.Buffer callocStack(int capacity)
```
    Returns a new VkFormatProperties.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkFormatProperties.Buffer mallocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFormatProperties.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkFormatProperties.Buffer callocStack(int capacity,
                                                    org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkFormatProperties.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
  - nlinearTilingFeatures
```
public static int nlinearTilingFeatures(long struct)
```
    Unsafe version of linearTilingFeatures().
  - noptimalTilingFeatures
```
public static int noptimalTilingFeatures(long struct)
```
    Unsafe version of optimalTilingFeatures().
  - nbufferFeatures
```
public static int nbufferFeatures(long struct)
```
    Unsafe version of bufferFeatures().

Class VkFormatProperties

Description

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

LINEARTILINGFEATURES

OPTIMALTILINGFEATURES

BUFFERFEATURES

Constructor Detail

VkFormatProperties

Method Detail

sizeof

linearTilingFeatures

optimalTilingFeatures

bufferFeatures

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nlinearTilingFeatures

noptimalTilingFeatures

nbufferFeatures