Class VkDebugMarkerObjectNameInfoEXT

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

    public class VkDebugMarkerObjectNameInfoEXT
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Specify parameters of a name to give to an object.
    Description

    Applications may change the name associated with an object simply by calling vkDebugMarkerSetObjectNameEXT again with a new string. To remove a previously set name, pObjectName should be set to an empty string.

    Valid Usage
    Valid Usage (Implicit)
    See Also

    DebugMarkerSetObjectNameEXT

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • objectType – a VkDebugReportObjectTypeEXT specifying the type of the object to be named.
    • object – the object to be named.
    • pObjectName – a null-terminated UTF-8 string specifying the name to apply to object.

    Layout

    
     struct VkDebugMarkerObjectNameInfoEXT {
         VkStructureType sType;
         void const * pNext;
         VkDebugReportObjectTypeEXT objectType;
         uint64_t object;
         char const * pObjectName;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, OBJECTTYPE, OBJECT, POBJECTNAME

        The struct member offsets.
    • Constructor Detail

      • VkDebugMarkerObjectNameInfoEXT

        public VkDebugMarkerObjectNameInfoEXT​(java.nio.ByteBuffer container)
        Creates a VkDebugMarkerObjectNameInfoEXT 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()
        Specified by:
        sizeof in class org.lwjgl.system.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.
      • object

        public long object()
        Returns the value of the object field.
      • pObjectName

        public java.nio.ByteBuffer pObjectName()
        Returns a ByteBuffer view of the null-terminated string pointed to by the pObjectName field.
      • pObjectNameString

        public java.lang.String pObjectNameString()
        Decodes the null-terminated string pointed to by the pObjectName field.
      • pObjectName

        public VkDebugMarkerObjectNameInfoEXT pObjectName​(java.nio.ByteBuffer value)
        Sets the address of the specified encoded string to the pObjectName field.
      • set

        public VkDebugMarkerObjectNameInfoEXT set​(int sType,
                                                  long pNext,
                                                  int objectType,
                                                  long object,
                                                  java.nio.ByteBuffer pObjectName)
        Initializes this struct with the specified values.
      • malloc

        public static VkDebugMarkerObjectNameInfoEXT malloc()
        Returns a new VkDebugMarkerObjectNameInfoEXT instance allocated with memAlloc. The instance must be explicitly freed.
      • calloc

        public static VkDebugMarkerObjectNameInfoEXT calloc()
        Returns a new VkDebugMarkerObjectNameInfoEXT instance allocated with memCalloc. The instance must be explicitly freed.
      • create

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

        public static VkDebugMarkerObjectNameInfoEXT mallocStack()
        Returns a new VkDebugMarkerObjectNameInfoEXT instance allocated on the thread-local MemoryStack.
      • callocStack

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

        public static VkDebugMarkerObjectNameInfoEXT mallocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkDebugMarkerObjectNameInfoEXT instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static VkDebugMarkerObjectNameInfoEXT callocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkDebugMarkerObjectNameInfoEXT 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().
      • nobject

        public static long nobject​(long struct)
        Unsafe version of object().
      • npObjectName

        public static java.nio.ByteBuffer npObjectName​(long struct)
        Unsafe version of pObjectName().
      • npObjectNameString

        public static java.lang.String npObjectNameString​(long struct)
        Unsafe version of pObjectNameString().
      • 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.
      • nobject

        public static void nobject​(long struct,
                                   long value)
        Unsafe version of object.
      • npObjectName

        public static void npObjectName​(long struct,
                                        java.nio.ByteBuffer value)
        Unsafe version of pObjectName.
      • 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