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.NativeResourceSpecify parameters of a tag to attach to an object.Description
The
tagNameparameter 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
objectTypemust not beOBJECT_TYPE_UNKNOWNobjectHandlemust be a valid Vulkan handle of the type associated withobjectTypeas defined in theVkObjectTypeand Vulkan Handle Relationship table
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_DEBUG_UTILS_OBJECT_TAG_INFO_EXTpNextmust beNULLobjectTypemust be a validVkObjectTypevaluepTagmust be a valid pointer to an array oftagSizebytestagSizemust be greater than 0
See Also
Layout
struct VkDebugUtilsObjectTagInfoEXT { VkStructureTypesType(); void const *pNext(); VkObjectTypeobjectType(); uint64_tobjectHandle(); uint64_ttagName(); size_ttagSize(); void const *pTag(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkDebugUtilsObjectTagInfoEXT.BufferAn array ofVkDebugUtilsObjectTagInfoEXTstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intOBJECTHANDLE
OBJECTTYPE
PNEXT
PTAGThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPE
TAGNAME
TAGSIZEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkDebugUtilsObjectTagInfoEXT(java.nio.ByteBuffer container)Creates aVkDebugUtilsObjectTagInfoEXTinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkDebugUtilsObjectTagInfoEXTcalloc()Returns a newVkDebugUtilsObjectTagInfoEXTinstance allocated withmemCalloc.static VkDebugUtilsObjectTagInfoEXT.Buffercalloc(int capacity)Returns a newVkDebugUtilsObjectTagInfoEXT.Bufferinstance allocated withmemCalloc.static VkDebugUtilsObjectTagInfoEXT.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDebugUtilsObjectTagInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDebugUtilsObjectTagInfoEXTcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDebugUtilsObjectTagInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDebugUtilsObjectTagInfoEXTcallocStack()Deprecated.static VkDebugUtilsObjectTagInfoEXT.BuffercallocStack(int capacity)Deprecated.static VkDebugUtilsObjectTagInfoEXT.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkDebugUtilsObjectTagInfoEXTcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkDebugUtilsObjectTagInfoEXTcreate()Returns a newVkDebugUtilsObjectTagInfoEXTinstance allocated withBufferUtils.static VkDebugUtilsObjectTagInfoEXT.Buffercreate(int capacity)Returns a newVkDebugUtilsObjectTagInfoEXT.Bufferinstance allocated withBufferUtils.static VkDebugUtilsObjectTagInfoEXTcreate(long address)Returns a newVkDebugUtilsObjectTagInfoEXTinstance for the specified memory address.static VkDebugUtilsObjectTagInfoEXT.Buffercreate(long address, int capacity)Create aVkDebugUtilsObjectTagInfoEXT.Bufferinstance at the specified memory.static VkDebugUtilsObjectTagInfoEXTcreateSafe(long address)static VkDebugUtilsObjectTagInfoEXT.BuffercreateSafe(long address, int capacity)static VkDebugUtilsObjectTagInfoEXTmalloc()Returns a newVkDebugUtilsObjectTagInfoEXTinstance allocated withmemAlloc.static VkDebugUtilsObjectTagInfoEXT.Buffermalloc(int capacity)Returns a newVkDebugUtilsObjectTagInfoEXT.Bufferinstance allocated withmemAlloc.static VkDebugUtilsObjectTagInfoEXT.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDebugUtilsObjectTagInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.static VkDebugUtilsObjectTagInfoEXTmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDebugUtilsObjectTagInfoEXTinstance allocated on the specifiedMemoryStack.static VkDebugUtilsObjectTagInfoEXTmallocStack()Deprecated.static VkDebugUtilsObjectTagInfoEXT.BuffermallocStack(int capacity)Deprecated.static VkDebugUtilsObjectTagInfoEXT.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkDebugUtilsObjectTagInfoEXTmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static longnobjectHandle(long struct)Unsafe version ofobjectHandle().static voidnobjectHandle(long struct, long value)Unsafe version ofobjectHandle.static intnobjectType(long struct)Unsafe version ofobjectType().static voidnobjectType(long struct, int value)Unsafe version ofobjectType.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static java.nio.ByteBuffernpTag(long struct)Unsafe version ofpTag.static voidnpTag(long struct, java.nio.ByteBuffer value)Unsafe version ofpTag.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.static longntagName(long struct)Unsafe version oftagName().static voidntagName(long struct, long value)Unsafe version oftagName.static longntagSize(long struct)Unsafe version oftagSize().static voidntagSize(long struct, long value)Sets the specified value to thetagSizefield of the specifiedstruct.longobjectHandle()the object to be tagged.VkDebugUtilsObjectTagInfoEXTobjectHandle(long value)Sets the specified value to theobjectHandle()field.intobjectType()aVkObjectTypespecifying the type of the object to be named.VkDebugUtilsObjectTagInfoEXTobjectType(int value)Sets the specified value to theobjectType()field.longpNext()NULLor a pointer to a structure extending this structure.VkDebugUtilsObjectTagInfoEXTpNext(long value)Sets the specified value to thepNext()field.java.nio.ByteBufferpTag()a pointer to an array oftagSizebytes containing the data to be associated with the object.VkDebugUtilsObjectTagInfoEXTpTag(java.nio.ByteBuffer value)Sets the address of the specifiedByteBufferto thepTag()field.VkDebugUtilsObjectTagInfoEXTset(int sType, long pNext, int objectType, long objectHandle, long tagName, java.nio.ByteBuffer pTag)Initializes this struct with the specified values.VkDebugUtilsObjectTagInfoEXTset(VkDebugUtilsObjectTagInfoEXT src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkDebugUtilsObjectTagInfoEXTsType(int value)Sets the specified value to thesType()field.VkDebugUtilsObjectTagInfoEXTsType$Default()Sets theSTRUCTURE_TYPE_DEBUG_UTILS_OBJECT_TAG_INFO_EXTvalue to thesType()field.longtagName()a numerical identifier of the tag.VkDebugUtilsObjectTagInfoEXTtagName(long value)Sets the specified value to thetagName()field.longtagSize()the number of bytes of data to attach to the object.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
VkDebugUtilsObjectTagInfoEXT
public VkDebugUtilsObjectTagInfoEXT(java.nio.ByteBuffer container)
Creates aVkDebugUtilsObjectTagInfoEXTinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
objectType
public int objectType()
aVkObjectTypespecifying 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 java.nio.ByteBuffer pTag()
a pointer to an array oftagSizebytes containing the data to be associated with the object.
-
sType
public VkDebugUtilsObjectTagInfoEXT sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkDebugUtilsObjectTagInfoEXT sType$Default()
Sets theSTRUCTURE_TYPE_DEBUG_UTILS_OBJECT_TAG_INFO_EXTvalue 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 specifiedByteBufferto 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 newVkDebugUtilsObjectTagInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkDebugUtilsObjectTagInfoEXT calloc()
Returns a newVkDebugUtilsObjectTagInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkDebugUtilsObjectTagInfoEXT create()
Returns a newVkDebugUtilsObjectTagInfoEXTinstance allocated withBufferUtils.
-
create
public static VkDebugUtilsObjectTagInfoEXT create(long address)
Returns a newVkDebugUtilsObjectTagInfoEXTinstance for the specified memory address.
-
createSafe
@Nullable public static VkDebugUtilsObjectTagInfoEXT createSafe(long address)
-
malloc
public static VkDebugUtilsObjectTagInfoEXT.Buffer malloc(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkDebugUtilsObjectTagInfoEXT.Buffer calloc(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkDebugUtilsObjectTagInfoEXT.Buffer create(int capacity)
Returns a newVkDebugUtilsObjectTagInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkDebugUtilsObjectTagInfoEXT.Buffer create(long address, int capacity)
Create aVkDebugUtilsObjectTagInfoEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkDebugUtilsObjectTagInfoEXT.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkDebugUtilsObjectTagInfoEXT mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkDebugUtilsObjectTagInfoEXT callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDebugUtilsObjectTagInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkDebugUtilsObjectTagInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDebugUtilsObjectTagInfoEXT.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkDebugUtilsObjectTagInfoEXT.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(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. Usemalloc(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. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkDebugUtilsObjectTagInfoEXT malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectTagInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkDebugUtilsObjectTagInfoEXT calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectTagInfoEXTinstance allocated on the specifiedMemoryStackand 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 newVkDebugUtilsObjectTagInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkDebugUtilsObjectTagInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDebugUtilsObjectTagInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand 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 thetagSizefield 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
-
-