Package org.lwjgl.vulkan

Class VkDebugUtilsLabelEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkDebugUtilsLabelEXT>
org.lwjgl.vulkan.VkDebugUtilsLabelEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkDebugUtilsLabelEXT extends org.lwjgl.system.Struct<VkDebugUtilsLabelEXT> implements org.lwjgl.system.NativeResource
Specify parameters of a label region.
Valid Usage (Implicit)
See Also

VkDebugUtilsMessengerCallbackDataEXT, CmdBeginDebugUtilsLabelEXT, CmdInsertDebugUtilsLabelEXT, QueueBeginDebugUtilsLabelEXT, QueueInsertDebugUtilsLabelEXT

Layout


 struct VkDebugUtilsLabelEXT {
     VkStructureType sType();
     void const * pNext();
     char const * pLabelName();
     float color()[4];
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • STYPE

      public static final int STYPE
      The struct member offsets.

    • PNEXT

      public static final int PNEXT
      The struct member offsets.

    • PLABELNAME

      public static final int PLABELNAME
      The struct member offsets.

    • COLOR

      public static final int COLOR
      The struct member offsets.

  • Constructor Details

    • VkDebugUtilsLabelEXT

      public VkDebugUtilsLabelEXT(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 Details

    • sizeof

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

    • sType

      public int sType()
      a VkStructureType value identifying this structure.

    • pNext

      public long pNext()
      NULL or a pointer to a structure extending this structure.

    • pLabelName

      public ByteBuffer pLabelName()
      a pointer to a null-terminated UTF-8 string containing the name of the label.

    • pLabelNameString

      public String pLabelNameString()
      a pointer to a null-terminated UTF-8 string containing the name of the label.

    • color

      public FloatBuffer color()
      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 0.0, then it is ignored.

    • color

      public float color(int index)
      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 0.0, then it is ignored.

    • sType

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

    • sType$Default

      public VkDebugUtilsLabelEXT sType$Default()
      Sets the STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT value to the sType() field.

    • pNext

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

    • pLabelName

      public VkDebugUtilsLabelEXT pLabelName(ByteBuffer value)
      Sets the address of the specified encoded string to the pLabelName() field.

    • color

      public VkDebugUtilsLabelEXT color(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, ByteBuffer pLabelName, FloatBuffer color)
      Initializes this struct with the specified values.

    • set

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

    • 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

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • mallocStack

      @Deprecated public static VkDebugUtilsLabelEXT mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkDebugUtilsLabelEXT callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkDebugUtilsLabelEXT mallocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkDebugUtilsLabelEXT callocStack(org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkDebugUtilsLabelEXT.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkDebugUtilsLabelEXT.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkDebugUtilsLabelEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkDebugUtilsLabelEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • malloc

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

    • calloc

      public static VkDebugUtilsLabelEXT calloc(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

    • malloc

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

    • calloc

      public static VkDebugUtilsLabelEXT.Buffer calloc(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:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • 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 ByteBuffer npLabelName(long struct)
      Unsafe version of pLabelName().

    • npLabelNameString

      public static String npLabelNameString(long struct)
      Unsafe version of pLabelNameString().

    • ncolor

      public static 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, ByteBuffer value)
      Unsafe version of pLabelName.

    • ncolor

      public static void ncolor(long struct, 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