Package org.lwjgl.vulkan
Class VkDebugMarkerObjectTagInfoEXT
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDebugMarkerObjectTagInfoEXT
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkDebugMarkerObjectTagInfoEXT 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 beDEBUG_REPORT_OBJECT_TYPE_UNKNOWN_EXT
object
must not beNULL_HANDLE
object
must be a Vulkan object of the type associated withobjectType
as defined inVkDebugReportObjectTypeEXT
and Vulkan Handle Relationship.
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_DEBUG_MARKER_OBJECT_TAG_INFO_EXT
pNext
must beNULL
objectType
must be a validVkDebugReportObjectTypeEXT
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
– aVkDebugReportObjectTypeEXT
specifying the type of the object to be named.object
– 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 VkDebugMarkerObjectTagInfoEXT { VkStructureType sType; void const * pNext; VkDebugReportObjectTypeEXT objectType; uint64_t object; uint64_t tagName; size_t tagSize; void const * pTag; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkDebugMarkerObjectTagInfoEXT.Buffer
An array ofVkDebugMarkerObjectTagInfoEXT
structs.
-
Constructor Summary
Constructors Constructor Description VkDebugMarkerObjectTagInfoEXT(java.nio.ByteBuffer container)
Creates aVkDebugMarkerObjectTagInfoEXT
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 VkDebugMarkerObjectTagInfoEXT
calloc()
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated withmemCalloc
.static VkDebugMarkerObjectTagInfoEXT.Buffer
calloc(int capacity)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated withmemCalloc
.static VkDebugMarkerObjectTagInfoEXT
callocStack()
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDebugMarkerObjectTagInfoEXT.Buffer
callocStack(int capacity)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDebugMarkerObjectTagInfoEXT.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDebugMarkerObjectTagInfoEXT
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDebugMarkerObjectTagInfoEXT
create()
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated withBufferUtils
.static VkDebugMarkerObjectTagInfoEXT.Buffer
create(int capacity)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated withBufferUtils
.static VkDebugMarkerObjectTagInfoEXT
create(long address)
Returns a newVkDebugMarkerObjectTagInfoEXT
instance for the specified memory address.static VkDebugMarkerObjectTagInfoEXT.Buffer
create(long address, int capacity)
Create aVkDebugMarkerObjectTagInfoEXT.Buffer
instance at the specified memory.static VkDebugMarkerObjectTagInfoEXT
createSafe(long address)
static VkDebugMarkerObjectTagInfoEXT.Buffer
createSafe(long address, int capacity)
static VkDebugMarkerObjectTagInfoEXT
malloc()
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated withmemAlloc
.static VkDebugMarkerObjectTagInfoEXT.Buffer
malloc(int capacity)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated withmemAlloc
.static VkDebugMarkerObjectTagInfoEXT
mallocStack()
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated on the thread-localMemoryStack
.static VkDebugMarkerObjectTagInfoEXT.Buffer
mallocStack(int capacity)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.static VkDebugMarkerObjectTagInfoEXT.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.static VkDebugMarkerObjectTagInfoEXT
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated on the specifiedMemoryStack
.static long
nobject(long struct)
Unsafe version ofobject()
.static void
nobject(long struct, long value)
Unsafe version ofobject
.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
object()
Returns the value of theobject
field.VkDebugMarkerObjectTagInfoEXT
object(long value)
Sets the specified value to theobject
field.int
objectType()
Returns the value of theobjectType
field.VkDebugMarkerObjectTagInfoEXT
objectType(int value)
Sets the specified value to theobjectType
field.long
pNext()
Returns the value of thepNext
field.VkDebugMarkerObjectTagInfoEXT
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.VkDebugMarkerObjectTagInfoEXT
pTag(java.nio.ByteBuffer value)
Sets the address of the specifiedByteBuffer
to thepTag
field.VkDebugMarkerObjectTagInfoEXT
set(int sType, long pNext, int objectType, long object, long tagName, java.nio.ByteBuffer pTag)
Initializes this struct with the specified values.VkDebugMarkerObjectTagInfoEXT
set(VkDebugMarkerObjectTagInfoEXT src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkDebugMarkerObjectTagInfoEXT
sType(int value)
Sets the specified value to thesType
field.long
tagName()
Returns the value of thetagName
field.VkDebugMarkerObjectTagInfoEXT
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
-
VkDebugMarkerObjectTagInfoEXT
public VkDebugMarkerObjectTagInfoEXT(java.nio.ByteBuffer container)
Creates aVkDebugMarkerObjectTagInfoEXT
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.
-
object
public long object()
Returns the value of theobject
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 VkDebugMarkerObjectTagInfoEXT sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDebugMarkerObjectTagInfoEXT pNext(long value)
Sets the specified value to thepNext
field.
-
objectType
public VkDebugMarkerObjectTagInfoEXT objectType(int value)
Sets the specified value to theobjectType
field.
-
object
public VkDebugMarkerObjectTagInfoEXT object(long value)
Sets the specified value to theobject
field.
-
tagName
public VkDebugMarkerObjectTagInfoEXT tagName(long value)
Sets the specified value to thetagName
field.
-
pTag
public VkDebugMarkerObjectTagInfoEXT pTag(java.nio.ByteBuffer value)
Sets the address of the specifiedByteBuffer
to thepTag
field.
-
set
public VkDebugMarkerObjectTagInfoEXT set(int sType, long pNext, int objectType, long object, long tagName, java.nio.ByteBuffer pTag)
Initializes this struct with the specified values.
-
set
public VkDebugMarkerObjectTagInfoEXT set(VkDebugMarkerObjectTagInfoEXT src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkDebugMarkerObjectTagInfoEXT malloc()
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDebugMarkerObjectTagInfoEXT calloc()
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDebugMarkerObjectTagInfoEXT create()
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated withBufferUtils
.
-
create
public static VkDebugMarkerObjectTagInfoEXT create(long address)
Returns a newVkDebugMarkerObjectTagInfoEXT
instance for the specified memory address.
-
createSafe
@Nullable public static VkDebugMarkerObjectTagInfoEXT createSafe(long address)
-
malloc
public static VkDebugMarkerObjectTagInfoEXT.Buffer malloc(int capacity)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDebugMarkerObjectTagInfoEXT.Buffer calloc(int capacity)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDebugMarkerObjectTagInfoEXT.Buffer create(int capacity)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDebugMarkerObjectTagInfoEXT.Buffer create(long address, int capacity)
Create aVkDebugMarkerObjectTagInfoEXT.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDebugMarkerObjectTagInfoEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDebugMarkerObjectTagInfoEXT mallocStack()
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDebugMarkerObjectTagInfoEXT callocStack()
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDebugMarkerObjectTagInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDebugMarkerObjectTagInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectTagInfoEXT
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDebugMarkerObjectTagInfoEXT.Buffer mallocStack(int capacity)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDebugMarkerObjectTagInfoEXT.Buffer callocStack(int capacity)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDebugMarkerObjectTagInfoEXT.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectTagInfoEXT.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDebugMarkerObjectTagInfoEXT.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugMarkerObjectTagInfoEXT.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()
.
-
nobject
public static long nobject(long struct)
Unsafe version ofobject()
.
-
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
.
-
nobject
public static void nobject(long struct, long value)
Unsafe version ofobject
.
-
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
-
-