Package org.lwjgl.vulkan
Class VkDebugUtilsObjectTagInfoEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDebugUtilsObjectTagInfoEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkDebugUtilsObjectTagInfoEXT extends org.lwjgl.system.Struct 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 beOBJECT_TYPE_UNKNOWN
objectHandle
must be a valid Vulkan handle of the type associated withobjectType
as defined in the VkObjectType and Vulkan Handle Relationship table
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_DEBUG_UTILS_OBJECT_TAG_INFO_EXT
pNext
must beNULL
objectType
must be a validVkObjectType
valuepTag
must be a valid pointer to an array oftagSize
bytestagSize
must be greater than 0
See Also
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.objectType
– aVkObjectType
specifying the type of the object to be named.objectHandle
– the object to be tagged.tagName
– a numerical identifier of the tag.tagSize
– the number of bytes of data to attach to the object.pTag
– an array oftagSize
bytes containing the data to be associated with the object.
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 ofVkDebugUtilsObjectTagInfoEXT
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
OBJECTHANDLE
OBJECTTYPE
PNEXT
PTAGThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
TAGNAME
TAGSIZEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDebugUtilsObjectTagInfoEXT(java.nio.ByteBuffer container)
Creates aVkDebugUtilsObjectTagInfoEXT
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkDebugUtilsObjectTagInfoEXT
calloc()
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated withmemCalloc
.static VkDebugUtilsObjectTagInfoEXT.Buffer
calloc(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated withmemCalloc
.static VkDebugUtilsObjectTagInfoEXT
callocStack()
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDebugUtilsObjectTagInfoEXT.Buffer
callocStack(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDebugUtilsObjectTagInfoEXT.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDebugUtilsObjectTagInfoEXT
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDebugUtilsObjectTagInfoEXT
create()
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated withBufferUtils
.static VkDebugUtilsObjectTagInfoEXT.Buffer
create(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated withBufferUtils
.static VkDebugUtilsObjectTagInfoEXT
create(long address)
Returns a newVkDebugUtilsObjectTagInfoEXT
instance for the specified memory address.static VkDebugUtilsObjectTagInfoEXT.Buffer
create(long address, int capacity)
Create aVkDebugUtilsObjectTagInfoEXT.Buffer
instance at the specified memory.static VkDebugUtilsObjectTagInfoEXT
createSafe(long address)
static VkDebugUtilsObjectTagInfoEXT.Buffer
createSafe(long address, int capacity)
static VkDebugUtilsObjectTagInfoEXT
malloc()
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated withmemAlloc
.static VkDebugUtilsObjectTagInfoEXT.Buffer
malloc(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated withmemAlloc
.static VkDebugUtilsObjectTagInfoEXT
mallocStack()
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated on the thread-localMemoryStack
.static VkDebugUtilsObjectTagInfoEXT.Buffer
mallocStack(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.static VkDebugUtilsObjectTagInfoEXT.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkDebugUtilsObjectTagInfoEXT
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated on the specifiedMemoryStack
.static long
nobjectHandle(long struct)
Unsafe version ofobjectHandle()
.static void
nobjectHandle(long struct, long value)
Unsafe version ofobjectHandle
.static int
nobjectType(long struct)
Unsafe version ofobjectType()
.static void
nobjectType(long struct, int value)
Unsafe version ofobjectType
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static java.nio.ByteBuffer
npTag(long struct)
Unsafe version ofpTag
.static void
npTag(long struct, java.nio.ByteBuffer value)
Unsafe version ofpTag
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static long
ntagName(long struct)
Unsafe version oftagName()
.static void
ntagName(long struct, long value)
Unsafe version oftagName
.static long
ntagSize(long struct)
Unsafe version oftagSize()
.static void
ntagSize(long struct, long value)
Sets the specified value to thetagSize
field of the specifiedstruct
.long
objectHandle()
Returns the value of theobjectHandle
field.VkDebugUtilsObjectTagInfoEXT
objectHandle(long value)
Sets the specified value to theobjectHandle
field.int
objectType()
Returns the value of theobjectType
field.VkDebugUtilsObjectTagInfoEXT
objectType(int value)
Sets the specified value to theobjectType
field.long
pNext()
Returns the value of thepNext
field.VkDebugUtilsObjectTagInfoEXT
pNext(long value)
Sets the specified value to thepNext
field.java.nio.ByteBuffer
pTag()
Returns aByteBuffer
view of the data pointed to by thepTag
field.VkDebugUtilsObjectTagInfoEXT
pTag(java.nio.ByteBuffer value)
Sets the address of the specifiedByteBuffer
to thepTag
field.VkDebugUtilsObjectTagInfoEXT
set(int sType, long pNext, int objectType, long objectHandle, long tagName, java.nio.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()
Returns the value of thesType
field.VkDebugUtilsObjectTagInfoEXT
sType(int value)
Sets the specified value to thesType
field.long
tagName()
Returns the value of thetagName
field.VkDebugUtilsObjectTagInfoEXT
tagName(long value)
Sets the specified value to thetagName
field.long
tagSize()
Returns the value of thetagSize
field.static void
validate(long struct)
Validates pointer members that should not beNULL
.static void
validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.
-
-
-
Constructor Detail
-
VkDebugUtilsObjectTagInfoEXT
public VkDebugUtilsObjectTagInfoEXT(java.nio.ByteBuffer container)
Creates aVkDebugUtilsObjectTagInfoEXT
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
objectType
public int objectType()
Returns the value of theobjectType
field.
-
objectHandle
public long objectHandle()
Returns the value of theobjectHandle
field.
-
tagName
public long tagName()
Returns the value of thetagName
field.
-
tagSize
public long tagSize()
Returns the value of thetagSize
field.
-
pTag
public java.nio.ByteBuffer pTag()
Returns aByteBuffer
view of the data pointed to by thepTag
field.
-
sType
public VkDebugUtilsObjectTagInfoEXT sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDebugUtilsObjectTagInfoEXT pNext(long value)
Sets the specified value to thepNext
field.
-
objectType
public VkDebugUtilsObjectTagInfoEXT objectType(int value)
Sets the specified value to theobjectType
field.
-
objectHandle
public VkDebugUtilsObjectTagInfoEXT objectHandle(long value)
Sets the specified value to theobjectHandle
field.
-
tagName
public VkDebugUtilsObjectTagInfoEXT tagName(long value)
Sets the specified value to thetagName
field.
-
pTag
public VkDebugUtilsObjectTagInfoEXT pTag(java.nio.ByteBuffer value)
Sets the address of the specifiedByteBuffer
to thepTag
field.
-
set
public VkDebugUtilsObjectTagInfoEXT set(int sType, long pNext, int objectType, long objectHandle, long tagName, java.nio.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 newVkDebugUtilsObjectTagInfoEXT
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDebugUtilsObjectTagInfoEXT calloc()
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDebugUtilsObjectTagInfoEXT create()
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated withBufferUtils
.
-
create
public static VkDebugUtilsObjectTagInfoEXT create(long address)
Returns a newVkDebugUtilsObjectTagInfoEXT
instance for the specified memory address.
-
createSafe
@Nullable public static VkDebugUtilsObjectTagInfoEXT createSafe(long address)
-
malloc
public static VkDebugUtilsObjectTagInfoEXT.Buffer malloc(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDebugUtilsObjectTagInfoEXT.Buffer calloc(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDebugUtilsObjectTagInfoEXT.Buffer create(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDebugUtilsObjectTagInfoEXT.Buffer create(long address, int capacity)
Create aVkDebugUtilsObjectTagInfoEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDebugUtilsObjectTagInfoEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDebugUtilsObjectTagInfoEXT mallocStack()
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDebugUtilsObjectTagInfoEXT callocStack()
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDebugUtilsObjectTagInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDebugUtilsObjectTagInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectTagInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDebugUtilsObjectTagInfoEXT.Buffer mallocStack(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDebugUtilsObjectTagInfoEXT.Buffer callocStack(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDebugUtilsObjectTagInfoEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDebugUtilsObjectTagInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectTagInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
nobjectType
public static int nobjectType(long struct)
Unsafe version ofobjectType()
.
-
nobjectHandle
public static long nobjectHandle(long struct)
Unsafe version ofobjectHandle()
.
-
ntagName
public static long ntagName(long struct)
Unsafe version oftagName()
.
-
ntagSize
public static long ntagSize(long struct)
Unsafe version oftagSize()
.
-
npTag
public static java.nio.ByteBuffer npTag(long struct)
Unsafe version ofpTag
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nobjectType
public static void nobjectType(long struct, int value)
Unsafe version ofobjectType
.
-
nobjectHandle
public static void nobjectHandle(long struct, long value)
Unsafe version ofobjectHandle
.
-
ntagName
public static void ntagName(long struct, long value)
Unsafe version oftagName
.
-
ntagSize
public static void ntagSize(long struct, long value)
Sets the specified value to thetagSize
field of the specifiedstruct
.
-
npTag
public static void npTag(long struct, java.nio.ByteBuffer value)
Unsafe version ofpTag
.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL
.- Parameters:
struct
- the struct to validate
-
validate
public static void validate(long array, int count)
Callsvalidate(long)
for each struct contained in the specified struct array.- Parameters:
array
- the struct array to validatecount
- the number of structs inarray
-
-