VkDisplayPresentInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDisplayPresentInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing parameters of a queue presentation to a swapchain.
Description

If the extent of the srcRect and dstRect are not equal, the presented pixels will be scaled accordingly.

Valid Usage
- 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 vkGetPhysicalDeviceDisplayPropertiesKHR for the display the present operation targets then persistent must be FALSE
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_DISPLAY_PRESENT_INFO_KHR
See Also

VkRect2D

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- 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 this is 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;
     void const * 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
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`DSTRECT` The struct member offsets.
`static int`	`PERSISTENT` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`SRCRECT` The struct member offsets.
`static int`	`STYPE` 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
`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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPresentInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPresentInfoKHR`	`callocStack(org.lwjgl.system.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.
`static VkDisplayPresentInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkDisplayPresentInfoKHR.Buffer` instance at the specified memory.
`static VkDisplayPresentInfoKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDisplayPresentInfoKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`VkRect2D`	`dstRect()` Returns a `VkRect2D` view of the `dstRect` field.
`VkDisplayPresentInfoKHR`	`dstRect(java.util.function.Consumer<VkRect2D> consumer)` Passes the `dstRect` field to the specified `Consumer`.
`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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPresentInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDisplayPresentInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPresentInfoKHR` instance allocated on the specified `MemoryStack`.
`static VkRect2D`	`ndstRect(long struct)` Unsafe version of `dstRect()`.
`static void`	`ndstRect(long struct, VkRect2D value)` Unsafe version of `dstRect`.
`static int`	`npersistent(long struct)` Unsafe version of `persistent()`.
`static void`	`npersistent(long struct, int value)` Unsafe version of `persistent`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static VkRect2D`	`nsrcRect(long struct)` Unsafe version of `srcRect()`.
`static void`	`nsrcRect(long struct, VkRect2D value)` Unsafe version of `srcRect`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`boolean`	`persistent()` Returns the value of the `persistent` field.
`VkDisplayPresentInfoKHR`	`persistent(boolean 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, boolean persistent)` Initializes this struct with the specified values.
`VkDisplayPresentInfoKHR`	`set(VkDisplayPresentInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`VkRect2D`	`srcRect()` Returns a `VkRect2D` view of the `srcRect` field.
`VkDisplayPresentInfoKHR`	`srcRect(java.util.function.Consumer<VkRect2D> consumer)` Passes the `srcRect` field to the specified `Consumer`.
`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, 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.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - SRCRECT
```
public static final int SRCRECT
```
    The struct member offsets.
  - DSTRECT
```
public static final int DSTRECT
```
    The struct member offsets.
  - PERSISTENT
```
public static final int PERSISTENT
```
    The struct member offsets.
- 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.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 boolean 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.
  - srcRect
```
public VkDisplayPresentInfoKHR srcRect(java.util.function.Consumer<VkRect2D> consumer)
```
    Passes the srcRect field to the specified Consumer.
  - dstRect
```
public VkDisplayPresentInfoKHR dstRect(VkRect2D value)
```
    Copies the specified VkRect2D to the dstRect field.
  - dstRect
```
public VkDisplayPresentInfoKHR dstRect(java.util.function.Consumer<VkRect2D> consumer)
```
    Passes the dstRect field to the specified Consumer.
  - persistent
```
public VkDisplayPresentInfoKHR persistent(boolean value)
```
    Sets the specified value to the persistent field.
  - set
```
public VkDisplayPresentInfoKHR set(int sType,
                                   long pNext,
                                   VkRect2D srcRect,
                                   VkRect2D dstRect,
                                   boolean persistent)
```
    Initializes this struct with the specified values.
  - 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.
  - createSafe
```
@Nullable
public static VkDisplayPresentInfoKHR createSafe(long address)
```
    Like create, but returns null if 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
  - createSafe
```
@Nullable
public static VkDisplayPresentInfoKHR.Buffer createSafe(long address,
                                                                  int capacity)
```
    Like create, but returns null if address is NULL.
  - 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(org.lwjgl.system.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(org.lwjgl.system.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,
                                                         org.lwjgl.system.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,
                                                         org.lwjgl.system.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
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nsrcRect
```
public static VkRect2D nsrcRect(long struct)
```
    Unsafe version of srcRect().
  - ndstRect
```
public static VkRect2D ndstRect(long struct)
```
    Unsafe version of dstRect().
  - npersistent
```
public static int npersistent(long struct)
```
    Unsafe version of persistent().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nsrcRect
```
public static void nsrcRect(long struct,
                            VkRect2D value)
```
    Unsafe version of srcRect.
  - ndstRect
```
public static void ndstRect(long struct,
                            VkRect2D value)
```
    Unsafe version of dstRect.
  - npersistent
```
public static void npersistent(long struct,
                               int value)
```
    Unsafe version of persistent.

Class VkDisplayPresentInfoKHR

Description

Valid Usage

Valid Usage (Implicit)

See Also

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

ALIGNOF

STYPE

PNEXT

SRCRECT

DSTRECT

PERSISTENT

Constructor Detail

VkDisplayPresentInfoKHR

Method Detail

sizeof

sType

pNext

srcRect

dstRect

persistent

sType

pNext

srcRect

srcRect

dstRect

dstRect

persistent

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nsrcRect

ndstRect

npersistent

nsType

npNext

nsrcRect

ndstRect

npersistent