Package org.lwjgl.vulkan

Class VkLayerProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkLayerProperties>

org.lwjgl.vulkan.VkLayerProperties

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkLayerProperties
extends Struct<VkLayerProperties>
implements NativeResource

Structure specifying layer properties.

See Also

EnumerateDeviceLayerProperties, EnumerateInstanceLayerProperties

Layout

 struct VkLayerProperties {
     char layerName()[VK_MAX_EXTENSION_NAME_SIZE];
     uint32_t specVersion();
     uint32_t implementationVersion();
     char description()[VK_MAX_DESCRIPTION_SIZE];
 }

Nested Class Summary

Nested Classes

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

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DESCRIPTION	The struct member offsets.
static final int	IMPLEMENTATIONVERSION	The struct member offsets.
static final int	LAYERNAME	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SPECVERSION	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
VkLayerProperties(ByteBuffer container)	Creates a VkLayerProperties instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkLayerProperties	calloc()	Returns a new VkLayerProperties instance allocated with memCalloc.
static VkLayerProperties.Buffer	calloc(int capacity)	Returns a new VkLayerProperties.Buffer instance allocated with memCalloc.
static VkLayerProperties.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkLayerProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkLayerProperties	calloc(MemoryStack stack)	Returns a new VkLayerProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkLayerProperties	callocStack()	Deprecated.
static VkLayerProperties.Buffer	callocStack(int capacity)	Deprecated.
static VkLayerProperties.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkLayerProperties	callocStack(MemoryStack stack)	Deprecated.
static VkLayerProperties	create()	Returns a new VkLayerProperties instance allocated with BufferUtils.
static VkLayerProperties.Buffer	create(int capacity)	Returns a new VkLayerProperties.Buffer instance allocated with BufferUtils.
static VkLayerProperties	create(long address)	Returns a new VkLayerProperties instance for the specified memory address.
static VkLayerProperties.Buffer	create(long address, int capacity)	Create a VkLayerProperties.Buffer instance at the specified memory.
static VkLayerProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static VkLayerProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
ByteBuffer	description()	an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which provides additional details that can be used by the application to identify the layer.
String	descriptionString()	an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which provides additional details that can be used by the application to identify the layer.
int	implementationVersion()	the version of this layer.
ByteBuffer	layerName()	an array of MAX_EXTENSION_NAME_SIZE char containing a null-terminated UTF-8 string which is the name of the layer.
String	layerNameString()	an array of MAX_EXTENSION_NAME_SIZE char containing a null-terminated UTF-8 string which is the name of the layer.
static VkLayerProperties	malloc()	Returns a new VkLayerProperties instance allocated with memAlloc.
static VkLayerProperties.Buffer	malloc(int capacity)	Returns a new VkLayerProperties.Buffer instance allocated with memAlloc.
static VkLayerProperties.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkLayerProperties.Buffer instance allocated on the specified MemoryStack.
static VkLayerProperties	malloc(MemoryStack stack)	Returns a new VkLayerProperties instance allocated on the specified MemoryStack.
static VkLayerProperties	mallocStack()	Deprecated.
static VkLayerProperties.Buffer	mallocStack(int capacity)	Deprecated.
static VkLayerProperties.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkLayerProperties	mallocStack(MemoryStack stack)	Deprecated.
static ByteBuffer	ndescription(long struct)	Unsafe version of description().
static String	ndescriptionString(long struct)	Unsafe version of descriptionString().
static int	nimplementationVersion(long struct)	Unsafe version of implementationVersion().
static ByteBuffer	nlayerName(long struct)	Unsafe version of layerName().
static String	nlayerNameString(long struct)	Unsafe version of layerNameString().
static int	nspecVersion(long struct)	Unsafe version of specVersion().
int	sizeof()	Returns sizeof(struct).
int	specVersion()	the Vulkan version the layer was written to, encoded as described in Version Numbers.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

LAYERNAME

public static final int LAYERNAME

The struct member offsets.

SPECVERSION

public static final int SPECVERSION

The struct member offsets.

IMPLEMENTATIONVERSION

public static final int IMPLEMENTATIONVERSION

The struct member offsets.

DESCRIPTION

public static final int DESCRIPTION

The struct member offsets.

Constructor Details

VkLayerProperties

public VkLayerProperties(ByteBuffer container)

Creates a VkLayerProperties 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<VkLayerProperties>

layerName

public ByteBuffer layerName()

an array of MAX_EXTENSION_NAME_SIZE char containing a null-terminated UTF-8 string which is the name of the layer. Use this name in the ppEnabledLayerNames array passed in the VkInstanceCreateInfo structure to enable this layer for an instance.

layerNameString

public String layerNameString()

an array of MAX_EXTENSION_NAME_SIZE char containing a null-terminated UTF-8 string which is the name of the layer. Use this name in the ppEnabledLayerNames array passed in the VkInstanceCreateInfo structure to enable this layer for an instance.

specVersion

public int specVersion()

the Vulkan version the layer was written to, encoded as described in Version Numbers.

implementationVersion

public int implementationVersion()

the version of this layer. It is an integer, increasing with backward compatible changes.

description

public ByteBuffer description()

an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which provides additional details that can be used by the application to identify the layer.

descriptionString

public String descriptionString()

an array of MAX_DESCRIPTION_SIZE char containing a null-terminated UTF-8 string which provides additional details that can be used by the application to identify the layer.

malloc

public static VkLayerProperties malloc()

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

calloc

public static VkLayerProperties calloc()

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

create

public static VkLayerProperties create()

Returns a new VkLayerProperties instance allocated with BufferUtils.

create

public static VkLayerProperties create(long address)

Returns a new VkLayerProperties instance for the specified memory address.

createSafe

@Nullable
public static VkLayerProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkLayerProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkLayerProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkLayerProperties.Buffer create(int capacity)

Returns a new VkLayerProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkLayerProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkLayerProperties mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkLayerProperties callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkLayerProperties mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkLayerProperties callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkLayerProperties.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkLayerProperties.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkLayerProperties malloc(MemoryStack stack)

Returns a new VkLayerProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkLayerProperties calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkLayerProperties.Buffer calloc(int capacity,
 MemoryStack stack)

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

nlayerName

public static ByteBuffer nlayerName(long struct)

Unsafe version of layerName().

nlayerNameString

public static String nlayerNameString(long struct)

Unsafe version of layerNameString().

nspecVersion

public static int nspecVersion(long struct)

Unsafe version of specVersion().

nimplementationVersion

public static int nimplementationVersion(long struct)

Unsafe version of implementationVersion().

ndescription

public static ByteBuffer ndescription(long struct)

Unsafe version of description().

ndescriptionString

public static String ndescriptionString(long struct)

Unsafe version of descriptionString().