Class VkDebugUtilsLabelEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDebugUtilsLabelEXT>

org.lwjgl.vulkan.VkDebugUtilsLabelEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDebugUtilsLabelEXT
extends Struct<VkDebugUtilsLabelEXT>
implements NativeResource

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

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

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkDebugUtilsLabelEXT(ByteBuffer container)	Creates a VkDebugUtilsLabelEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDebugUtilsLabelEXT	calloc(MemoryStack stack)	Returns a new VkDebugUtilsLabelEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
FloatBuffer	color()
float	color(int index)
VkDebugUtilsLabelEXT	color(int index, float value)	Sets the specified value at the specified index of the color field.
VkDebugUtilsLabelEXT	color(FloatBuffer value)	Copies the specified FloatBuffer to 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 @Nullable VkDebugUtilsLabelEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable 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.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDebugUtilsLabelEXT.Buffer instance allocated on the specified MemoryStack.
static VkDebugUtilsLabelEXT	malloc(MemoryStack stack)	Returns a new VkDebugUtilsLabelEXT instance allocated on the specified MemoryStack.
static FloatBuffer	ncolor(long struct)	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 void	ncolor(long struct, FloatBuffer value)	Unsafe version of color.
static ByteBuffer	npLabelName(long struct)	Unsafe version of pLabelName().
static void	npLabelName(long struct, ByteBuffer value)	Unsafe version of pLabelName.
static 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.
ByteBuffer	pLabelName()
VkDebugUtilsLabelEXT	pLabelName(ByteBuffer value)	Sets the address of the specified encoded string to the pLabelName field.
String	pLabelNameString()
long	pNext()
VkDebugUtilsLabelEXT	pNext(long value)	Sets the specified value to the pNext field.
VkDebugUtilsLabelEXT	set(int sType, long pNext, ByteBuffer pLabelName, FloatBuffer color)	Initializes this struct with the specified values.
VkDebugUtilsLabelEXT	set(VkDebugUtilsLabelEXT src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkDebugUtilsLabelEXT	sType(int value)	Sets the specified value to the sType field.
VkDebugUtilsLabelEXT	sType$Default()	Sets the STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT value to the sType field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDebugUtilsLabelEXT>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void const *")
public long pNext()

Returns:

the value of the pNext field.

pLabelName

@NativeType("char const *")
public ByteBuffer pLabelName()

Returns:

a ByteBuffer view of the null-terminated string pointed to by the pLabelName field.

pLabelNameString

@NativeType("char const *")
public String pLabelNameString()

Returns:

the null-terminated string pointed to by the pLabelName field.

color

@NativeType("float[4]")
public 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(@NativeType("VkStructureType")
 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(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

pLabelName

public VkDebugUtilsLabelEXT pLabelName(@NativeType("char const *")
 ByteBuffer value)

Sets the address of the specified encoded string to the pLabelName field.

color

public VkDebugUtilsLabelEXT color(@NativeType("float[4]")
 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.

malloc

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