VkLayerProperties (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkLayerProperties

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkLayerProperties
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying layer properties.
Member documentation
- layerName[VK_MAX_EXTENSION_NAME_SIZE] – 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 – the Vulkan version the layer was written to, encoded as described in Version Numbers.
- implementationVersion – the version of this layer. It is an integer, increasing with backward compatible changes.
- description[VK_MAX_DESCRIPTION_SIZE] – 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.
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 and Description

static class VkLayerProperties.Buffer
An array of VkLayerProperties structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DESCRIPTION` The struct member offsets.
`static int`	`IMPLEMENTATIONVERSION` The struct member offsets.
`static int`	`LAYERNAME` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static 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 and Description

VkLayerProperties(java.nio.ByteBuffer container)
Creates a VkLayerProperties instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`VkLayerProperties(java.nio.ByteBuffer container)` Creates a `VkLayerProperties` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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`	`callocStack()` Returns a new `VkLayerProperties` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkLayerProperties.Buffer`	`callocStack(int capacity)` Returns a new `VkLayerProperties.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkLayerProperties.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkLayerProperties.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkLayerProperties`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkLayerProperties` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`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`.
`java.nio.ByteBuffer`	`description()` Returns a `ByteBuffer` view of the `description` field.
`java.lang.String`	`descriptionString()` Decodes the null-terminated string stored in the `description` field.
`int`	`implementationVersion()` Returns the value of the `implementationVersion` field.
`java.nio.ByteBuffer`	`layerName()` Returns a `ByteBuffer` view of the `layerName` field.
`java.lang.String`	`layerNameString()` Decodes the null-terminated string stored in the `layerName` field.
`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`	`mallocStack()` Returns a new `VkLayerProperties` instance allocated on the thread-local `MemoryStack`.
`static VkLayerProperties.Buffer`	`mallocStack(int capacity)` Returns a new `VkLayerProperties.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkLayerProperties.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkLayerProperties.Buffer` instance allocated on the specified `MemoryStack`.
`static VkLayerProperties`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkLayerProperties` instance allocated on the specified `MemoryStack`.
`static java.nio.ByteBuffer`	`ndescription(long struct)` Unsafe version of `description()`.
`static java.lang.String`	`ndescriptionString(long struct)` Unsafe version of `descriptionString()`.
`static int`	`nimplementationVersion(long struct)` Unsafe version of `implementationVersion()`.
`static java.nio.ByteBuffer`	`nlayerName(long struct)` Unsafe version of `layerName()`.
`static java.lang.String`	`nlayerNameString(long struct)` Unsafe version of `layerNameString()`.
`static int`	`nspecVersion(long struct)` Unsafe version of `specVersion()`.
`int`	`sizeof()`
`int`	`specVersion()` Returns the value of the `specVersion` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
  - 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 Detail
  - VkLayerProperties
```
public VkLayerProperties(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - layerName
```
public java.nio.ByteBuffer layerName()
```
    Returns a ByteBuffer view of the layerName field.
  - layerNameString
```
public java.lang.String layerNameString()
```
    Decodes the null-terminated string stored in the layerName field.
  - specVersion
```
public int specVersion()
```
    Returns the value of the specVersion field.
  - implementationVersion
```
public int implementationVersion()
```
    Returns the value of the implementationVersion field.
  - description
```
public java.nio.ByteBuffer description()
```
    Returns a ByteBuffer view of the description field.
  - descriptionString
```
public java.lang.String descriptionString()
```
    Decodes the null-terminated string stored in the description field.
  - 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
```
public static VkLayerProperties mallocStack()
```
    Returns a new VkLayerProperties instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkLayerProperties callocStack()
```
    Returns a new VkLayerProperties instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkLayerProperties mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkLayerProperties instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkLayerProperties callocStack(org.lwjgl.system.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
  - mallocStack
```
public static VkLayerProperties.Buffer mallocStack(int capacity)
```
    Returns a new VkLayerProperties.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkLayerProperties.Buffer callocStack(int capacity)
```
    Returns a new VkLayerProperties.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkLayerProperties.Buffer mallocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkLayerProperties.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkLayerProperties.Buffer callocStack(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkLayerProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nlayerName
```
public static java.nio.ByteBuffer nlayerName(long struct)
```
    Unsafe version of layerName().
  - nlayerNameString
```
public static java.lang.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 java.nio.ByteBuffer ndescription(long struct)
```
    Unsafe version of description().
  - ndescriptionString
```
public static java.lang.String ndescriptionString(long struct)
```
    Unsafe version of descriptionString().

Class VkLayerProperties

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

LAYERNAME

SPECVERSION

IMPLEMENTATIONVERSION

DESCRIPTION

Constructor Detail

VkLayerProperties

Method Detail

sizeof

layerName

layerNameString

specVersion

implementationVersion

description

descriptionString

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nlayerName

nlayerNameString

nspecVersion

nimplementationVersion

ndescription

ndescriptionString