Class VkLayerProperties

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkLayerProperties
    extends Struct
    implements 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 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] – 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];
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • LAYERNAME, SPECVERSION, IMPLEMENTATIONVERSION, 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class 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​(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.
      • 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​(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​(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
      • 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().