Package org.lwjgl.vulkan
Class VkLayerProperties
- 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]
– a null-terminated UTF-8 string specifying the name of the layer. Use this name in theppEnabledLayerNames
array passed in theVkInstanceCreateInfo
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]
– a null-terminated UTF-8 string providing 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 Description static class
VkLayerProperties.Buffer
An array ofVkLayerProperties
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
DESCRIPTION
IMPLEMENTATIONVERSION
LAYERNAMEThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
SPECVERSION
The struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkLayerProperties(java.nio.ByteBuffer container)
Creates aVkLayerProperties
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkLayerProperties
calloc()
Returns a newVkLayerProperties
instance allocated withmemCalloc
.static VkLayerProperties.Buffer
calloc(int capacity)
Returns a newVkLayerProperties.Buffer
instance allocated withmemCalloc
.static VkLayerProperties
callocStack()
Returns a newVkLayerProperties
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkLayerProperties.Buffer
callocStack(int capacity)
Returns a newVkLayerProperties.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkLayerProperties.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkLayerProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkLayerProperties
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkLayerProperties
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkLayerProperties
create()
Returns a newVkLayerProperties
instance allocated withBufferUtils
.static VkLayerProperties.Buffer
create(int capacity)
Returns a newVkLayerProperties.Buffer
instance allocated withBufferUtils
.static VkLayerProperties
create(long address)
Returns a newVkLayerProperties
instance for the specified memory address.static VkLayerProperties.Buffer
create(long address, int capacity)
Create aVkLayerProperties.Buffer
instance at the specified memory.static VkLayerProperties
createSafe(long address)
static VkLayerProperties.Buffer
createSafe(long address, int capacity)
java.nio.ByteBuffer
description()
Returns aByteBuffer
view of thedescription
field.java.lang.String
descriptionString()
Decodes the null-terminated string stored in thedescription
field.int
implementationVersion()
Returns the value of theimplementationVersion
field.java.nio.ByteBuffer
layerName()
Returns aByteBuffer
view of thelayerName
field.java.lang.String
layerNameString()
Decodes the null-terminated string stored in thelayerName
field.static VkLayerProperties
malloc()
Returns a newVkLayerProperties
instance allocated withmemAlloc
.static VkLayerProperties.Buffer
malloc(int capacity)
Returns a newVkLayerProperties.Buffer
instance allocated withmemAlloc
.static VkLayerProperties
mallocStack()
Returns a newVkLayerProperties
instance allocated on the thread-localMemoryStack
.static VkLayerProperties.Buffer
mallocStack(int capacity)
Returns a newVkLayerProperties.Buffer
instance allocated on the thread-localMemoryStack
.static VkLayerProperties.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkLayerProperties.Buffer
instance allocated on the specifiedMemoryStack
.static VkLayerProperties
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkLayerProperties
instance allocated on the specifiedMemoryStack
.static java.nio.ByteBuffer
ndescription(long struct)
Unsafe version ofdescription()
.static java.lang.String
ndescriptionString(long struct)
Unsafe version ofdescriptionString()
.static int
nimplementationVersion(long struct)
Unsafe version ofimplementationVersion()
.static java.nio.ByteBuffer
nlayerName(long struct)
Unsafe version oflayerName()
.static java.lang.String
nlayerNameString(long struct)
Unsafe version oflayerNameString()
.static int
nspecVersion(long struct)
Unsafe version ofspecVersion()
.int
sizeof()
int
specVersion()
Returns the value of thespecVersion
field.
-
-
-
Constructor Detail
-
VkLayerProperties
public VkLayerProperties(java.nio.ByteBuffer container)
Creates aVkLayerProperties
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
layerName
public java.nio.ByteBuffer layerName()
Returns aByteBuffer
view of thelayerName
field.
-
layerNameString
public java.lang.String layerNameString()
Decodes the null-terminated string stored in thelayerName
field.
-
specVersion
public int specVersion()
Returns the value of thespecVersion
field.
-
implementationVersion
public int implementationVersion()
Returns the value of theimplementationVersion
field.
-
description
public java.nio.ByteBuffer description()
Returns aByteBuffer
view of thedescription
field.
-
descriptionString
public java.lang.String descriptionString()
Decodes the null-terminated string stored in thedescription
field.
-
malloc
public static VkLayerProperties malloc()
Returns a newVkLayerProperties
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkLayerProperties calloc()
Returns a newVkLayerProperties
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkLayerProperties create()
Returns a newVkLayerProperties
instance allocated withBufferUtils
.
-
create
public static VkLayerProperties create(long address)
Returns a newVkLayerProperties
instance for the specified memory address.
-
createSafe
@Nullable public static VkLayerProperties createSafe(long address)
-
malloc
public static VkLayerProperties.Buffer malloc(int capacity)
Returns a newVkLayerProperties.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkLayerProperties.Buffer calloc(int capacity)
Returns a newVkLayerProperties.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkLayerProperties.Buffer create(int capacity)
Returns a newVkLayerProperties.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkLayerProperties.Buffer create(long address, int capacity)
Create aVkLayerProperties.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkLayerProperties.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkLayerProperties mallocStack()
Returns a newVkLayerProperties
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkLayerProperties callocStack()
Returns a newVkLayerProperties
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkLayerProperties mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkLayerProperties
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkLayerProperties callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkLayerProperties
instance allocated on the specifiedMemoryStack
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 newVkLayerProperties.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkLayerProperties.Buffer callocStack(int capacity)
Returns a newVkLayerProperties.Buffer
instance allocated on the thread-localMemoryStack
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 newVkLayerProperties.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkLayerProperties.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkLayerProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nlayerName
public static java.nio.ByteBuffer nlayerName(long struct)
Unsafe version oflayerName()
.
-
nlayerNameString
public static java.lang.String nlayerNameString(long struct)
Unsafe version oflayerNameString()
.
-
nspecVersion
public static int nspecVersion(long struct)
Unsafe version ofspecVersion()
.
-
nimplementationVersion
public static int nimplementationVersion(long struct)
Unsafe version ofimplementationVersion()
.
-
ndescription
public static java.nio.ByteBuffer ndescription(long struct)
Unsafe version ofdescription()
.
-
ndescriptionString
public static java.lang.String ndescriptionString(long struct)
Unsafe version ofdescriptionString()
.
-
-