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

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkDisplayPresentInfoKHR
extends Struct
```
Khronos Reference Page
Vulkan Specification
When the VK_KHR_display_swapchain extension is enabled additional fields can be specified when presenting an image to a swapchain by setting VkPresentInfoKHR::pNext to point to a VkDisplayPresentInfoKHR structure.

Valid Usage
- sType must be STRUCTURE_TYPE_DISPLAY_PRESENT_INFO_KHR
- pNext must be NULL
- srcRect must specify a rectangular region that is a subset of the image being presented
- dstRect must specify a rectangular region that is a subset of the visibleRegion parameter of the display mode the swapchain being presented uses
- If the persistentContent member of the VkDisplayPropertiesKHR structure returned by GetPhysicalDeviceDisplayPropertiesKHR for the display the present operation targets then persistent must be FALSE
Member documentation
- sType – the type of this structure. Must be: STRUCTURE_TYPE_DISPLAY_PRESENT_INFO_KHR
- pNext – reserved for use by extensions
- srcRect – a rectangular region of pixels to present. It must be a subset of the image being presented. If VkDisplayPresentInfoKHR is not specified, this region will be assumed to be the entire presentable image.
- dstRect – a rectangular region within the visible region of the swapchain’s display mode. If VkDisplayPresentInfoKHR is not specified, this region will be assumed to be the entire visible region of the visible region of the swapchain’s mode. If the specified rectangle is a subset of the display mode’s visible region, content from display planes below the swapchain’s plane will be visible outside the rectangle. If there are no planes below the swapchain’s, the area outside the specified rectangle will be black. If portions of the specified rectangle are outside of the display’s visible region, pixels mapping only to those portions of the rectangle will be discarded.
- persistent – if TRUE, the display engine will enable buffered mode on displays that support it. This allows the display engine to stop sending content to the display until a new image is presented. The display will instead maintain a copy of the last presented image. This allows less power to be used, but may increase presentation latency. If VkDisplayPresentInfoKHR is not specified, persistent mode will not be used.
Layout
```
struct VkDisplayPresentInfoKHR {
    VkStructureType sType;
    const void * pNext;
    VkRect2D srcRect;
    VkRect2D dstRect;
    VkBool32 persistent;
}
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkDisplayPresentInfoKHR.Buffer
An array of VkDisplayPresentInfoKHR 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
`VkDisplayPresentInfoKHR(java.nio.ByteBuffer container)` Creates a `VkDisplayPresentInfoKHR` 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 VkDisplayPresentInfoKHR`	`calloc()` Returns a new `VkDisplayPresentInfoKHR` instance allocated with `memCalloc`.
`static VkDisplayPresentInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkDisplayPresentInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkDisplayPresentInfoKHR`	`callocStack()` Returns a new `VkDisplayPresentInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPresentInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkDisplayPresentInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPresentInfoKHR.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkDisplayPresentInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPresentInfoKHR`	`callocStack(MemoryStack stack)` Returns a new `VkDisplayPresentInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPresentInfoKHR`	`create()` Returns a new `VkDisplayPresentInfoKHR` instance allocated with `BufferUtils`.
`static VkDisplayPresentInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkDisplayPresentInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkDisplayPresentInfoKHR`	`create(long address)` Returns a new `VkDisplayPresentInfoKHR` instance for the specified memory address or `null` if the address is `NULL`.
`static VkDisplayPresentInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkDisplayPresentInfoKHR.Buffer` instance at the specified memory.
`VkRect2D`	`dstRect()` Returns a `VkRect2D` view of the `dstRect` field.
`VkDisplayPresentInfoKHR`	`dstRect(VkRect2D value)` Copies the specified `VkRect2D` to the `dstRect` field.
`static VkDisplayPresentInfoKHR`	`malloc()` Returns a new `VkDisplayPresentInfoKHR` instance allocated with `memAlloc`.
`static VkDisplayPresentInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkDisplayPresentInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkDisplayPresentInfoKHR`	`mallocStack()` Returns a new `VkDisplayPresentInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkDisplayPresentInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkDisplayPresentInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDisplayPresentInfoKHR.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkDisplayPresentInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDisplayPresentInfoKHR`	`mallocStack(MemoryStack stack)` Returns a new `VkDisplayPresentInfoKHR` instance allocated on the specified `MemoryStack`.
`VkDisplayPresentInfoKHR`	`nset(long struct)` Unsafe version of `set`.
`int`	`persistent()` Returns the value of the `persistent` field.
`VkDisplayPresentInfoKHR`	`persistent(int value)` Sets the specified value to the `persistent` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkDisplayPresentInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkDisplayPresentInfoKHR`	`set(int sType, long pNext, VkRect2D srcRect, VkRect2D dstRect, int persistent)` Initializes this struct with the specified values.
`VkDisplayPresentInfoKHR`	`set(VkDisplayPresentInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`VkRect2D`	`srcRect()` Returns a `VkRect2D` view of the `srcRect` field.
`VkDisplayPresentInfoKHR`	`srcRect(VkRect2D value)` Copies the specified `VkRect2D` to the `srcRect` field.
`int`	`sType()` Returns the value of the `sType` field.
`VkDisplayPresentInfoKHR`	`sType(int value)` Sets the specified value to the `sType` 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
  - VkDisplayPresentInfoKHR
```
public VkDisplayPresentInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkDisplayPresentInfoKHR 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
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - srcRect
```
public VkRect2D srcRect()
```
    Returns a VkRect2D view of the srcRect field.
  - dstRect
```
public VkRect2D dstRect()
```
    Returns a VkRect2D view of the dstRect field.
  - persistent
```
public int persistent()
```
    Returns the value of the persistent field.
  - sType
```
public VkDisplayPresentInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkDisplayPresentInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - srcRect
```
public VkDisplayPresentInfoKHR srcRect(VkRect2D value)
```
    Copies the specified VkRect2D to the srcRect field.
  - dstRect
```
public VkDisplayPresentInfoKHR dstRect(VkRect2D value)
```
    Copies the specified VkRect2D to the dstRect field.
  - persistent
```
public VkDisplayPresentInfoKHR persistent(int value)
```
    Sets the specified value to the persistent field.
  - set
```
public VkDisplayPresentInfoKHR set(int sType,
                                   long pNext,
                                   VkRect2D srcRect,
                                   VkRect2D dstRect,
                                   int persistent)
```
    Initializes this struct with the specified values.
  - nset
```
public VkDisplayPresentInfoKHR nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkDisplayPresentInfoKHR set(VkDisplayPresentInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkDisplayPresentInfoKHR malloc()
```
    Returns a new VkDisplayPresentInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDisplayPresentInfoKHR calloc()
```
    Returns a new VkDisplayPresentInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDisplayPresentInfoKHR create()
```
    Returns a new VkDisplayPresentInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkDisplayPresentInfoKHR create(long address)
```
    Returns a new VkDisplayPresentInfoKHR instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkDisplayPresentInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkDisplayPresentInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDisplayPresentInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkDisplayPresentInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDisplayPresentInfoKHR.Buffer create(int capacity)
```
    Returns a new VkDisplayPresentInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDisplayPresentInfoKHR.Buffer create(long address,
                                                    int capacity)
```
    Create a VkDisplayPresentInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDisplayPresentInfoKHR mallocStack()
```
    Returns a new VkDisplayPresentInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDisplayPresentInfoKHR callocStack()
```
    Returns a new VkDisplayPresentInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDisplayPresentInfoKHR mallocStack(MemoryStack stack)
```
    Returns a new VkDisplayPresentInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDisplayPresentInfoKHR callocStack(MemoryStack stack)
```
    Returns a new VkDisplayPresentInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkDisplayPresentInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkDisplayPresentInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDisplayPresentInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkDisplayPresentInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDisplayPresentInfoKHR.Buffer mallocStack(int capacity,
                                                         MemoryStack stack)
```
    Returns a new VkDisplayPresentInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDisplayPresentInfoKHR.Buffer callocStack(int capacity,
                                                         MemoryStack stack)
```
    Returns a new VkDisplayPresentInfoKHR.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 VkDisplayPresentInfoKHR

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

VkDisplayPresentInfoKHR

Method Detail

sizeof

sType

pNext

srcRect

dstRect

persistent

sType

pNext

srcRect

dstRect

persistent

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack