Package org.lwjgl.vulkan

Class VkDisplayPropertiesKHR

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • DISPLAY, DISPLAYNAME, PHYSICALDIMENSIONS, PHYSICALRESOLUTION, SUPPORTEDTRANSFORMS, PLANEREORDERPOSSIBLE, PERSISTENTCONTENT

        The struct member offsets.

    • Constructor Detail

      • VkDisplayPropertiesKHR

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

      • display

        public long display()
        a handle that is used to refer to the display described here. This handle will be valid for the lifetime of the Vulkan instance.

      • displayName, displayNameString

        public java.nio.ByteBuffer displayName()

public java.lang.String displayNameString()
        NULL or a pointer to a null-terminated UTF-8 string containing the name of the display. Generally, this will be the name provided by the display’s EDID. If NULL, no suitable name is available. If not NULL, the string pointed to must remain accessible and unmodified as long as display is valid.

      • physicalDimensions

        public VkExtent2D physicalDimensions()
        describes the physical width and height of the visible portion of the display, in millimeters.

      • physicalResolution

        public VkExtent2D physicalResolution()
        describes the physical, native, or preferred resolution of the display.
        Note

        For devices which have no natural value to return here, implementations should return the maximum resolution supported.

      • supportedTransforms

        public int supportedTransforms()
        a bitmask of VkSurfaceTransformFlagBitsKHR describing which transforms are supported by this display.

      • planeReorderPossible

        public boolean planeReorderPossible()
        tells whether the planes on this display can have their z order changed. If this is TRUE, the application can re-arrange the planes on this display in any order relative to each other.

      • persistentContent

        public boolean persistentContent()
        tells whether the display supports self-refresh/internal buffering. If this is true, the application can submit persistent present operations on swapchains created against this display.
        Note

        Persistent presents may have higher latency, and may use less power when the screen content is updated infrequently, or when only a portion of the screen needs to be updated in most frames.

      • malloc

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

      • calloc

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

      • create

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

      • create

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

      • createSafe

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

      • malloc

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

      • calloc

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

      • malloc

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

      • calloc

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

      • ndisplay

        public static long ndisplay​(long struct)
        Unsafe version of display().

      • ndisplayName

        public static java.nio.ByteBuffer ndisplayName​(long struct)
        Unsafe version of displayName().

      • ndisplayNameString

        public static java.lang.String ndisplayNameString​(long struct)
        Unsafe version of displayNameString().

      • nsupportedTransforms

        public static int nsupportedTransforms​(long struct)
        Unsafe version of supportedTransforms().

      • nplaneReorderPossible

        public static int nplaneReorderPossible​(long struct)
        Unsafe version of planeReorderPossible().

      • npersistentContent

        public static int npersistentContent​(long struct)
        Unsafe version of persistentContent().