Class VkDebugUtilsObjectNameInfoEXT

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

    public class VkDebugUtilsObjectNameInfoEXT
    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 vkSetDebugUtilsObjectNameEXT again with a new string. If pObjectName is an empty string, then any previously set name is removed.

    Valid Usage
    Valid Usage (Implicit)
    See Also

    VkDebugUtilsMessengerCallbackDataEXT, SetDebugUtilsObjectNameEXT

    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 named.
    • pObjectName – a null-terminated UTF-8 string specifying the name to apply to objectHandle.

    Layout

    
     struct VkDebugUtilsObjectNameInfoEXT {
         VkStructureType sType;
         void const * pNext;
         VkObjectType objectType;
         uint64_t objectHandle;
         char const * pObjectName;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

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

        The struct member offsets.
    • Constructor Detail

      • VkDebugUtilsObjectNameInfoEXT

        public VkDebugUtilsObjectNameInfoEXT​(java.nio.ByteBuffer container)
        Creates a VkDebugUtilsObjectNameInfoEXT 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.
      • objectHandle

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

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

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

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

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

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

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

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

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

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

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

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

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

        @Nullable
        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.
      • nobjectHandle

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

        public static void npObjectName​(long struct,
                                        @Nullable
                                        java.nio.ByteBuffer value)
        Unsafe version of pObjectName.