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 theppEnabledLayerNamesarray passed in theVkInstanceCreateInfostructure 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 classVkLayerProperties.BufferAn array ofVkLayerPropertiesstructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe 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 aVkLayerPropertiesinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkLayerPropertiescalloc()Returns a newVkLayerPropertiesinstance allocated withmemCalloc.static VkLayerProperties.Buffercalloc(int capacity)Returns a newVkLayerProperties.Bufferinstance allocated withmemCalloc.static VkLayerPropertiescallocStack()Returns a newVkLayerPropertiesinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkLayerProperties.BuffercallocStack(int capacity)Returns a newVkLayerProperties.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkLayerProperties.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkLayerProperties.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkLayerPropertiescallocStack(MemoryStack stack)Returns a newVkLayerPropertiesinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkLayerPropertiescreate()Returns a newVkLayerPropertiesinstance allocated withBufferUtils.static VkLayerProperties.Buffercreate(int capacity)Returns a newVkLayerProperties.Bufferinstance allocated withBufferUtils.static VkLayerPropertiescreate(long address)Returns a newVkLayerPropertiesinstance for the specified memory address ornullif the address isNULL.static VkLayerProperties.Buffercreate(long address, int capacity)Create aVkLayerProperties.Bufferinstance at the specified memory.java.nio.ByteBufferdescription()Returns aByteBufferview of thedescriptionfield.java.lang.StringdescriptionString()Decodes the null-terminated string stored in thedescriptionfield.intimplementationVersion()Returns the value of theimplementationVersionfield.java.nio.ByteBufferlayerName()Returns aByteBufferview of thelayerNamefield.java.lang.StringlayerNameString()Decodes the null-terminated string stored in thelayerNamefield.static VkLayerPropertiesmalloc()Returns a newVkLayerPropertiesinstance allocated withmemAlloc.static VkLayerProperties.Buffermalloc(int capacity)Returns a newVkLayerProperties.Bufferinstance allocated withmemAlloc.static VkLayerPropertiesmallocStack()Returns a newVkLayerPropertiesinstance allocated on the thread-localMemoryStack.static VkLayerProperties.BuffermallocStack(int capacity)Returns a newVkLayerProperties.Bufferinstance allocated on the thread-localMemoryStack.static VkLayerProperties.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkLayerProperties.Bufferinstance allocated on the specifiedMemoryStack.static VkLayerPropertiesmallocStack(MemoryStack stack)Returns a newVkLayerPropertiesinstance allocated on the specifiedMemoryStack.intsizeof()Returns thesizeof(struct).intspecVersion()Returns the value of thespecVersionfield.-
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 aVkLayerPropertiesinstance at the current position of the specifiedByteBuffercontainer. 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:StructReturns thesizeof(struct).
-
layerName
public java.nio.ByteBuffer layerName()
Returns aByteBufferview of thelayerNamefield.
-
layerNameString
public java.lang.String layerNameString()
Decodes the null-terminated string stored in thelayerNamefield.
-
specVersion
public int specVersion()
Returns the value of thespecVersionfield.
-
implementationVersion
public int implementationVersion()
Returns the value of theimplementationVersionfield.
-
description
public java.nio.ByteBuffer description()
Returns aByteBufferview of thedescriptionfield.
-
descriptionString
public java.lang.String descriptionString()
Decodes the null-terminated string stored in thedescriptionfield.
-
malloc
public static VkLayerProperties malloc()
Returns a newVkLayerPropertiesinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkLayerProperties calloc()
Returns a newVkLayerPropertiesinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkLayerProperties create()
Returns a newVkLayerPropertiesinstance allocated withBufferUtils.
-
create
public static VkLayerProperties create(long address)
Returns a newVkLayerPropertiesinstance for the specified memory address ornullif the address isNULL.
-
malloc
public static VkLayerProperties.Buffer malloc(int capacity)
Returns a newVkLayerProperties.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkLayerProperties.Buffer calloc(int capacity)
Returns a newVkLayerProperties.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkLayerProperties.Buffer create(int capacity)
Returns a newVkLayerProperties.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkLayerProperties.Buffer create(long address, int capacity)
Create aVkLayerProperties.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
mallocStack
public static VkLayerProperties mallocStack()
Returns a newVkLayerPropertiesinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkLayerProperties callocStack()
Returns a newVkLayerPropertiesinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkLayerProperties mallocStack(MemoryStack stack)
Returns a newVkLayerPropertiesinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkLayerProperties callocStack(MemoryStack stack)
Returns a newVkLayerPropertiesinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkLayerProperties.Buffer callocStack(int capacity)
Returns a newVkLayerProperties.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkLayerProperties.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkLayerProperties.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-