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, NativeResource, Pointer
public class VkLayerProperties extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about an instance layer.
Member documentation
layerName
– 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 toimplementationVersion
– the version of this layerdescription
– a null-terminated UTF-8 string providing additional details that can be used by the application to identify the layer
Layout
struct VkLayerProperties { char[256] layerName; uint32_t specVersion; uint32_t implementationVersion; char[256] description; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkLayerProperties.Buffer
An array ofVkLayerProperties
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and 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 and 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, MemoryStack stack)
Returns a newVkLayerProperties.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkLayerProperties
callocStack(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 ornull
if the address isNULL
.static VkLayerProperties.Buffer
create(long address, int capacity)
Create aVkLayerProperties.Buffer
instance at the specified memory.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, MemoryStack stack)
Returns a newVkLayerProperties.Buffer
instance allocated on the specifiedMemoryStack
.static VkLayerProperties
mallocStack(MemoryStack stack)
Returns a newVkLayerProperties
instance allocated on the specifiedMemoryStack
.int
sizeof()
Returns thesizeof(struct)
.int
specVersion()
Returns the value of thespecVersion
field.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
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()
Description copied from class:Struct
Returns thesizeof(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 ornull
if the address isNULL
.
-
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
-
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(MemoryStack stack)
Returns a newVkLayerProperties
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkLayerProperties callocStack(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, 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, 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
-
-