Class VkMacOSSurfaceCreateInfoMVK

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

    public class VkMacOSSurfaceCreateInfoMVK
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure specifying parameters of a newly created macOS surface object.
    Valid Usage
    • pView must be a valid NSView and must be backed by a CALayer instance of type CAMetalLayer.
    Valid Usage (Implicit)
    See Also

    CreateMacOSSurfaceMVK

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • flags – reserved for future use.
    • pView – a reference to a NSView object which will display this surface. This NSView must be backed by a CALayer instance of type CAMetalLayer.

    Layout

    
     struct VkMacOSSurfaceCreateInfoMVK {
         VkStructureType sType;
         void const * pNext;
         VkMacOSSurfaceCreateFlagsMVK flags;
         void const * pView;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, FLAGS, PVIEW

        The struct member offsets.
    • Constructor Detail

      • VkMacOSSurfaceCreateInfoMVK

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

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

        public long pView()
        Returns the value of the pView field.
      • set

        public VkMacOSSurfaceCreateInfoMVK set​(int sType,
                                               long pNext,
                                               int flags,
                                               long pView)
        Initializes this struct with the specified values.
      • malloc

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

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

        public static VkMacOSSurfaceCreateInfoMVK create()
        Returns a new VkMacOSSurfaceCreateInfoMVK instance allocated with BufferUtils.
      • create

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

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

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

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

        public static VkMacOSSurfaceCreateInfoMVK callocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkMacOSSurfaceCreateInfoMVK instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static VkMacOSSurfaceCreateInfoMVK.Buffer callocStack​(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)
        Returns a new VkMacOSSurfaceCreateInfoMVK.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • 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().
      • npView

        public static long npView​(long struct)
        Unsafe version of pView().
      • 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.
      • npView

        public static void npView​(long struct,
                                  long value)
        Unsafe version of pView.
      • 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