Class VkFormatProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkFormatProperties>

org.lwjgl.vulkan.VkFormatProperties

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkFormatProperties
extends Struct<VkFormatProperties>
implements NativeResource

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	BUFFERFEATURES	The struct member offsets.
static final int	LINEARTILINGFEATURES	The struct member offsets.
static final int	OPTIMALTILINGFEATURES	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	bufferFeatures()
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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkFormatProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkFormatProperties	calloc(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 @Nullable VkFormatProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkFormatProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	linearTilingFeatures()
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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkFormatProperties.Buffer instance allocated on the specified MemoryStack.
static VkFormatProperties	malloc(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()
int	sizeof()	Returns sizeof(struct).

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

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 Details

VkFormatProperties

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkFormatProperties>

linearTilingFeatures

@NativeType("VkFormatFeatureFlags")
public int linearTilingFeatures()

Returns:

the value of the linearTilingFeatures field.

optimalTilingFeatures

@NativeType("VkFormatFeatureFlags")
public int optimalTilingFeatures()

Returns:

the value of the optimalTilingFeatures field.

bufferFeatures

@NativeType("VkFormatFeatureFlags")
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

public static @Nullable 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

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

Like create, but returns null if address is NULL.

malloc

public static VkFormatProperties malloc(MemoryStack stack)

Returns a new VkFormatProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate

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().