Package org.lwjgl.vulkan

Class VkFormatProperties2

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkFormatProperties2>

org.lwjgl.vulkan.VkFormatProperties2

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

Direct Known Subclasses:

VkFormatProperties2KHR

public class VkFormatProperties2
extends org.lwjgl.system.Struct<VkFormatProperties2>
implements org.lwjgl.system.NativeResource

Structure specifying image format properties.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_FORMAT_PROPERTIES_2
• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkDrmFormatModifierPropertiesList2EXT, VkDrmFormatModifierPropertiesListEXT, VkFormatProperties3, or VkSubpassResolvePerformanceQueryEXT
• The sType value of each struct in the pNext chain must be unique

See Also

VkFormatProperties, GetPhysicalDeviceFormatProperties2, GetPhysicalDeviceFormatProperties2KHR

Layout

 struct VkFormatProperties2 {
     VkStructureType sType();
     void * pNext();
     VkFormatProperties formatProperties();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkFormatProperties2.Buffer	An array of VkFormatProperties2 structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FORMATPROPERTIES	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkFormatProperties2(ByteBuffer container)	Creates a VkFormatProperties2 instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkFormatProperties2	calloc()	Returns a new VkFormatProperties2 instance allocated with memCalloc.
static VkFormatProperties2.Buffer	calloc(int capacity)	Returns a new VkFormatProperties2.Buffer instance allocated with memCalloc.
static VkFormatProperties2.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkFormatProperties2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkFormatProperties2	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkFormatProperties2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkFormatProperties2	callocStack()	Deprecated.
static VkFormatProperties2.Buffer	callocStack(int capacity)	Deprecated.
static VkFormatProperties2.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkFormatProperties2	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkFormatProperties2	create()	Returns a new VkFormatProperties2 instance allocated with BufferUtils.
static VkFormatProperties2.Buffer	create(int capacity)	Returns a new VkFormatProperties2.Buffer instance allocated with BufferUtils.
static VkFormatProperties2	create(long address)	Returns a new VkFormatProperties2 instance for the specified memory address.
static VkFormatProperties2.Buffer	create(long address, int capacity)	Create a VkFormatProperties2.Buffer instance at the specified memory.
static @Nullable VkFormatProperties2	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkFormatProperties2.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkFormatProperties	formatProperties()	a VkFormatProperties structure describing features supported by the requested format.
static VkFormatProperties2	malloc()	Returns a new VkFormatProperties2 instance allocated with memAlloc.
static VkFormatProperties2.Buffer	malloc(int capacity)	Returns a new VkFormatProperties2.Buffer instance allocated with memAlloc.
static VkFormatProperties2.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkFormatProperties2.Buffer instance allocated on the specified MemoryStack.
static VkFormatProperties2	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkFormatProperties2 instance allocated on the specified MemoryStack.
static VkFormatProperties2	mallocStack()	Deprecated.
static VkFormatProperties2.Buffer	mallocStack(int capacity)	Deprecated.
static VkFormatProperties2.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkFormatProperties2	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkFormatProperties	nformatProperties(long struct)	Unsafe version of formatProperties().
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkFormatProperties2	pNext(long value)	Sets the specified value to the pNext() field.
VkFormatProperties2	pNext(VkDrmFormatModifierPropertiesList2EXT value)	Prepends the specified VkDrmFormatModifierPropertiesList2EXT value to the pNext chain.
VkFormatProperties2	pNext(VkDrmFormatModifierPropertiesListEXT value)	Prepends the specified VkDrmFormatModifierPropertiesListEXT value to the pNext chain.
VkFormatProperties2	pNext(VkFormatProperties3 value)	Prepends the specified VkFormatProperties3 value to the pNext chain.
VkFormatProperties2	pNext(VkFormatProperties3KHR value)	Prepends the specified VkFormatProperties3KHR value to the pNext chain.
VkFormatProperties2	pNext(VkSubpassResolvePerformanceQueryEXT value)	Prepends the specified VkSubpassResolvePerformanceQueryEXT value to the pNext chain.
VkFormatProperties2	set(int sType, long pNext)	Initializes this struct with the specified values.
VkFormatProperties2	set(VkFormatProperties2 src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkFormatProperties2	sType(int value)	Sets the specified value to the sType() field.
VkFormatProperties2	sType$Default()	Sets the STRUCTURE_TYPE_FORMAT_PROPERTIES_2 value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

FORMATPROPERTIES

public static final int FORMATPROPERTIES

The struct member offsets.

Constructor Details

VkFormatProperties2

public VkFormatProperties2(ByteBuffer container)

Creates a VkFormatProperties2 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkFormatProperties2>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

formatProperties

public VkFormatProperties formatProperties()

a VkFormatProperties structure describing features supported by the requested format.

sType

public VkFormatProperties2 sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkFormatProperties2 sType$Default()

Sets the STRUCTURE_TYPE_FORMAT_PROPERTIES_2 value to the sType() field.

pNext

public VkFormatProperties2 pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkFormatProperties2 pNext(VkDrmFormatModifierPropertiesList2EXT value)

Prepends the specified VkDrmFormatModifierPropertiesList2EXT value to the pNext chain.

pNext

public VkFormatProperties2 pNext(VkDrmFormatModifierPropertiesListEXT value)

Prepends the specified VkDrmFormatModifierPropertiesListEXT value to the pNext chain.

pNext

public VkFormatProperties2 pNext(VkFormatProperties3 value)

Prepends the specified VkFormatProperties3 value to the pNext chain.

pNext

public VkFormatProperties2 pNext(VkFormatProperties3KHR value)

Prepends the specified VkFormatProperties3KHR value to the pNext chain.

pNext

public VkFormatProperties2 pNext(VkSubpassResolvePerformanceQueryEXT value)

Prepends the specified VkSubpassResolvePerformanceQueryEXT value to the pNext chain.

set

public VkFormatProperties2 set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkFormatProperties2 set(VkFormatProperties2 src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkFormatProperties2 malloc()

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

calloc

public static VkFormatProperties2 calloc()

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

create

public static VkFormatProperties2 create()

Returns a new VkFormatProperties2 instance allocated with BufferUtils.

create

public static VkFormatProperties2 create(long address)

Returns a new VkFormatProperties2 instance for the specified memory address.

createSafe

public static @Nullable VkFormatProperties2 createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkFormatProperties2.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkFormatProperties2.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkFormatProperties2.Buffer create(int capacity)

Returns a new VkFormatProperties2.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkFormatProperties2.Buffer create(long address,
 int capacity)

Create a VkFormatProperties2.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkFormatProperties2.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkFormatProperties2 mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkFormatProperties2 callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkFormatProperties2 mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkFormatProperties2 callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkFormatProperties2.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkFormatProperties2.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkFormatProperties2.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkFormatProperties2.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkFormatProperties2 malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkFormatProperties2 instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkFormatProperties2 calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkFormatProperties2.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkFormatProperties2.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nformatProperties

public static VkFormatProperties nformatProperties(long struct)

Unsafe version of formatProperties().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.