Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkLayerProperties

extends Struct<VkLayerProperties>
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 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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkLayerProperties.Buffer

An array of VkLayerProperties structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DESCRIPTION

The struct member offsets.

public static final int
IMPLEMENTATIONVERSION

The struct member offsets.

public static final int
LAYERNAME

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SPECVERSION

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
VkLayerProperties(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkLayerProperties
calloc()

Returns a new VkLayerProperties instance allocated with memCalloc.

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

Returns a new VkLayerProperties.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkLayerProperties
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
protected VkLayerProperties
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 VkLayerProperties
create()

Returns a new VkLayerProperties instance allocated with BufferUtils.

public static VkLayerProperties
create(long address)

Returns a new VkLayerProperties instance for the specified memory address.

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

Returns a new VkLayerProperties.Buffer instance allocated with BufferUtils.

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

Create a VkLayerProperties.Buffer instance at the specified memory.

public static VkLayerProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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.

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.

public int
implementationVersion()

the version of this layer.

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.

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.

public static VkLayerProperties
malloc()

Returns a new VkLayerProperties instance allocated with memAlloc.

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

Returns a new VkLayerProperties.Buffer instance allocated with memAlloc.

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

Returns a new VkLayerProperties instance allocated on the specified MemoryStack.

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

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

public static VkLayerProperties
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static ByteBuffer
ndescription(long struct)

Unsafe version of description.

public static String
ndescriptionString(long struct)

Unsafe version of descriptionString.

public static int
nimplementationVersion(long struct)

Unsafe version of implementationVersion.

public static ByteBuffer
nlayerName(long struct)

Unsafe version of layerName.

public static String
nlayerNameString(long struct)

Unsafe version of layerNameString.

public static int
nspecVersion(long struct)

Unsafe version of specVersion.

public int
sizeof()

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

Returns sizeof(struct).
public int
specVersion()

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

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.

DESCRIPTIONback to summary
public static final int DESCRIPTION

The struct member offsets.

IMPLEMENTATIONVERSIONback to summary
public static final int IMPLEMENTATIONVERSION

The struct member offsets.

LAYERNAMEback to summary
public static final int LAYERNAME

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SPECVERSIONback to summary
public static final int SPECVERSION

The struct member offsets.

Constructor Detail

VkLayerPropertiesback to summary
protected VkLayerProperties(long address, ByteBuffer container)
VkLayerPropertiesback to summary
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 Detail

callocback to summary
public static VkLayerProperties calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
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:MemoryStack

the stack from which to allocate

callocback to summary
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:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkLayerProperties callocStack()

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkLayerProperties.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 VkLayerProperties 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 VkLayerProperties create()

Returns a new VkLayerProperties instance allocated with BufferUtils.

createback to summary
public static VkLayerProperties create(long address)

Returns a new VkLayerProperties instance for the specified memory address.

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

Returns a new VkLayerProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkLayerProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkLayerProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
descriptionback to summary
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.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
descriptionStringback to summary
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.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
implementationVersionback to summary
public int implementationVersion()

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

Annotations
@NativeType:uint32_t
layerNameback to summary
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.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
layerNameStringback to summary
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.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
mallocback to summary
public static VkLayerProperties malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkLayerProperties malloc(MemoryStack stack)

Returns a new VkLayerProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ndescriptionback to summary
public static ByteBuffer ndescription(long struct)

Unsafe version of description.

ndescriptionStringback to summary
public static String ndescriptionString(long struct)

Unsafe version of descriptionString.

nimplementationVersionback to summary
public static int nimplementationVersion(long struct)

Unsafe version of implementationVersion.

nlayerNameback to summary
public static ByteBuffer nlayerName(long struct)

Unsafe version of layerName.

nlayerNameStringback to summary
public static String nlayerNameString(long struct)

Unsafe version of layerNameString.

nspecVersionback to summary
public static int nspecVersion(long struct)

Unsafe version of specVersion.

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
specVersionback to summary
public int specVersion()

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

Annotations
@NativeType:uint32_t
org.lwjgl.vulkan back to summary

public Class VkLayerProperties.Buffer

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

Field Summary

Modifier and TypeField and Description
private static final VkLayerProperties
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

Returns:

a ByteBuffer view of the VkLayerProperties#description field.
description()

public String

Returns:

the null-terminated string stored in the VkLayerProperties#description field.
descriptionString()

protected VkLayerProperties
getElementFactory()

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

public int

Returns:

the value of the VkLayerProperties#implementationVersion field.
implementationVersion()

public ByteBuffer

Returns:

a ByteBuffer view of the VkLayerProperties#layerName field.
layerName()

public String

Returns:

the null-terminated string stored in the VkLayerProperties#layerName field.
layerNameString()

protected VkLayerProperties.Buffer
self()

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

public int

Returns:

the value of the VkLayerProperties#specVersion field.
specVersion()

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkLayerProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

descriptionback to summary
public ByteBuffer description()
Returns:ByteBuffer

a ByteBuffer view of the VkLayerProperties#description field.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
descriptionStringback to summary
public String descriptionString()
Returns:String

the null-terminated string stored in the VkLayerProperties#description field.

Annotations
@NativeType:char[VK_MAX_DESCRIPTION_SIZE]
getElementFactoryback to summary
protected VkLayerProperties getElementFactory()

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

Annotations
@Override
implementationVersionback to summary
public int implementationVersion()
Returns:int

the value of the VkLayerProperties#implementationVersion field.

Annotations
@NativeType:uint32_t
layerNameback to summary
public ByteBuffer layerName()
Returns:ByteBuffer

a ByteBuffer view of the VkLayerProperties#layerName field.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
layerNameStringback to summary
public String layerNameString()
Returns:String

the null-terminated string stored in the VkLayerProperties#layerName field.

Annotations
@NativeType:char[VK_MAX_EXTENSION_NAME_SIZE]
selfback to summary
protected VkLayerProperties.Buffer self()

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

Annotations
@Override
specVersionback to summary
public int specVersion()
Returns:int

the value of the VkLayerProperties#specVersion field.

Annotations
@NativeType:uint32_t