Package org.lwjgl.vulkan

Class VkDisplayPlaneInfo2KHR

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    public class VkDisplayPlaneInfo2KHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Structure defining the intended configuration of a display plane.
    Description
    Note

    This parameter also implicitly specifies a display.

    • planeIndex is the plane which the application intends to use with the display.

    The members of VkDisplayPlaneInfo2KHR correspond to the arguments to GetDisplayPlaneCapabilitiesKHR, with sType and pNext added for extensibility.

    Valid Usage (Implicit)
    Host Synchronization
    • Host access to mode must be externally synchronized
    See Also

    GetDisplayPlaneCapabilities2KHR

    Layout

    
 struct VkDisplayPlaneInfo2KHR {
     VkStructureType sType();
     void const * pNext();
     VkDisplayModeKHR mode();
     uint32_t planeIndex;
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • STYPE, PNEXT, MODE, PLANEINDEX

        The struct member offsets.

    • Constructor Detail

      • VkDisplayPlaneInfo2KHR

        public VkDisplayPlaneInfo2KHR​(java.nio.ByteBuffer container)
        Creates a VkDisplayPlaneInfo2KHR 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()
        the type of this structure.

      • pNext

        public long pNext()
        NULL or a pointer to a structure extending this structure.

      • mode

        public long mode()
        the display mode the application intends to program when using the specified plane.

      • planeIndex

        public int planeIndex()
        Returns:
        the value of the planeIndex field.

      • planeIndex

        public VkDisplayPlaneInfo2KHR planeIndex​(int value)
        Sets the specified value to the planeIndex field.

      • set

        public VkDisplayPlaneInfo2KHR set​(int sType,
                                  long pNext,
                                  long mode,
                                  int planeIndex)
        Initializes this struct with the specified values.

      • malloc

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

      • calloc

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

      • create

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

      • create

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

      • createSafe

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

      • malloc

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

      • calloc

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

      • malloc

        public static VkDisplayPlaneInfo2KHR.Buffer malloc​(int capacity,
                                                   org.lwjgl.system.MemoryStack stack)
        Returns a new VkDisplayPlaneInfo2KHR.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity

      • calloc

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

      • nmode

        public static long nmode​(long struct)
        Unsafe version of mode().

      • nplaneIndex

        public static int nplaneIndex​(long struct)
        Unsafe version of planeIndex().

      • 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.

      • nmode

        public static void nmode​(long struct,
                         long value)
        Unsafe version of mode.

      • nplaneIndex

        public static void nplaneIndex​(long struct,
                               int value)
        Unsafe version of planeIndex.