VkDisplayPropertiesKHR (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkDisplayPropertiesKHR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDisplayPropertiesKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing an available display device.
Member documentation
- 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 – 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. It can be NULL if no suitable name is available. If not NULL, the memory it points to must remain accessible as long as display is valid.
- physicalDimensions – describes the physical width and height of the visible portion of the display, in millimeters.
- 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 – a bitmask of VkSurfaceTransformFlagBitsKHR describing which transforms are supported by this display.
- 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 – 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.
Layout
```
 struct VkDisplayPropertiesKHR {
     VkDisplayKHR display;
     char const * displayName;
     VkExtent2D physicalDimensions;
     VkExtent2D physicalResolution;
     VkSurfaceTransformFlagsKHR supportedTransforms;
     VkBool32 planeReorderPossible;
     VkBool32 persistentContent;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkDisplayPropertiesKHR.Buffer
An array of VkDisplayPropertiesKHR structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkDisplayPropertiesKHR.Buffer` An array of `VkDisplayPropertiesKHR` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DISPLAY` The struct member offsets.
`static int`	`DISPLAYNAME` The struct member offsets.
`static int`	`PERSISTENTCONTENT` The struct member offsets.
`static int`	`PHYSICALDIMENSIONS` The struct member offsets.
`static int`	`PHYSICALRESOLUTION` The struct member offsets.
`static int`	`PLANEREORDERPOSSIBLE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`SUPPORTEDTRANSFORMS` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkDisplayPropertiesKHR(java.nio.ByteBuffer container)` Creates a `VkDisplayPropertiesKHR` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkDisplayPropertiesKHR`	`calloc()` Returns a new `VkDisplayPropertiesKHR` instance allocated with `memCalloc`.
`static VkDisplayPropertiesKHR.Buffer`	`calloc(int capacity)` Returns a new `VkDisplayPropertiesKHR.Buffer` instance allocated with `memCalloc`.
`static VkDisplayPropertiesKHR`	`callocStack()` Returns a new `VkDisplayPropertiesKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPropertiesKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkDisplayPropertiesKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPropertiesKHR.Buffer`	`callocStack(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.
`static VkDisplayPropertiesKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPropertiesKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPropertiesKHR`	`create()` Returns a new `VkDisplayPropertiesKHR` instance allocated with `BufferUtils`.
`static VkDisplayPropertiesKHR.Buffer`	`create(int capacity)` Returns a new `VkDisplayPropertiesKHR.Buffer` instance allocated with `BufferUtils`.
`static VkDisplayPropertiesKHR`	`create(long address)` Returns a new `VkDisplayPropertiesKHR` instance for the specified memory address.
`static VkDisplayPropertiesKHR.Buffer`	`create(long address, int capacity)` Create a `VkDisplayPropertiesKHR.Buffer` instance at the specified memory.
`static VkDisplayPropertiesKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDisplayPropertiesKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`display()` Returns the value of the `display` field.
`java.nio.ByteBuffer`	`displayName()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `displayName` field.
`java.lang.String`	`displayNameString()` Decodes the null-terminated string pointed to by the `displayName` field.
`static VkDisplayPropertiesKHR`	`malloc()` Returns a new `VkDisplayPropertiesKHR` instance allocated with `memAlloc`.
`static VkDisplayPropertiesKHR.Buffer`	`malloc(int capacity)` Returns a new `VkDisplayPropertiesKHR.Buffer` instance allocated with `memAlloc`.
`static VkDisplayPropertiesKHR`	`mallocStack()` Returns a new `VkDisplayPropertiesKHR` instance allocated on the thread-local `MemoryStack`.
`static VkDisplayPropertiesKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkDisplayPropertiesKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDisplayPropertiesKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPropertiesKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDisplayPropertiesKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPropertiesKHR` instance allocated on the specified `MemoryStack`.
`static long`	`ndisplay(long struct)` Unsafe version of `display()`.
`static java.nio.ByteBuffer`	`ndisplayName(long struct)` Unsafe version of `displayName()`.
`static java.lang.String`	`ndisplayNameString(long struct)` Unsafe version of `displayNameString()`.
`static int`	`npersistentContent(long struct)` Unsafe version of `persistentContent()`.
`static VkExtent2D`	`nphysicalDimensions(long struct)` Unsafe version of `physicalDimensions()`.
`static VkExtent2D`	`nphysicalResolution(long struct)` Unsafe version of `physicalResolution()`.
`static int`	`nplaneReorderPossible(long struct)` Unsafe version of `planeReorderPossible()`.
`static int`	`nsupportedTransforms(long struct)` Unsafe version of `supportedTransforms()`.
`boolean`	`persistentContent()` Returns the value of the `persistentContent` field.
`VkExtent2D`	`physicalDimensions()` Returns a `VkExtent2D` view of the `physicalDimensions` field.
`VkExtent2D`	`physicalResolution()` Returns a `VkExtent2D` view of the `physicalResolution` field.
`boolean`	`planeReorderPossible()` Returns the value of the `planeReorderPossible` field.
`int`	`sizeof()`
`int`	`supportedTransforms()` Returns the value of the `supportedTransforms` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - 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 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()
```
    Returns the value of the display field.
  - displayName
```
public java.nio.ByteBuffer displayName()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the displayName field.
  - displayNameString
```
public java.lang.String displayNameString()
```
    Decodes the null-terminated string pointed to by the displayName field.
  - physicalDimensions
```
public VkExtent2D physicalDimensions()
```
    Returns a VkExtent2D view of the physicalDimensions field.
  - physicalResolution
```
public VkExtent2D physicalResolution()
```
    Returns a VkExtent2D view of the physicalResolution field.
  - supportedTransforms
```
public int supportedTransforms()
```
    Returns the value of the supportedTransforms field.
  - planeReorderPossible
```
public boolean planeReorderPossible()
```
    Returns the value of the planeReorderPossible field.
  - persistentContent
```
public boolean persistentContent()
```
    Returns the value of the persistentContent field.
  - 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
```
public static VkDisplayPropertiesKHR mallocStack()
```
    Returns a new VkDisplayPropertiesKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDisplayPropertiesKHR callocStack()
```
    Returns a new VkDisplayPropertiesKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDisplayPropertiesKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPropertiesKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDisplayPropertiesKHR callocStack(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
  - mallocStack
```
public static VkDisplayPropertiesKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkDisplayPropertiesKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDisplayPropertiesKHR.Buffer callocStack(int capacity)
```
    Returns a new VkDisplayPropertiesKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDisplayPropertiesKHR.Buffer mallocStack(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
  - callocStack
```
public static VkDisplayPropertiesKHR.Buffer callocStack(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().
  - 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().

Class VkDisplayPropertiesKHR

Member documentation

Note

Note

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

DISPLAY

DISPLAYNAME

PHYSICALDIMENSIONS

PHYSICALRESOLUTION

SUPPORTEDTRANSFORMS

PLANEREORDERPOSSIBLE

PERSISTENTCONTENT

Constructor Detail

VkDisplayPropertiesKHR

Method Detail

sizeof

display

displayName

displayNameString

physicalDimensions

physicalResolution

supportedTransforms

planeReorderPossible

persistentContent

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ndisplay

ndisplayName

ndisplayNameString

nphysicalDimensions

nphysicalResolution

nsupportedTransforms

nplaneReorderPossible

npersistentContent