Class VkInstanceCreateInfo

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

    public class VkInstanceCreateInfo
    extends Struct
    implements NativeResource
    Structure specifying parameters of a newly created instance.
    Valid Usage (Implicit)
    See Also

    VkApplicationInfo, CreateInstance

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • flags – reserved for future use.
    • pApplicationInfoNULL or a pointer to an instance of VkApplicationInfo. If not NULL, this information helps implementations recognize behavior inherent to classes of applications. VkApplicationInfo is defined in detail below.
    • enabledLayerCount – the number of global layers to enable.
    • ppEnabledLayerNames – a pointer to an array of enabledLayerCount null-terminated UTF-8 strings containing the names of layers to enable for the created instance. See the Layers section for further details.
    • enabledExtensionCount – the number of global extensions to enable.
    • ppEnabledExtensionNames – a pointer to an array of enabledExtensionCount null-terminated UTF-8 strings containing the names of extensions to enable.

    Layout

    
     struct VkInstanceCreateInfo {
         VkStructureType sType;
         void const * pNext;
         VkInstanceCreateFlags flags;
         VkApplicationInfo const * pApplicationInfo;
         uint32_t enabledLayerCount;
         char const * const * ppEnabledLayerNames;
         uint32_t enabledExtensionCount;
         char const * const * ppEnabledExtensionNames;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, FLAGS, PAPPLICATIONINFO, ENABLEDLAYERCOUNT, PPENABLEDLAYERNAMES, ENABLEDEXTENSIONCOUNT, PPENABLEDEXTENSIONNAMES

        The struct member offsets.
    • Constructor Detail

      • VkInstanceCreateInfo

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

        public int flags()
        Returns the value of the flags field.
      • enabledLayerCount

        public int enabledLayerCount()
        Returns the value of the enabledLayerCount field.
      • ppEnabledLayerNames

        @Nullable
        public PointerBuffer ppEnabledLayerNames()
        Returns a PointerBuffer view of the data pointed to by the ppEnabledLayerNames field.
      • enabledExtensionCount

        public int enabledExtensionCount()
        Returns the value of the enabledExtensionCount field.
      • ppEnabledExtensionNames

        @Nullable
        public PointerBuffer ppEnabledExtensionNames()
        Returns a PointerBuffer view of the data pointed to by the ppEnabledExtensionNames field.
      • sType

        public VkInstanceCreateInfo sType​(int value)
        Sets the specified value to the sType field.
      • pNext

        public VkInstanceCreateInfo pNext​(long value)
        Sets the specified value to the pNext field.
      • flags

        public VkInstanceCreateInfo flags​(int value)
        Sets the specified value to the flags field.
      • malloc

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

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

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

        @Nullable
        public static VkInstanceCreateInfo createSafe​(long address)
        Like create, but returns null if address is NULL.
      • callocStack

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

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

        public static VkInstanceCreateInfo callocStack​(MemoryStack stack)
        Returns a new VkInstanceCreateInfo 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().
      • nflags

        public static int nflags​(long struct)
        Unsafe version of flags().
      • nenabledLayerCount

        public static int nenabledLayerCount​(long struct)
        Unsafe version of enabledLayerCount().
      • nenabledExtensionCount

        public static int nenabledExtensionCount​(long struct)
        Unsafe version of enabledExtensionCount().
      • 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.
      • nflags

        public static void nflags​(long struct,
                                  int value)
        Unsafe version of flags.
      • nenabledLayerCount

        public static void nenabledLayerCount​(long struct,
                                              int value)
        Sets the specified value to the enabledLayerCount field of the specified struct.
      • nenabledExtensionCount

        public static void nenabledExtensionCount​(long struct,
                                                  int value)
        Sets the specified value to the enabledExtensionCount field of the specified struct.
      • 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