Package org.lwjgl.vulkan

Class VkDebugUtilsObjectTagInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDebugUtilsObjectTagInfoEXT>

org.lwjgl.vulkan.VkDebugUtilsObjectTagInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkDebugUtilsObjectTagInfoEXT
extends org.lwjgl.system.Struct<VkDebugUtilsObjectTagInfoEXT>
implements org.lwjgl.system.NativeResource

Specify parameters of a tag to attach to an object.

Description

The tagName parameter gives a name or identifier to the type of data being tagged. This can be used by debugging layers to easily filter for only data that can be used by that implementation.

Valid Usage

• objectType must not be OBJECT_TYPE_UNKNOWN
• objectHandle must be a valid Vulkan handle of the type associated with objectType as defined in the VkObjectType and Vulkan Handle Relationship table

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_TAG_INFO_EXT
• pNext must be NULL
• objectType must be a valid VkObjectType value
• pTag must be a valid pointer to an array of tagSize bytes
• tagSize must be greater than 0

See Also

SetDebugUtilsObjectTagEXT

Layout

 struct VkDebugUtilsObjectTagInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkObjectType objectType();
     uint64_t objectHandle();
     uint64_t tagName();
     size_t tagSize();
     void const * pTag();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	OBJECTHANDLE	The struct member offsets.
static final int	OBJECTTYPE	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PTAG	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	TAGNAME	The struct member offsets.
static final int	TAGSIZE	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
VkDebugUtilsObjectTagInfoEXT(ByteBuffer container)	Creates a VkDebugUtilsObjectTagInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDebugUtilsObjectTagInfoEXT	calloc()	Returns a new VkDebugUtilsObjectTagInfoEXT instance allocated with memCalloc.
static VkDebugUtilsObjectTagInfoEXT.Buffer	calloc(int capacity)	Returns a new VkDebugUtilsObjectTagInfoEXT.Buffer instance allocated with memCalloc.
static VkDebugUtilsObjectTagInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDebugUtilsObjectTagInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDebugUtilsObjectTagInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDebugUtilsObjectTagInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDebugUtilsObjectTagInfoEXT	callocStack()	Deprecated.
static VkDebugUtilsObjectTagInfoEXT.Buffer	callocStack(int capacity)	Deprecated.
static VkDebugUtilsObjectTagInfoEXT.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDebugUtilsObjectTagInfoEXT	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDebugUtilsObjectTagInfoEXT	create()	Returns a new VkDebugUtilsObjectTagInfoEXT instance allocated with BufferUtils.
static VkDebugUtilsObjectTagInfoEXT.Buffer	create(int capacity)	Returns a new VkDebugUtilsObjectTagInfoEXT.Buffer instance allocated with BufferUtils.
static VkDebugUtilsObjectTagInfoEXT	create(long address)	Returns a new VkDebugUtilsObjectTagInfoEXT instance for the specified memory address.
static VkDebugUtilsObjectTagInfoEXT.Buffer	create(long address, int capacity)	Create a VkDebugUtilsObjectTagInfoEXT.Buffer instance at the specified memory.
static @Nullable VkDebugUtilsObjectTagInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDebugUtilsObjectTagInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDebugUtilsObjectTagInfoEXT	malloc()	Returns a new VkDebugUtilsObjectTagInfoEXT instance allocated with memAlloc.
static VkDebugUtilsObjectTagInfoEXT.Buffer	malloc(int capacity)	Returns a new VkDebugUtilsObjectTagInfoEXT.Buffer instance allocated with memAlloc.
static VkDebugUtilsObjectTagInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDebugUtilsObjectTagInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkDebugUtilsObjectTagInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDebugUtilsObjectTagInfoEXT instance allocated on the specified MemoryStack.
static VkDebugUtilsObjectTagInfoEXT	mallocStack()	Deprecated.
static VkDebugUtilsObjectTagInfoEXT.Buffer	mallocStack(int capacity)	Deprecated.
static VkDebugUtilsObjectTagInfoEXT.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDebugUtilsObjectTagInfoEXT	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static long	nobjectHandle(long struct)	Unsafe version of objectHandle().
static void	nobjectHandle(long struct, long value)	Unsafe version of objectHandle.
static int	nobjectType(long struct)	Unsafe version of objectType().
static void	nobjectType(long struct, int value)	Unsafe version of objectType.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static ByteBuffer	npTag(long struct)	Unsafe version of pTag.
static void	npTag(long struct, ByteBuffer value)	Unsafe version of pTag.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static long	ntagName(long struct)	Unsafe version of tagName().
static void	ntagName(long struct, long value)	Unsafe version of tagName.
static long	ntagSize(long struct)	Unsafe version of tagSize().
static void	ntagSize(long struct, long value)	Sets the specified value to the tagSize field of the specified struct.
long	objectHandle()	the object to be tagged.
VkDebugUtilsObjectTagInfoEXT	objectHandle(long value)	Sets the specified value to the objectHandle() field.
int	objectType()	a VkObjectType specifying the type of the object to be named.
VkDebugUtilsObjectTagInfoEXT	objectType(int value)	Sets the specified value to the objectType() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDebugUtilsObjectTagInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
ByteBuffer	pTag()	a pointer to an array of tagSize bytes containing the data to be associated with the object.
VkDebugUtilsObjectTagInfoEXT	pTag(ByteBuffer value)	Sets the address of the specified ByteBuffer to the pTag() field.
VkDebugUtilsObjectTagInfoEXT	set(int sType, long pNext, int objectType, long objectHandle, long tagName, ByteBuffer pTag)	Initializes this struct with the specified values.
VkDebugUtilsObjectTagInfoEXT	set(VkDebugUtilsObjectTagInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDebugUtilsObjectTagInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkDebugUtilsObjectTagInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_TAG_INFO_EXT value to the sType() field.
long	tagName()	a numerical identifier of the tag.
VkDebugUtilsObjectTagInfoEXT	tagName(long value)	Sets the specified value to the tagName() field.
long	tagSize()	the number of bytes of data to attach to the object.
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, 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.

OBJECTTYPE

public static final int OBJECTTYPE

The struct member offsets.

OBJECTHANDLE

public static final int OBJECTHANDLE

The struct member offsets.

TAGNAME

public static final int TAGNAME

The struct member offsets.

TAGSIZE

public static final int TAGSIZE

The struct member offsets.

PTAG

public static final int PTAG

The struct member offsets.

Constructor Details

VkDebugUtilsObjectTagInfoEXT

public VkDebugUtilsObjectTagInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

objectType

public int objectType()

a VkObjectType specifying the type of the object to be named.

objectHandle

public long objectHandle()

the object to be tagged.

tagName

public long tagName()

a numerical identifier of the tag.

tagSize

public long tagSize()

the number of bytes of data to attach to the object.

pTag

public ByteBuffer pTag()

a pointer to an array of tagSize bytes containing the data to be associated with the object.

sType

public VkDebugUtilsObjectTagInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDebugUtilsObjectTagInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_TAG_INFO_EXT value to the sType() field.

pNext

public VkDebugUtilsObjectTagInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

objectType

public VkDebugUtilsObjectTagInfoEXT objectType(int value)

Sets the specified value to the objectType() field.

objectHandle

public VkDebugUtilsObjectTagInfoEXT objectHandle(long value)

Sets the specified value to the objectHandle() field.

tagName

public VkDebugUtilsObjectTagInfoEXT tagName(long value)

Sets the specified value to the tagName() field.

pTag

public VkDebugUtilsObjectTagInfoEXT pTag(ByteBuffer value)

Sets the address of the specified ByteBuffer to the pTag() field.

set

public VkDebugUtilsObjectTagInfoEXT set(int sType,
 long pNext,
 int objectType,
 long objectHandle,
 long tagName,
 ByteBuffer pTag)

Initializes this struct with the specified values.

set

public VkDebugUtilsObjectTagInfoEXT set(VkDebugUtilsObjectTagInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDebugUtilsObjectTagInfoEXT malloc()

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

calloc

public static VkDebugUtilsObjectTagInfoEXT calloc()

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

create

public static VkDebugUtilsObjectTagInfoEXT create()

Returns a new VkDebugUtilsObjectTagInfoEXT instance allocated with BufferUtils.

create

public static VkDebugUtilsObjectTagInfoEXT create(long address)

Returns a new VkDebugUtilsObjectTagInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkDebugUtilsObjectTagInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDebugUtilsObjectTagInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDebugUtilsObjectTagInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDebugUtilsObjectTagInfoEXT.Buffer create(int capacity)

Returns a new VkDebugUtilsObjectTagInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDebugUtilsObjectTagInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDebugUtilsObjectTagInfoEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDebugUtilsObjectTagInfoEXT callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDebugUtilsObjectTagInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDebugUtilsObjectTagInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkDebugUtilsObjectTagInfoEXT.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 VkDebugUtilsObjectTagInfoEXT.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 VkDebugUtilsObjectTagInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDebugUtilsObjectTagInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDebugUtilsObjectTagInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkDebugUtilsObjectTagInfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDebugUtilsObjectTagInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nobjectType

public static int nobjectType(long struct)

Unsafe version of objectType().

nobjectHandle

public static long nobjectHandle(long struct)

Unsafe version of objectHandle().

ntagName

public static long ntagName(long struct)

Unsafe version of tagName().

ntagSize

public static long ntagSize(long struct)

Unsafe version of tagSize().

npTag

public static ByteBuffer npTag(long struct)

Unsafe version of pTag.

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.

nobjectType

public static void nobjectType(long struct,
 int value)

Unsafe version of objectType.

nobjectHandle

public static void nobjectHandle(long struct,
 long value)

Unsafe version of objectHandle.

ntagName

public static void ntagName(long struct,
 long value)

Unsafe version of tagName.

ntagSize

public static void ntagSize(long struct,
 long value)

Sets the specified value to the tagSize field of the specified struct.

npTag

public static void npTag(long struct,
 ByteBuffer value)

Unsafe version of pTag.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate