Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkFormatProperties

extends Struct<VkFormatProperties>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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

Layout


struct VkFormatProperties {
    VkFormatFeatureFlags linearTilingFeatures;
    VkFormatFeatureFlags optimalTilingFeatures;
    VkFormatFeatureFlags bufferFeatures;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkFormatProperties.Buffer

An array of VkFormatProperties structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
BUFFERFEATURES

The struct member offsets.

public static final int
LINEARTILINGFEATURES

The struct member offsets.

public static final int
OPTIMALTILINGFEATURES

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkFormatProperties(long address, ByteBuffer container)

public
VkFormatProperties(ByteBuffer container)

Creates a VkFormatProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
bufferFeatures()

a bitmask of VkFormatFeatureFlagBits specifying features supported by buffers.

public static VkFormatProperties
calloc()

Returns a new VkFormatProperties instance allocated with memCalloc.

public static VkFormatProperties.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkFormatProperties.Buffer instance allocated with memCalloc.

public static VkFormatProperties
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkFormatProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkFormatProperties.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkFormatProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkFormatProperties
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkFormatProperties
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkFormatProperties.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkFormatProperties.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkFormatProperties
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkFormatProperties
create()

Returns a new VkFormatProperties instance allocated with BufferUtils.

public static VkFormatProperties
create(long address)

Returns a new VkFormatProperties instance for the specified memory address.

public static VkFormatProperties.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkFormatProperties.Buffer instance allocated with BufferUtils.

public static VkFormatProperties.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkFormatProperties.Buffer instance at the specified memory.

public static VkFormatProperties
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkFormatProperties.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public int
linearTilingFeatures()

a bitmask of VkFormatFeatureFlagBits specifying features supported by images created with a tiling parameter of IMAGE_TILING_LINEAR.

public static VkFormatProperties
malloc()

Returns a new VkFormatProperties instance allocated with memAlloc.

public static VkFormatProperties.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkFormatProperties.Buffer instance allocated with memAlloc.

public static VkFormatProperties
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkFormatProperties instance allocated on the specified MemoryStack.

public static VkFormatProperties.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkFormatProperties.Buffer instance allocated on the specified MemoryStack.

public static VkFormatProperties
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkFormatProperties
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkFormatProperties.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkFormatProperties.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nbufferFeatures(long struct)

Unsafe version of bufferFeatures.

public static int
nlinearTilingFeatures(long struct)

Unsafe version of linearTilingFeatures.

public static int
noptimalTilingFeatures(long struct)

Unsafe version of optimalTilingFeatures.

public int
optimalTilingFeatures()

a bitmask of VkFormatFeatureFlagBits specifying features supported by images created with a tiling parameter of IMAGE_TILING_OPTIMAL.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

BUFFERFEATURESback to summary
public static final int BUFFERFEATURES

The struct member offsets.

LINEARTILINGFEATURESback to summary
public static final int LINEARTILINGFEATURES

The struct member offsets.

OPTIMALTILINGFEATURESback to summary
public static final int OPTIMALTILINGFEATURES

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

VkFormatPropertiesback to summary
protected VkFormatProperties(long address, ByteBuffer container)
VkFormatPropertiesback to summary
public VkFormatProperties(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

bufferFeaturesback to summary
public int bufferFeatures()

a bitmask of VkFormatFeatureFlagBits specifying features supported by buffers.

Annotations
@NativeType:VkFormatFeatureFlags
callocback to summary
public static VkFormatProperties calloc()

Returns a new VkFormatProperties instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkFormatProperties.Buffer calloc(int capacity)

Returns a new VkFormatProperties.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkFormatProperties calloc(MemoryStack stack)

Returns a new VkFormatProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkFormatProperties.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkFormatProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkFormatProperties callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkFormatProperties callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkFormatProperties.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkFormatProperties.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkFormatProperties create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkFormatProperties create()

Returns a new VkFormatProperties instance allocated with BufferUtils.

createback to summary
public static VkFormatProperties create(long address)

Returns a new VkFormatProperties instance for the specified memory address.

createback to summary
public static VkFormatProperties.Buffer create(int capacity)

Returns a new VkFormatProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkFormatProperties.Buffer create(long address, int capacity)

Create a VkFormatProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkFormatProperties createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkFormatProperties.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
linearTilingFeaturesback to summary
public int linearTilingFeatures()

a bitmask of VkFormatFeatureFlagBits specifying features supported by images created with a tiling parameter of IMAGE_TILING_LINEAR.

Annotations
@NativeType:VkFormatFeatureFlags
mallocback to summary
public static VkFormatProperties malloc()

Returns a new VkFormatProperties instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkFormatProperties.Buffer malloc(int capacity)

Returns a new VkFormatProperties.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkFormatProperties malloc(MemoryStack stack)

Returns a new VkFormatProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkFormatProperties.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkFormatProperties.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkFormatProperties mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkFormatProperties mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkFormatProperties.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkFormatProperties.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nbufferFeaturesback to summary
public static int nbufferFeatures(long struct)

Unsafe version of bufferFeatures.

nlinearTilingFeaturesback to summary
public static int nlinearTilingFeatures(long struct)

Unsafe version of linearTilingFeatures.

noptimalTilingFeaturesback to summary
public static int noptimalTilingFeatures(long struct)

Unsafe version of optimalTilingFeatures.

optimalTilingFeaturesback to summary
public int optimalTilingFeatures()

a bitmask of VkFormatFeatureFlagBits specifying features supported by images created with a tiling parameter of IMAGE_TILING_OPTIMAL.

Annotations
@NativeType:VkFormatFeatureFlags
sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
org.lwjgl.vulkan back to summary

public Class VkFormatProperties.Buffer

extends StructBuffer<VkFormatProperties, VkFormatProperties.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkFormatProperties structs.

Field Summary

Modifier and TypeField and Description
private static final VkFormatProperties
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkFormatProperties.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the VkFormatProperties#bufferFeatures field.
bufferFeatures()

protected VkFormatProperties
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

public int

Returns:

the value of the VkFormatProperties#linearTilingFeatures field.
linearTilingFeatures()

public int

Returns:

the value of the VkFormatProperties#optimalTilingFeatures field.
optimalTilingFeatures()

protected VkFormatProperties.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkFormatProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkFormatProperties.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkFormatProperties#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

bufferFeaturesback to summary
public int bufferFeatures()
Returns:int

the value of the VkFormatProperties#bufferFeatures field.

Annotations
@NativeType:VkFormatFeatureFlags
getElementFactoryback to summary
protected VkFormatProperties getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
linearTilingFeaturesback to summary
public int linearTilingFeatures()
Returns:int

the value of the VkFormatProperties#linearTilingFeatures field.

Annotations
@NativeType:VkFormatFeatureFlags
optimalTilingFeaturesback to summary
public int optimalTilingFeatures()
Returns:int

the value of the VkFormatProperties#optimalTilingFeatures field.

Annotations
@NativeType:VkFormatFeatureFlags
selfback to summary
protected VkFormatProperties.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override