Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkFormatProperties3

extends Struct<VkFormatProperties3>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkFormatProperties3KHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying image format properties.
Description

The bits reported in linearTilingFeatures, optimalTilingFeatures and bufferFeatures must include the bits reported in the corresponding fields of VkFormatProperties2::formatProperties.

Valid Usage (Implicit)

Layout


struct VkFormatProperties3 {
    VkStructureType sType;
    void * pNext;
    VkFormatFeatureFlags2 linearTilingFeatures;
    VkFormatFeatureFlags2 optimalTilingFeatures;
    VkFormatFeatureFlags2 bufferFeatures;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkFormatProperties3.Buffer

An array of VkFormatProperties3 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
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkFormatProperties3(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
bufferFeatures()

a bitmask of VkFormatFeatureFlagBits2 specifying features supported by buffers.

public static VkFormatProperties3
calloc()

Returns a new VkFormatProperties3 instance allocated with memCalloc.

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

Returns a new VkFormatProperties3.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkFormatProperties3
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 VkFormatProperties3
create()

Returns a new VkFormatProperties3 instance allocated with BufferUtils.

public static VkFormatProperties3
create(long address)

Returns a new VkFormatProperties3 instance for the specified memory address.

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

Returns a new VkFormatProperties3.Buffer instance allocated with BufferUtils.

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

Create a VkFormatProperties3.Buffer instance at the specified memory.

public static VkFormatProperties3
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
linearTilingFeatures()

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

public static VkFormatProperties3
malloc()

Returns a new VkFormatProperties3 instance allocated with memAlloc.

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

Returns a new VkFormatProperties3.Buffer instance allocated with memAlloc.

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

Returns a new VkFormatProperties3 instance allocated on the specified MemoryStack.

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

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

public static long
nbufferFeatures(long struct)

Unsafe version of bufferFeatures.

public static long
nlinearTilingFeatures(long struct)

Unsafe version of linearTilingFeatures.

public static long
noptimalTilingFeatures(long struct)

Unsafe version of optimalTilingFeatures.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
optimalTilingFeatures()

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

public long

Returns:

the value of the pNext field.
pNext()

public VkFormatProperties3
pNext(long value)

Sets the specified value to the pNext field.

public VkFormatProperties3
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkFormatProperties3

Returns:

this struct
set(VkFormatProperties3
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public int

Returns:

the value of the sType field.
sType()

public VkFormatProperties3
sType(int value)

Sets the specified value to the sType field.

public VkFormatProperties3
sType$Default()

Sets the STRUCTURE_TYPE_FORMAT_PROPERTIES_3 value to the sType field.

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.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkFormatProperties3back to summary
protected VkFormatProperties3(long address, ByteBuffer container)
VkFormatProperties3back to summary
public VkFormatProperties3(ByteBuffer container)

Creates a VkFormatProperties3 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 long bufferFeatures()

a bitmask of VkFormatFeatureFlagBits2 specifying features supported by buffers.

Annotations
@NativeType:VkFormatFeatureFlags2
callocback to summary
public static VkFormatProperties3 calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkFormatProperties3 calloc(MemoryStack stack)

Returns a new VkFormatProperties3 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 VkFormatProperties3.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkFormatProperties3.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

createback to summary
protected VkFormatProperties3 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 VkFormatProperties3 create()

Returns a new VkFormatProperties3 instance allocated with BufferUtils.

createback to summary
public static VkFormatProperties3 create(long address)

Returns a new VkFormatProperties3 instance for the specified memory address.

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

Returns a new VkFormatProperties3.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkFormatProperties3.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkFormatProperties3 createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
linearTilingFeaturesback to summary
public long linearTilingFeatures()

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

Annotations
@NativeType:VkFormatFeatureFlags2
mallocback to summary
public static VkFormatProperties3 malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkFormatProperties3 malloc(MemoryStack stack)

Returns a new VkFormatProperties3 instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nbufferFeaturesback to summary
public static long nbufferFeatures(long struct)

Unsafe version of bufferFeatures.

nlinearTilingFeaturesback to summary
public static long nlinearTilingFeatures(long struct)

Unsafe version of linearTilingFeatures.

noptimalTilingFeaturesback to summary
public static long noptimalTilingFeatures(long struct)

Unsafe version of optimalTilingFeatures.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

optimalTilingFeaturesback to summary
public long optimalTilingFeatures()

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

Annotations
@NativeType:VkFormatFeatureFlags2
pNextback to summary
public long pNext()
Returns:long

the value of the pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkFormatProperties3 pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkFormatProperties3 set(int sType, long pNext)

Initializes this struct with the specified values.

setback to summary
public VkFormatProperties3 set(VkFormatProperties3 src)

Copies the specified struct data to this struct.

Parameters
src:VkFormatProperties3

the source struct

Returns:VkFormatProperties3

this struct

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
sTypeback to summary
public int sType()
Returns:int

the value of the sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkFormatProperties3 sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkFormatProperties3 sType$Default()

Sets the STRUCTURE_TYPE_FORMAT_PROPERTIES_3 value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkFormatProperties3.Buffer

extends StructBuffer<VkFormatProperties3, VkFormatProperties3.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkFormatProperties3KHR.Buffer
An array of VkFormatProperties3 structs.

Field Summary

Modifier and TypeField and Description
private static final VkFormatProperties3
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkFormatProperties3.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 long

Returns:

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

protected VkFormatProperties3
getElementFactory()

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

public long

Returns:

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

public long

Returns:

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

public long

Returns:

the value of the pNext field.
pNext()

public VkFormatProperties3.Buffer
pNext(long value)

Sets the specified value to the pNext field.

protected VkFormatProperties3.Buffer
self()

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

public int

Returns:

the value of the sType field.
sType()

public VkFormatProperties3.Buffer
sType(int value)

Sets the specified value to the sType field.

public VkFormatProperties3.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_FORMAT_PROPERTIES_3 value to the sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkFormatProperties3 ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkFormatProperties3.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 VkFormatProperties3#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 long bufferFeatures()
Returns:long

the value of the VkFormatProperties3#bufferFeatures field.

Annotations
@NativeType:VkFormatFeatureFlags2
getElementFactoryback to summary
protected VkFormatProperties3 getElementFactory()

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

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

the value of the VkFormatProperties3#linearTilingFeatures field.

Annotations
@NativeType:VkFormatFeatureFlags2
optimalTilingFeaturesback to summary
public long optimalTilingFeatures()
Returns:long

the value of the VkFormatProperties3#optimalTilingFeatures field.

Annotations
@NativeType:VkFormatFeatureFlags2
pNextback to summary
public long pNext()
Returns:long

the value of the pNext field.

Annotations
@NativeType:void *
pNextback to summary
public VkFormatProperties3.Buffer pNext(long value)

Sets the specified value to the pNext field.

selfback to summary
protected VkFormatProperties3.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkFormatProperties3.Buffer sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkFormatProperties3.Buffer sType$Default()

Sets the STRUCTURE_TYPE_FORMAT_PROPERTIES_3 value to the sType field.