Class VkDebugUtilsLabelEXT

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

    public class VkDebugUtilsLabelEXT
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Specify parameters of a label region.
    Valid Usage (Implicit)
    See Also

    VkDebugUtilsMessengerCallbackDataEXT, CmdBeginDebugUtilsLabelEXT, CmdInsertDebugUtilsLabelEXT, QueueBeginDebugUtilsLabelEXT, QueueInsertDebugUtilsLabelEXT

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • pLabelName – a pointer to a null-terminated UTF-8 string that contains the name of the label.
    • color[4] – an optional RGBA color value that can be associated with the label. A particular implementation may choose to ignore this color value. The values contain RGBA values in order, in the range 0.0 to 1.0. If all elements in color are set to 0.0 then it is ignored.

    Layout

    
     struct VkDebugUtilsLabelEXT {
         VkStructureType sType;
         void const * pNext;
         char const * pLabelName;
         float color[4];
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, PLABELNAME, COLOR

        The struct member offsets.
    • Constructor Detail

      • VkDebugUtilsLabelEXT

        public VkDebugUtilsLabelEXT​(java.nio.ByteBuffer container)
        Creates a VkDebugUtilsLabelEXT 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()
        Specified by:
        sizeof in class org.lwjgl.system.Struct
      • sType

        public int sType()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • pLabelName

        public java.nio.ByteBuffer pLabelName()
        Returns a ByteBuffer view of the null-terminated string pointed to by the pLabelName field.
      • pLabelNameString

        public java.lang.String pLabelNameString()
        Decodes the null-terminated string pointed to by the pLabelName field.
      • color

        public java.nio.FloatBuffer color()
        Returns a FloatBuffer view of the color field.
      • color

        public float color​(int index)
        Returns the value at the specified index of the color field.
      • sType

        public VkDebugUtilsLabelEXT sType​(int value)
        Sets the specified value to the sType field.
      • pNext

        public VkDebugUtilsLabelEXT pNext​(long value)
        Sets the specified value to the pNext field.
      • pLabelName

        public VkDebugUtilsLabelEXT pLabelName​(java.nio.ByteBuffer value)
        Sets the address of the specified encoded string to the pLabelName field.
      • color

        public VkDebugUtilsLabelEXT color​(java.nio.FloatBuffer value)
        Copies the specified FloatBuffer to the color field.
      • color

        public VkDebugUtilsLabelEXT color​(int index,
                                          float value)
        Sets the specified value at the specified index of the color field.
      • set

        public VkDebugUtilsLabelEXT set​(int sType,
                                        long pNext,
                                        java.nio.ByteBuffer pLabelName,
                                        java.nio.FloatBuffer color)
        Initializes this struct with the specified values.
      • malloc

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

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

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

        public static VkDebugUtilsLabelEXT create​(long address)
        Returns a new VkDebugUtilsLabelEXT instance for the specified memory address.
      • createSafe

        @Nullable
        public static VkDebugUtilsLabelEXT createSafe​(long address)
        Like create, but returns null if address is NULL.
      • mallocStack

        public static VkDebugUtilsLabelEXT mallocStack()
        Returns a new VkDebugUtilsLabelEXT instance allocated on the thread-local MemoryStack.
      • callocStack

        public static VkDebugUtilsLabelEXT callocStack()
        Returns a new VkDebugUtilsLabelEXT instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static VkDebugUtilsLabelEXT mallocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkDebugUtilsLabelEXT instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

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

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

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

        public static int nsType​(long struct)
        Unsafe version of sType().
      • npNext

        public static long npNext​(long struct)
        Unsafe version of pNext().
      • npLabelName

        public static java.nio.ByteBuffer npLabelName​(long struct)
        Unsafe version of pLabelName().
      • npLabelNameString

        public static java.lang.String npLabelNameString​(long struct)
        Unsafe version of pLabelNameString().
      • ncolor

        public static java.nio.FloatBuffer ncolor​(long struct)
        Unsafe version of color().
      • ncolor

        public static float ncolor​(long struct,
                                   int index)
        Unsafe version of color.
      • nsType

        public static void nsType​(long struct,
                                  int value)
        Unsafe version of sType.
      • npNext

        public static void npNext​(long struct,
                                  long value)
        Unsafe version of pNext.
      • npLabelName

        public static void npLabelName​(long struct,
                                       java.nio.ByteBuffer value)
        Unsafe version of pLabelName.
      • ncolor

        public static void ncolor​(long struct,
                                  java.nio.FloatBuffer value)
        Unsafe version of color.
      • ncolor

        public static void ncolor​(long struct,
                                  int index,
                                  float value)
        Unsafe version of color.
      • validate

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

        public static void validate​(long array,
                                    int count)
        Calls validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array