VkDebugUtilsLabelEXT (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.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)
- sType must be STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT
- pNext must be NULL
- pLabelName must be a null-terminated UTF-8 string
See Also

VkDebugUtilsMessengerCallbackDataEXT, CmdBeginDebugUtilsLabelEXT, CmdInsertDebugUtilsLabelEXT, QueueBeginDebugUtilsLabelEXT, QueueInsertDebugUtilsLabelEXT

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- pLabelName – a pointer to a null-terminated UTF-8 string containing 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];
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkDebugUtilsLabelEXT.Buffer
An array of VkDebugUtilsLabelEXT structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkDebugUtilsLabelEXT.Buffer` An array of `VkDebugUtilsLabelEXT` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`COLOR` The struct member offsets.
`static int`	`PLABELNAME` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkDebugUtilsLabelEXT(java.nio.ByteBuffer container)` Creates a `VkDebugUtilsLabelEXT` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkDebugUtilsLabelEXT`	`calloc()` Returns a new `VkDebugUtilsLabelEXT` instance allocated with `memCalloc`.
`static VkDebugUtilsLabelEXT.Buffer`	`calloc(int capacity)` Returns a new `VkDebugUtilsLabelEXT.Buffer` instance allocated with `memCalloc`.
`static VkDebugUtilsLabelEXT`	`callocStack()` Returns a new `VkDebugUtilsLabelEXT` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDebugUtilsLabelEXT.Buffer`	`callocStack(int capacity)` Returns a new `VkDebugUtilsLabelEXT.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`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.
`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.
`java.nio.FloatBuffer`	`color()` Returns a `FloatBuffer` view of the `color` field.
`VkDebugUtilsLabelEXT`	`color(java.nio.FloatBuffer value)` Copies the specified `FloatBuffer` to the `color` field.
`float`	`color(int index)` Returns the value at the specified index of the `color` field.
`VkDebugUtilsLabelEXT`	`color(int index, float value)` Sets the specified value at the specified index of the `color` field.
`static VkDebugUtilsLabelEXT`	`create()` Returns a new `VkDebugUtilsLabelEXT` instance allocated with `BufferUtils`.
`static VkDebugUtilsLabelEXT.Buffer`	`create(int capacity)` Returns a new `VkDebugUtilsLabelEXT.Buffer` instance allocated with `BufferUtils`.
`static VkDebugUtilsLabelEXT`	`create(long address)` Returns a new `VkDebugUtilsLabelEXT` instance for the specified memory address.
`static VkDebugUtilsLabelEXT.Buffer`	`create(long address, int capacity)` Create a `VkDebugUtilsLabelEXT.Buffer` instance at the specified memory.
`static VkDebugUtilsLabelEXT`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDebugUtilsLabelEXT.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDebugUtilsLabelEXT`	`malloc()` Returns a new `VkDebugUtilsLabelEXT` instance allocated with `memAlloc`.
`static VkDebugUtilsLabelEXT.Buffer`	`malloc(int capacity)` Returns a new `VkDebugUtilsLabelEXT.Buffer` instance allocated with `memAlloc`.
`static VkDebugUtilsLabelEXT`	`mallocStack()` Returns a new `VkDebugUtilsLabelEXT` instance allocated on the thread-local `MemoryStack`.
`static VkDebugUtilsLabelEXT.Buffer`	`mallocStack(int capacity)` Returns a new `VkDebugUtilsLabelEXT.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDebugUtilsLabelEXT.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDebugUtilsLabelEXT.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDebugUtilsLabelEXT`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDebugUtilsLabelEXT` instance allocated on the specified `MemoryStack`.
`static java.nio.FloatBuffer`	`ncolor(long struct)` Unsafe version of `color()`.
`static void`	`ncolor(long struct, java.nio.FloatBuffer value)` Unsafe version of `color`.
`static float`	`ncolor(long struct, int index)` Unsafe version of `color`.
`static void`	`ncolor(long struct, int index, float value)` Unsafe version of `color`.
`static java.nio.ByteBuffer`	`npLabelName(long struct)` Unsafe version of `pLabelName()`.
`static void`	`npLabelName(long struct, java.nio.ByteBuffer value)` Unsafe version of `pLabelName`.
`static java.lang.String`	`npLabelNameString(long struct)` Unsafe version of `pLabelNameString()`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`java.nio.ByteBuffer`	`pLabelName()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `pLabelName` field.
`VkDebugUtilsLabelEXT`	`pLabelName(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `pLabelName` field.
`java.lang.String`	`pLabelNameString()` Decodes the null-terminated string pointed to by the `pLabelName` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkDebugUtilsLabelEXT`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkDebugUtilsLabelEXT`	`set(int sType, long pNext, java.nio.ByteBuffer pLabelName, java.nio.FloatBuffer color)` Initializes this struct with the specified values.
`VkDebugUtilsLabelEXT`	`set(VkDebugUtilsLabelEXT src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkDebugUtilsLabelEXT`	`sType(int value)` Sets the specified value to the `sType` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - 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 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.
  - 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
```
@Nullable
public static 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
```
@Nullable
public static VkDebugUtilsLabelEXT.Buffer createSafe(long address,
                                                               int capacity)
```
    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)
```
    Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDebugUtilsLabelEXT.Buffer callocStack(int capacity)
```
    Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - 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

Class VkDebugUtilsLabelEXT

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

PLABELNAME

COLOR

Constructor Detail

VkDebugUtilsLabelEXT

Method Detail

sizeof

sType

pNext

pLabelName

pLabelNameString

color

color

sType

pNext

pLabelName

color

color

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

npLabelName

npLabelNameString

ncolor

ncolor

nsType

npNext

npLabelName

ncolor

ncolor

validate

validate