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

All Implemented Interfaces:: java.lang.AutoCloseable, NativeResource, Pointer

public class VkDisplayPropertiesKHR
extends Struct

Khronos Reference Page
Vulkan Specification

Describes properties of a display device present on a Vulkan physical device.

Valid Usage

display must be a valid VkDisplayKHR handle
displayName must be a null-terminated string
supportedTransforms must be a valid combination of VkSurfaceTransformFlagBitsKHR values

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 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.
physicalDimensions – the physical width and height of the visible portion of the display, in millimeters
physicalResolution – the physical, native, or preferred resolution of the display

supportedTransforms – which transforms are supported by this display. One or more of:

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_BIT_KHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180_BIT_KHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270_BIT_KHR

SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90_BIT_KHR

SURFACE_TRANSFORM_IDENTITY_BIT_KHR

SURFACE_TRANSFORM_INHERIT_BIT_KHR

SURFACE_TRANSFORM_ROTATE_180_BIT_KHR

SURFACE_TRANSFORM_ROTATE_270_BIT_KHR

SURFACE_TRANSFORM_ROTATE_90_BIT_KHR

planeReorderPossible – 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 – 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.

Layout

struct VkDisplayPropertiesKHR {
    VkDisplayKHR display;
    const char * 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
  Pointer.Default

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  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, MemoryStack stack)` Returns a new `VkDisplayPropertiesKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPropertiesKHR`	`callocStack(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 or `null` if the address is `NULL`.
`static VkDisplayPropertiesKHR.Buffer`	`create(long address, int capacity)` Create a `VkDisplayPropertiesKHR.Buffer` instance at the specified memory.
`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, MemoryStack stack)` Returns a new `VkDisplayPropertiesKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDisplayPropertiesKHR`	`mallocStack(MemoryStack stack)` Returns a new `VkDisplayPropertiesKHR` instance allocated on the specified `MemoryStack`.
`int`	`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.
`int`	`planeReorderPossible()` Returns the value of the `planeReorderPossible` field.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`int`	`supportedTransforms()` Returns the value of the `supportedTransforms` field.

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- 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()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class 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 int planeReorderPossible()
```
    Returns the value of the planeReorderPossible field.
  - persistentContent
```
public int 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 or null if the 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
  - 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(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(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,
                                                        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,
                                                        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

Class VkDisplayPropertiesKHR

Valid Usage

Member documentation

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

Constructor Detail

VkDisplayPropertiesKHR

Method Detail

sizeof

display

displayName

displayNameString

physicalDimensions

physicalResolution

supportedTransforms

planeReorderPossible

persistentContent

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack