Package org.lwjgl.vulkan

Class VkDebugMarkerMarkerInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDebugMarkerMarkerInfoEXT>

org.lwjgl.vulkan.VkDebugMarkerMarkerInfoEXT

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDebugMarkerMarkerInfoEXT
extends Struct<VkDebugMarkerMarkerInfoEXT>
implements NativeResource

Specify parameters of a command buffer marker region.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT
• pNext must be NULL
• pMarkerName must be a null-terminated UTF-8 string

See Also

CmdDebugMarkerBeginEXT, CmdDebugMarkerInsertEXT

Layout

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.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	PMARKERNAME	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 org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDebugMarkerMarkerInfoEXT	calloc()	Returns a new VkDebugMarkerMarkerInfoEXT instance allocated with memCalloc.
static VkDebugMarkerMarkerInfoEXT.Buffer	calloc(int capacity)	Returns a new VkDebugMarkerMarkerInfoEXT.Buffer instance allocated with memCalloc.
static VkDebugMarkerMarkerInfoEXT.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDebugMarkerMarkerInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDebugMarkerMarkerInfoEXT	calloc(MemoryStack stack)	Returns a new VkDebugMarkerMarkerInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDebugMarkerMarkerInfoEXT	callocStack()	Deprecated.
static VkDebugMarkerMarkerInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkDebugMarkerMarkerInfoEXT.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDebugMarkerMarkerInfoEXT	callocStack(MemoryStack stack)	Deprecated.
FloatBuffer	color()	an optional RGBA color value that can be associated with the marker.
float	color(int index)	an optional RGBA color value that can be associated with the marker.
VkDebugMarkerMarkerInfoEXT	color(int index, float value)	Sets the specified value at the specified index of the color() field.
VkDebugMarkerMarkerInfoEXT	color(FloatBuffer value)	Copies the specified FloatBuffer to the color() field.
static VkDebugMarkerMarkerInfoEXT	create()	Returns a new VkDebugMarkerMarkerInfoEXT instance allocated with BufferUtils.
static VkDebugMarkerMarkerInfoEXT.Buffer	create(int capacity)	Returns a new VkDebugMarkerMarkerInfoEXT.Buffer instance allocated with BufferUtils.
static VkDebugMarkerMarkerInfoEXT	create(long address)	Returns a new VkDebugMarkerMarkerInfoEXT instance for the specified memory address.
static VkDebugMarkerMarkerInfoEXT.Buffer	create(long address, int capacity)	Create a VkDebugMarkerMarkerInfoEXT.Buffer instance at the specified memory.
static VkDebugMarkerMarkerInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static VkDebugMarkerMarkerInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDebugMarkerMarkerInfoEXT	malloc()	Returns a new VkDebugMarkerMarkerInfoEXT instance allocated with memAlloc.
static VkDebugMarkerMarkerInfoEXT.Buffer	malloc(int capacity)	Returns a new VkDebugMarkerMarkerInfoEXT.Buffer instance allocated with memAlloc.
static VkDebugMarkerMarkerInfoEXT.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDebugMarkerMarkerInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkDebugMarkerMarkerInfoEXT	malloc(MemoryStack stack)	Returns a new VkDebugMarkerMarkerInfoEXT instance allocated on the specified MemoryStack.
static VkDebugMarkerMarkerInfoEXT	mallocStack()	Deprecated.
static VkDebugMarkerMarkerInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkDebugMarkerMarkerInfoEXT.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkDebugMarkerMarkerInfoEXT	mallocStack(MemoryStack stack)	Deprecated.
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	npMarkerName(long struct)	Unsafe version of pMarkerName().
static void	npMarkerName(long struct, ByteBuffer value)	Unsafe version of pMarkerName.
static String	npMarkerNameString(long struct)	Unsafe version of pMarkerNameString().
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	pMarkerName()	a pointer to a null-terminated UTF-8 string containing the name of the marker.
VkDebugMarkerMarkerInfoEXT	pMarkerName(ByteBuffer value)	Sets the address of the specified encoded string to the pMarkerName() field.
String	pMarkerNameString()	a pointer to a null-terminated UTF-8 string containing the name of the marker.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDebugMarkerMarkerInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkDebugMarkerMarkerInfoEXT	set(int sType, long pNext, ByteBuffer pMarkerName, FloatBuffer color)	Initializes this struct with the specified values.
VkDebugMarkerMarkerInfoEXT	set(VkDebugMarkerMarkerInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkDebugMarkerMarkerInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkDebugMarkerMarkerInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

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 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.

PMARKERNAME

public static final int PMARKERNAME

The struct member offsets.

COLOR

public static final int COLOR

The struct member offsets.

Constructor Details

VkDebugMarkerMarkerInfoEXT

public VkDebugMarkerMarkerInfoEXT(ByteBuffer container)

Creates a VkDebugMarkerMarkerInfoEXT 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<VkDebugMarkerMarkerInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

pMarkerName

public ByteBuffer pMarkerName()

a pointer to a null-terminated UTF-8 string containing the name of the marker.

pMarkerNameString

public String pMarkerNameString()

a pointer to a null-terminated UTF-8 string containing the name of the marker.

color

public FloatBuffer color()

an optional RGBA color value that can be associated with the marker. 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.

color

public float color(int index)

an optional RGBA color value that can be associated with the marker. 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.

sType

public VkDebugMarkerMarkerInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDebugMarkerMarkerInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_DEBUG_MARKER_MARKER_INFO_EXT value to the sType() field.

pNext

public VkDebugMarkerMarkerInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

pMarkerName

public VkDebugMarkerMarkerInfoEXT pMarkerName(ByteBuffer value)

Sets the address of the specified encoded string to the pMarkerName() field.

color

public VkDebugMarkerMarkerInfoEXT color(FloatBuffer value)

Copies the specified FloatBuffer to the color() field.

color

public VkDebugMarkerMarkerInfoEXT color(int index,
 float value)

Sets the specified value at the specified index of the color() field.

set

public VkDebugMarkerMarkerInfoEXT set(int sType,
 long pNext,
 ByteBuffer pMarkerName,
 FloatBuffer color)

Initializes this struct with the specified values.

set

public VkDebugMarkerMarkerInfoEXT set(VkDebugMarkerMarkerInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDebugMarkerMarkerInfoEXT malloc()

Returns a new VkDebugMarkerMarkerInfoEXT instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkDebugMarkerMarkerInfoEXT calloc()

Returns a new VkDebugMarkerMarkerInfoEXT instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkDebugMarkerMarkerInfoEXT create()

Returns a new VkDebugMarkerMarkerInfoEXT instance allocated with BufferUtils.

create

public static VkDebugMarkerMarkerInfoEXT create(long address)

Returns a new VkDebugMarkerMarkerInfoEXT instance for the specified memory address.

createSafe

@Nullable
public static VkDebugMarkerMarkerInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDebugMarkerMarkerInfoEXT.Buffer malloc(int capacity)

Returns a new VkDebugMarkerMarkerInfoEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkDebugMarkerMarkerInfoEXT.Buffer calloc(int capacity)

Returns a new VkDebugMarkerMarkerInfoEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkDebugMarkerMarkerInfoEXT.Buffer create(int capacity)

Returns a new VkDebugMarkerMarkerInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkDebugMarkerMarkerInfoEXT.Buffer create(long address,
 int capacity)

Create a VkDebugMarkerMarkerInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static VkDebugMarkerMarkerInfoEXT.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDebugMarkerMarkerInfoEXT mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkDebugMarkerMarkerInfoEXT callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkDebugMarkerMarkerInfoEXT mallocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkDebugMarkerMarkerInfoEXT callocStack(MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkDebugMarkerMarkerInfoEXT.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkDebugMarkerMarkerInfoEXT.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkDebugMarkerMarkerInfoEXT.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkDebugMarkerMarkerInfoEXT.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkDebugMarkerMarkerInfoEXT malloc(MemoryStack stack)

Returns a new VkDebugMarkerMarkerInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDebugMarkerMarkerInfoEXT calloc(MemoryStack stack)

Returns a new VkDebugMarkerMarkerInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkDebugMarkerMarkerInfoEXT.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new VkDebugMarkerMarkerInfoEXT.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDebugMarkerMarkerInfoEXT.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkDebugMarkerMarkerInfoEXT.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().

npMarkerName

public static ByteBuffer npMarkerName(long struct)

Unsafe version of pMarkerName().

npMarkerNameString

public static String npMarkerNameString(long struct)

Unsafe version of pMarkerNameString().

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.

npMarkerName

public static void npMarkerName(long struct,
 ByteBuffer value)

Unsafe version of pMarkerName.

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