Package org.lwjgl.vulkan

Class VkLayerSettingEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkLayerSettingEXT>
org.lwjgl.vulkan.VkLayerSettingEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkLayerSettingEXT extends org.lwjgl.system.Struct<VkLayerSettingEXT> implements org.lwjgl.system.NativeResource
Specify a layer capability to configure.
Description

When multiple VkLayerSettingsCreateInfoEXT structures are chained and the same pSettingName is referenced for the same pLayerName, the value of the first reference of the layer setting is used.

Valid Usage
  • If valueCount is not 0, pValues must be a valid pointer to an array of valueCount values of the type indicated by type
Valid Usage (Implicit)
  • pLayerName must be a null-terminated UTF-8 string
  • pSettingName must be a null-terminated UTF-8 string
  • type must be a valid VkLayerSettingTypeEXT value
See Also

VkLayerSettingsCreateInfoEXT

Layout


 struct VkLayerSettingEXT {
     char const * pLayerName();
     char const * pSettingName();
     VkLayerSettingTypeEXT type();
     uint32_t valueCount();
     void const * pValues(int);
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • PLAYERNAME

      public static final int PLAYERNAME
      The struct member offsets.

    • PSETTINGNAME

      public static final int PSETTINGNAME
      The struct member offsets.

    • TYPE

      public static final int TYPE
      The struct member offsets.

    • VALUECOUNT

      public static final int VALUECOUNT
      The struct member offsets.

    • PVALUES

      public static final int PVALUES
      The struct member offsets.

  • Constructor Details

    • VkLayerSettingEXT

      public VkLayerSettingEXT(ByteBuffer container)
      Creates a VkLayerSettingEXT 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 Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<VkLayerSettingEXT>

    • pLayerName

      public ByteBuffer pLayerName()
      a pointer to a null-terminated UTF-8 string naming the layer to configure the setting from.

    • pLayerNameString

      public String pLayerNameString()
      a pointer to a null-terminated UTF-8 string naming the layer to configure the setting from.

    • pSettingName

      public ByteBuffer pSettingName()
      a pointer to a null-terminated UTF-8 string naming the setting to configure. Values of pSettingName that are unknown to the layer are ignored.

    • pSettingNameString

      public String pSettingNameString()
      a pointer to a null-terminated UTF-8 string naming the setting to configure. Values of pSettingName that are unknown to the layer are ignored.

    • type

      public int type()
      a VkLayerSettingTypeEXT value specifying the type of the pValues values.

    • valueCount

      public int valueCount()
      the number of values used to configure the layer setting.

    • pValues

      public @Nullable ByteBuffer pValues(int capacity)
      Parameters:
      capacity - the number of elements in the returned buffer
      Returns:
      a pointer to an array of valueCount values of the type indicated by type to configure the layer setting.

    • pLayerName

      public VkLayerSettingEXT pLayerName(ByteBuffer value)
      Sets the address of the specified encoded string to the pLayerName() field.

    • pSettingName

      public VkLayerSettingEXT pSettingName(ByteBuffer value)
      Sets the address of the specified encoded string to the pSettingName() field.

    • type

      public VkLayerSettingEXT type(int value)
      Sets the specified value to the type() field.

    • valueCount

      public VkLayerSettingEXT valueCount(int value)
      Sets the specified value to the valueCount() field.

    • pValues

      public VkLayerSettingEXT pValues(@Nullable ByteBuffer value)
      Sets the address of the specified ByteBuffer to the pValues(int) field.

    • set

      public VkLayerSettingEXT set(ByteBuffer pLayerName, ByteBuffer pSettingName, int type, int valueCount, @Nullable ByteBuffer pValues)
      Initializes this struct with the specified values.

    • set

      public VkLayerSettingEXT set(VkLayerSettingEXT src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static VkLayerSettingEXT malloc()
      Returns a new VkLayerSettingEXT instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static VkLayerSettingEXT calloc()
      Returns a new VkLayerSettingEXT instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static VkLayerSettingEXT create()
      Returns a new VkLayerSettingEXT instance allocated with BufferUtils.

    • create

      public static VkLayerSettingEXT create(long address)
      Returns a new VkLayerSettingEXT instance for the specified memory address.

    • createSafe

      public static @Nullable VkLayerSettingEXT createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkLayerSettingEXT.Buffer malloc(int capacity)
      Returns a new VkLayerSettingEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkLayerSettingEXT.Buffer calloc(int capacity)
      Returns a new VkLayerSettingEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkLayerSettingEXT.Buffer create(int capacity)
      Returns a new VkLayerSettingEXT.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkLayerSettingEXT.Buffer create(long address, int capacity)
      Create a VkLayerSettingEXT.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable VkLayerSettingEXT.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkLayerSettingEXT malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkLayerSettingEXT instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static VkLayerSettingEXT calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkLayerSettingEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static VkLayerSettingEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkLayerSettingEXT.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VkLayerSettingEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkLayerSettingEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • npLayerName

      public static ByteBuffer npLayerName(long struct)
      Unsafe version of pLayerName().

    • npLayerNameString

      public static String npLayerNameString(long struct)
      Unsafe version of pLayerNameString().

    • npSettingName

      public static ByteBuffer npSettingName(long struct)
      Unsafe version of pSettingName().

    • npSettingNameString

      public static String npSettingNameString(long struct)
      Unsafe version of pSettingNameString().

    • ntype

      public static int ntype(long struct)
      Unsafe version of type().

    • nvalueCount

      public static int nvalueCount(long struct)
      Unsafe version of valueCount().

    • npValues

      public static @Nullable ByteBuffer npValues(long struct, int capacity)
      Unsafe version of pValues.

    • npLayerName

      public static void npLayerName(long struct, ByteBuffer value)
      Unsafe version of pLayerName.

    • npSettingName

      public static void npSettingName(long struct, ByteBuffer value)
      Unsafe version of pSettingName.

    • ntype

      public static void ntype(long struct, int value)
      Unsafe version of type.

    • nvalueCount

      public static void nvalueCount(long struct, int value)
      Unsafe version of valueCount.

    • npValues

      public static void npValues(long struct, @Nullable ByteBuffer value)
      Unsafe version of pValues.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate