Class VkDisplayPlanePropertiesKHR

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

    public class VkDisplayPlanePropertiesKHR
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure describing display plane properties.

    Member documentation

    • currentDisplay – the handle of the display the plane is currently associated with. If the plane is not currently attached to any displays, this will be NULL_HANDLE.
    • currentStackIndex – the current z-order of the plane. This will be between 0 and the value returned by vkGetPhysicalDeviceDisplayPlanePropertiesKHR in pPropertyCount.

    Layout

    
     struct VkDisplayPlanePropertiesKHR {
         VkDisplayKHR currentDisplay;
         uint32_t currentStackIndex;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • CURRENTDISPLAY, CURRENTSTACKINDEX

        The struct member offsets.
    • Constructor Detail

      • VkDisplayPlanePropertiesKHR

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

        public long currentDisplay()
        Returns the value of the currentDisplay field.
      • currentStackIndex

        public int currentStackIndex()
        Returns the value of the currentStackIndex field.
      • malloc

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

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

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

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

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

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

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

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

        public static VkDisplayPlanePropertiesKHR.Buffer callocStack​(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)
        Returns a new VkDisplayPlanePropertiesKHR.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
      • ncurrentDisplay

        public static long ncurrentDisplay​(long struct)
        Unsafe version of currentDisplay().
      • ncurrentStackIndex

        public static int ncurrentStackIndex​(long struct)
        Unsafe version of currentStackIndex().