Class VkDebugUtilsObjectTagInfoEXT

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkDebugUtilsObjectTagInfoEXT
    extends Struct
    implements 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
    Valid Usage (Implicit)
    See Also

    SetDebugUtilsObjectTagEXT

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • objectType – a VkObjectType 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 of tagSize 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;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, OBJECTTYPE, OBJECTHANDLE, TAGNAME, TAGSIZE, PTAG

        The struct member offsets.
    • Constructor Detail

      • VkDebugUtilsObjectTagInfoEXT

        public VkDebugUtilsObjectTagInfoEXT​(java.nio.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 Detail

      • sizeof

        public int sizeof()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • sType

        public int sType()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • objectType

        public int objectType()
        Returns the value of the objectType field.
      • objectHandle

        public long objectHandle()
        Returns the value of the objectHandle field.
      • tagName

        public long tagName()
        Returns the value of the tagName field.
      • tagSize

        public long tagSize()
        Returns the value of the tagSize field.
      • pTag

        public java.nio.ByteBuffer pTag()
        Returns a ByteBuffer view of the data pointed to by the pTag field.
      • pTag

        public VkDebugUtilsObjectTagInfoEXT pTag​(java.nio.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,
                                                java.nio.ByteBuffer pTag)
        Initializes this struct with the specified values.
      • create

        public static VkDebugUtilsObjectTagInfoEXT create​(long address)
        Returns a new VkDebugUtilsObjectTagInfoEXT instance for the specified memory address.
      • callocStack

        public static VkDebugUtilsObjectTagInfoEXT callocStack()
        Returns a new VkDebugUtilsObjectTagInfoEXT instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • callocStack

        public static VkDebugUtilsObjectTagInfoEXT callocStack​(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
      • 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 java.nio.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,
                                 java.nio.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
      • validate

        public static void validate​(long array,
                                    int count)
        Calls validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array