Package org.lwjgl.vulkan

Class VkDisplayPropertiesKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkDisplayPropertiesKHR>
org.lwjgl.vulkan.VkDisplayPropertiesKHR
All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer
public class VkDisplayPropertiesKHR extends Struct<VkDisplayPropertiesKHR> implements NativeResource
Structure describing an available display device.
See Also

VkDisplayProperties2KHR, VkExtent2D, GetPhysicalDeviceDisplayPropertiesKHR

Layout


 struct VkDisplayPropertiesKHR {
     VkDisplayKHR display();
     char const * displayName();
     VkExtent2D physicalDimensions();
     VkExtent2D physicalResolution();
     VkSurfaceTransformFlagsKHR supportedTransforms();
     VkBool32 planeReorderPossible();
     VkBool32 persistentContent();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • DISPLAY

      public static final int DISPLAY
      The struct member offsets.

    • DISPLAYNAME

      public static final int DISPLAYNAME
      The struct member offsets.

    • PHYSICALDIMENSIONS

      public static final int PHYSICALDIMENSIONS
      The struct member offsets.

    • PHYSICALRESOLUTION

      public static final int PHYSICALRESOLUTION
      The struct member offsets.

    • SUPPORTEDTRANSFORMS

      public static final int SUPPORTEDTRANSFORMS
      The struct member offsets.

    • PLANEREORDERPOSSIBLE

      public static final int PLANEREORDERPOSSIBLE
      The struct member offsets.

    • PERSISTENTCONTENT

      public static final int PERSISTENTCONTENT
      The struct member offsets.

  • Constructor Details

    • VkDisplayPropertiesKHR

      public VkDisplayPropertiesKHR(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 Details

    • sizeof

      public int sizeof()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<VkDisplayPropertiesKHR>

    • 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

      public ByteBuffer displayName()
      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.

    • displayNameString

      public 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.Buffer malloc(int capacity)
      Returns a new VkDisplayPropertiesKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkDisplayPropertiesKHR.Buffer calloc(int capacity)
      Returns a new VkDisplayPropertiesKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkDisplayPropertiesKHR.Buffer create(int capacity)
      Returns a new VkDisplayPropertiesKHR.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkDisplayPropertiesKHR.Buffer create(long address, int capacity)
      Create a VkDisplayPropertiesKHR.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

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

    • mallocStack

      @Deprecated public static VkDisplayPropertiesKHR mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkDisplayPropertiesKHR callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkDisplayPropertiesKHR mallocStack(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkDisplayPropertiesKHR callocStack(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkDisplayPropertiesKHR.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkDisplayPropertiesKHR.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkDisplayPropertiesKHR.Buffer mallocStack(int capacity, MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkDisplayPropertiesKHR.Buffer callocStack(int capacity, MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • malloc

      public static VkDisplayPropertiesKHR malloc(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(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, MemoryStack stack)
      Returns a new VkDisplayPropertiesKHR.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VkDisplayPropertiesKHR.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new VkDisplayPropertiesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • ndisplay

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

    • ndisplayName

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

    • ndisplayNameString

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

    • nphysicalDimensions

      public static VkExtent2D nphysicalDimensions(long struct)
      Unsafe version of physicalDimensions().

    • nphysicalResolution

      public static VkExtent2D nphysicalResolution(long struct)
      Unsafe version of physicalResolution().

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