VkDisplayPlaneCapabilitiesKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDisplayPlaneCapabilitiesKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing capabilities of a mode and plane combination.
Description

The minimum and maximum position and extent fields describe the implementation limits, if any, as they apply to the specified display mode and plane. Vendors may support displaying a subset of a swapchain's presentable images on the specified display plane. This is expressed by returning minSrcPosition, maxSrcPosition, minSrcExtent, and maxSrcExtent values that indicate a range of possible positions and sizes may be used to specify the region within the presentable images that source pixels will be read from when creating a swapchain on the specified display mode and plane.

Vendors may also support mapping the presentable images`' content to a subset or superset of the visible region in the specified display mode. This is expressed by returning minDstPosition, maxDstPosition, minDstExtent and maxDstExtent values that indicate a range of possible positions and sizes may be used to describe the region within the display mode that the source pixels will be mapped to.

Other vendors may support only a 1-1 mapping between pixels in the presentable images and the display mode. This may be indicated by returning (0,0) for minSrcPosition, maxSrcPosition, minDstPosition, and maxDstPosition, and (display mode width, display mode height) for minSrcExtent, maxSrcExtent, minDstExtent, and maxDstExtent.

These values indicate the limits of the implementation's individual fields. Not all combinations of values within the offset and extent ranges returned in VkDisplayPlaneCapabilitiesKHR are guaranteed to be supported. Presentation requests specifying unsupported combinations may fail.

See Also

VkDisplayPlaneCapabilities2KHR, VkExtent2D, VkOffset2D, GetDisplayPlaneCapabilitiesKHR

Member documentation
- supportedAlpha – a bitmask of VkDisplayPlaneAlphaFlagBitsKHR describing the supported alpha blending modes.
- minSrcPosition – the minimum source rectangle offset supported by this plane using the specified mode.
- maxSrcPosition – the maximum source rectangle offset supported by this plane using the specified mode. The x and y components of maxSrcPosition must each be greater than or equal to the x and y components of minSrcPosition, respectively.
- minSrcExtent – the minimum source rectangle size supported by this plane using the specified mode.
- maxSrcExtent – the maximum source rectangle size supported by this plane using the specified mode.
- minDstPosition – minDstPosition, maxDstPosition, minDstExtent, maxDstExtent all have similar semantics to their corresponding ptext:Src equivalents, but apply to the output region within the mode rather than the input region within the source image. Unlike the ptext:Src offsets, minDstPosition and maxDstPosition may contain negative values.
- maxDstPosition – see minDstPosition
- minDstExtent – see minDstPosition
- maxDstExtent – see minDstPosition
Layout
```
 struct VkDisplayPlaneCapabilitiesKHR {
     VkDisplayPlaneAlphaFlagsKHR supportedAlpha;
     VkOffset2D minSrcPosition;
     VkOffset2D maxSrcPosition;
     VkExtent2D minSrcExtent;
     VkExtent2D maxSrcExtent;
     VkOffset2D minDstPosition;
     VkOffset2D maxDstPosition;
     VkExtent2D minDstExtent;
     VkExtent2D maxDstExtent;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkDisplayPlaneCapabilitiesKHR.Buffer
An array of VkDisplayPlaneCapabilitiesKHR 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`	`VkDisplayPlaneCapabilitiesKHR.Buffer` An array of `VkDisplayPlaneCapabilitiesKHR` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`MAXDSTEXTENT` The struct member offsets.
`static int`	`MAXDSTPOSITION` The struct member offsets.
`static int`	`MAXSRCEXTENT` The struct member offsets.
`static int`	`MAXSRCPOSITION` The struct member offsets.
`static int`	`MINDSTEXTENT` The struct member offsets.
`static int`	`MINDSTPOSITION` The struct member offsets.
`static int`	`MINSRCEXTENT` The struct member offsets.
`static int`	`MINSRCPOSITION` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`SUPPORTEDALPHA` 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
`VkDisplayPlaneCapabilitiesKHR(java.nio.ByteBuffer container)` Creates a `VkDisplayPlaneCapabilitiesKHR` 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 VkDisplayPlaneCapabilitiesKHR`	`calloc()` Returns a new `VkDisplayPlaneCapabilitiesKHR` instance allocated with `memCalloc`.
`static VkDisplayPlaneCapabilitiesKHR.Buffer`	`calloc(int capacity)` Returns a new `VkDisplayPlaneCapabilitiesKHR.Buffer` instance allocated with `memCalloc`.
`static VkDisplayPlaneCapabilitiesKHR`	`callocStack()` Returns a new `VkDisplayPlaneCapabilitiesKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPlaneCapabilitiesKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkDisplayPlaneCapabilitiesKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPlaneCapabilitiesKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPlaneCapabilitiesKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPlaneCapabilitiesKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPlaneCapabilitiesKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPlaneCapabilitiesKHR`	`create()` Returns a new `VkDisplayPlaneCapabilitiesKHR` instance allocated with `BufferUtils`.
`static VkDisplayPlaneCapabilitiesKHR.Buffer`	`create(int capacity)` Returns a new `VkDisplayPlaneCapabilitiesKHR.Buffer` instance allocated with `BufferUtils`.
`static VkDisplayPlaneCapabilitiesKHR`	`create(long address)` Returns a new `VkDisplayPlaneCapabilitiesKHR` instance for the specified memory address.
`static VkDisplayPlaneCapabilitiesKHR.Buffer`	`create(long address, int capacity)` Create a `VkDisplayPlaneCapabilitiesKHR.Buffer` instance at the specified memory.
`static VkDisplayPlaneCapabilitiesKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDisplayPlaneCapabilitiesKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDisplayPlaneCapabilitiesKHR`	`malloc()` Returns a new `VkDisplayPlaneCapabilitiesKHR` instance allocated with `memAlloc`.
`static VkDisplayPlaneCapabilitiesKHR.Buffer`	`malloc(int capacity)` Returns a new `VkDisplayPlaneCapabilitiesKHR.Buffer` instance allocated with `memAlloc`.
`static VkDisplayPlaneCapabilitiesKHR`	`mallocStack()` Returns a new `VkDisplayPlaneCapabilitiesKHR` instance allocated on the thread-local `MemoryStack`.
`static VkDisplayPlaneCapabilitiesKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkDisplayPlaneCapabilitiesKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDisplayPlaneCapabilitiesKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPlaneCapabilitiesKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDisplayPlaneCapabilitiesKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPlaneCapabilitiesKHR` instance allocated on the specified `MemoryStack`.
`VkExtent2D`	`maxDstExtent()` Returns a `VkExtent2D` view of the `maxDstExtent` field.
`VkOffset2D`	`maxDstPosition()` Returns a `VkOffset2D` view of the `maxDstPosition` field.
`VkExtent2D`	`maxSrcExtent()` Returns a `VkExtent2D` view of the `maxSrcExtent` field.
`VkOffset2D`	`maxSrcPosition()` Returns a `VkOffset2D` view of the `maxSrcPosition` field.
`VkExtent2D`	`minDstExtent()` Returns a `VkExtent2D` view of the `minDstExtent` field.
`VkOffset2D`	`minDstPosition()` Returns a `VkOffset2D` view of the `minDstPosition` field.
`VkExtent2D`	`minSrcExtent()` Returns a `VkExtent2D` view of the `minSrcExtent` field.
`VkOffset2D`	`minSrcPosition()` Returns a `VkOffset2D` view of the `minSrcPosition` field.
`static VkExtent2D`	`nmaxDstExtent(long struct)` Unsafe version of `maxDstExtent()`.
`static VkOffset2D`	`nmaxDstPosition(long struct)` Unsafe version of `maxDstPosition()`.
`static VkExtent2D`	`nmaxSrcExtent(long struct)` Unsafe version of `maxSrcExtent()`.
`static VkOffset2D`	`nmaxSrcPosition(long struct)` Unsafe version of `maxSrcPosition()`.
`static VkExtent2D`	`nminDstExtent(long struct)` Unsafe version of `minDstExtent()`.
`static VkOffset2D`	`nminDstPosition(long struct)` Unsafe version of `minDstPosition()`.
`static VkExtent2D`	`nminSrcExtent(long struct)` Unsafe version of `minSrcExtent()`.
`static VkOffset2D`	`nminSrcPosition(long struct)` Unsafe version of `minSrcPosition()`.
`static int`	`nsupportedAlpha(long struct)` Unsafe version of `supportedAlpha()`.
`int`	`sizeof()`
`int`	`supportedAlpha()` Returns the value of the `supportedAlpha` 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.
  - SUPPORTEDALPHA
```
public static final int SUPPORTEDALPHA
```
    The struct member offsets.
  - MINSRCPOSITION
```
public static final int MINSRCPOSITION
```
    The struct member offsets.
  - MAXSRCPOSITION
```
public static final int MAXSRCPOSITION
```
    The struct member offsets.
  - MINSRCEXTENT
```
public static final int MINSRCEXTENT
```
    The struct member offsets.
  - MAXSRCEXTENT
```
public static final int MAXSRCEXTENT
```
    The struct member offsets.
  - MINDSTPOSITION
```
public static final int MINDSTPOSITION
```
    The struct member offsets.
  - MAXDSTPOSITION
```
public static final int MAXDSTPOSITION
```
    The struct member offsets.
  - MINDSTEXTENT
```
public static final int MINDSTEXTENT
```
    The struct member offsets.
  - MAXDSTEXTENT
```
public static final int MAXDSTEXTENT
```
    The struct member offsets.
- Constructor Detail
  - VkDisplayPlaneCapabilitiesKHR
```
public VkDisplayPlaneCapabilitiesKHR(java.nio.ByteBuffer container)
```
    Creates a VkDisplayPlaneCapabilitiesKHR 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
  - supportedAlpha
```
public int supportedAlpha()
```
    Returns the value of the supportedAlpha field.
  - minSrcPosition
```
public VkOffset2D minSrcPosition()
```
    Returns a VkOffset2D view of the minSrcPosition field.
  - maxSrcPosition
```
public VkOffset2D maxSrcPosition()
```
    Returns a VkOffset2D view of the maxSrcPosition field.
  - minSrcExtent
```
public VkExtent2D minSrcExtent()
```
    Returns a VkExtent2D view of the minSrcExtent field.
  - maxSrcExtent
```
public VkExtent2D maxSrcExtent()
```
    Returns a VkExtent2D view of the maxSrcExtent field.
  - minDstPosition
```
public VkOffset2D minDstPosition()
```
    Returns a VkOffset2D view of the minDstPosition field.
  - maxDstPosition
```
public VkOffset2D maxDstPosition()
```
    Returns a VkOffset2D view of the maxDstPosition field.
  - minDstExtent
```
public VkExtent2D minDstExtent()
```
    Returns a VkExtent2D view of the minDstExtent field.
  - maxDstExtent
```
public VkExtent2D maxDstExtent()
```
    Returns a VkExtent2D view of the maxDstExtent field.
  - malloc
```
public static VkDisplayPlaneCapabilitiesKHR malloc()
```
    Returns a new VkDisplayPlaneCapabilitiesKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDisplayPlaneCapabilitiesKHR calloc()
```
    Returns a new VkDisplayPlaneCapabilitiesKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDisplayPlaneCapabilitiesKHR create()
```
    Returns a new VkDisplayPlaneCapabilitiesKHR instance allocated with BufferUtils.
  - create
```
public static VkDisplayPlaneCapabilitiesKHR create(long address)
```
    Returns a new VkDisplayPlaneCapabilitiesKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkDisplayPlaneCapabilitiesKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkDisplayPlaneCapabilitiesKHR.Buffer malloc(int capacity)
```
    Returns a new VkDisplayPlaneCapabilitiesKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDisplayPlaneCapabilitiesKHR.Buffer calloc(int capacity)
```
    Returns a new VkDisplayPlaneCapabilitiesKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDisplayPlaneCapabilitiesKHR.Buffer create(int capacity)
```
    Returns a new VkDisplayPlaneCapabilitiesKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDisplayPlaneCapabilitiesKHR.Buffer create(long address,
                                                          int capacity)
```
    Create a VkDisplayPlaneCapabilitiesKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkDisplayPlaneCapabilitiesKHR.Buffer createSafe(long address,
                                                                        int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkDisplayPlaneCapabilitiesKHR mallocStack()
```
    Returns a new VkDisplayPlaneCapabilitiesKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDisplayPlaneCapabilitiesKHR callocStack()
```
    Returns a new VkDisplayPlaneCapabilitiesKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDisplayPlaneCapabilitiesKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPlaneCapabilitiesKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDisplayPlaneCapabilitiesKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPlaneCapabilitiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkDisplayPlaneCapabilitiesKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkDisplayPlaneCapabilitiesKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDisplayPlaneCapabilitiesKHR.Buffer callocStack(int capacity)
```
    Returns a new VkDisplayPlaneCapabilitiesKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDisplayPlaneCapabilitiesKHR.Buffer mallocStack(int capacity,
                                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPlaneCapabilitiesKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDisplayPlaneCapabilitiesKHR.Buffer callocStack(int capacity,
                                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPlaneCapabilitiesKHR.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
  - nsupportedAlpha
```
public static int nsupportedAlpha(long struct)
```
    Unsafe version of supportedAlpha().
  - nminSrcPosition
```
public static VkOffset2D nminSrcPosition(long struct)
```
    Unsafe version of minSrcPosition().
  - nmaxSrcPosition
```
public static VkOffset2D nmaxSrcPosition(long struct)
```
    Unsafe version of maxSrcPosition().
  - nminSrcExtent
```
public static VkExtent2D nminSrcExtent(long struct)
```
    Unsafe version of minSrcExtent().
  - nmaxSrcExtent
```
public static VkExtent2D nmaxSrcExtent(long struct)
```
    Unsafe version of maxSrcExtent().
  - nminDstPosition
```
public static VkOffset2D nminDstPosition(long struct)
```
    Unsafe version of minDstPosition().
  - nmaxDstPosition
```
public static VkOffset2D nmaxDstPosition(long struct)
```
    Unsafe version of maxDstPosition().
  - nminDstExtent
```
public static VkExtent2D nminDstExtent(long struct)
```
    Unsafe version of minDstExtent().
  - nmaxDstExtent
```
public static VkExtent2D nmaxDstExtent(long struct)
```
    Unsafe version of maxDstExtent().

Class VkDisplayPlaneCapabilitiesKHR

Description

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

SUPPORTEDALPHA

MINSRCPOSITION

MAXSRCPOSITION

MINSRCEXTENT

MAXSRCEXTENT

MINDSTPOSITION

MAXDSTPOSITION

MINDSTEXTENT

MAXDSTEXTENT

Constructor Detail

VkDisplayPlaneCapabilitiesKHR

Method Detail

sizeof

supportedAlpha

minSrcPosition

maxSrcPosition

minSrcExtent

maxSrcExtent

minDstPosition

maxDstPosition

minDstExtent

maxDstExtent

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsupportedAlpha

nminSrcPosition

nmaxSrcPosition

nminSrcExtent

nmaxSrcExtent

nminDstPosition

nmaxDstPosition

nminDstExtent

nmaxDstExtent