VkDisplayPlanePropertiesKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDisplayPlanePropertiesKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing display plane properties.
Member documentation
- currentDisplay – the handle of the display the plane is currently associated with. If the plane is not currently attached to any displays, this will be NULL_HANDLE.
- currentStackIndex – the current z-order of the plane. This will be between 0 and the value returned by vkGetPhysicalDeviceDisplayPlanePropertiesKHR in pPropertyCount.
Layout
```
 struct VkDisplayPlanePropertiesKHR {
     VkDisplayKHR currentDisplay;
     uint32_t currentStackIndex;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CURRENTDISPLAY` The struct member offsets.
`static int`	`CURRENTSTACKINDEX` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

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

Constructor Summary

Constructors
Constructor and Description
`VkDisplayPlanePropertiesKHR(java.nio.ByteBuffer container)` Creates a `VkDisplayPlanePropertiesKHR` 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 VkDisplayPlanePropertiesKHR`	`calloc()` Returns a new `VkDisplayPlanePropertiesKHR` instance allocated with `memCalloc`.
`static VkDisplayPlanePropertiesKHR.Buffer`	`calloc(int capacity)` Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated with `memCalloc`.
`static VkDisplayPlanePropertiesKHR`	`callocStack()` Returns a new `VkDisplayPlanePropertiesKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPlanePropertiesKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPlanePropertiesKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPlanePropertiesKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPlanePropertiesKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPlanePropertiesKHR`	`create()` Returns a new `VkDisplayPlanePropertiesKHR` instance allocated with `BufferUtils`.
`static VkDisplayPlanePropertiesKHR.Buffer`	`create(int capacity)` Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated with `BufferUtils`.
`static VkDisplayPlanePropertiesKHR`	`create(long address)` Returns a new `VkDisplayPlanePropertiesKHR` instance for the specified memory address.
`static VkDisplayPlanePropertiesKHR.Buffer`	`create(long address, int capacity)` Create a `VkDisplayPlanePropertiesKHR.Buffer` instance at the specified memory.
`static VkDisplayPlanePropertiesKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDisplayPlanePropertiesKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`currentDisplay()` Returns the value of the `currentDisplay` field.
`int`	`currentStackIndex()` Returns the value of the `currentStackIndex` field.
`static VkDisplayPlanePropertiesKHR`	`malloc()` Returns a new `VkDisplayPlanePropertiesKHR` instance allocated with `memAlloc`.
`static VkDisplayPlanePropertiesKHR.Buffer`	`malloc(int capacity)` Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated with `memAlloc`.
`static VkDisplayPlanePropertiesKHR`	`mallocStack()` Returns a new `VkDisplayPlanePropertiesKHR` instance allocated on the thread-local `MemoryStack`.
`static VkDisplayPlanePropertiesKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDisplayPlanePropertiesKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPlanePropertiesKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDisplayPlanePropertiesKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPlanePropertiesKHR` instance allocated on the specified `MemoryStack`.
`static long`	`ncurrentDisplay(long struct)` Unsafe version of `currentDisplay()`.
`static int`	`ncurrentStackIndex(long struct)` Unsafe version of `currentStackIndex()`.
`int`	`sizeof()`

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.
  - CURRENTDISPLAY
```
public static final int CURRENTDISPLAY
```
    The struct member offsets.
  - CURRENTSTACKINDEX
```
public static final int CURRENTSTACKINDEX
```
    The struct member offsets.
- Constructor Detail
  - VkDisplayPlanePropertiesKHR
```
public VkDisplayPlanePropertiesKHR(java.nio.ByteBuffer container)
```
    Creates a VkDisplayPlanePropertiesKHR 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
  - currentDisplay
```
public long currentDisplay()
```
    Returns the value of the currentDisplay field.
  - currentStackIndex
```
public int currentStackIndex()
```
    Returns the value of the currentStackIndex field.
  - malloc
```
public static VkDisplayPlanePropertiesKHR malloc()
```
    Returns a new VkDisplayPlanePropertiesKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDisplayPlanePropertiesKHR calloc()
```
    Returns a new VkDisplayPlanePropertiesKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDisplayPlanePropertiesKHR create()
```
    Returns a new VkDisplayPlanePropertiesKHR instance allocated with BufferUtils.
  - create
```
public static VkDisplayPlanePropertiesKHR create(long address)
```
    Returns a new VkDisplayPlanePropertiesKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkDisplayPlanePropertiesKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkDisplayPlanePropertiesKHR.Buffer malloc(int capacity)
```
    Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDisplayPlanePropertiesKHR.Buffer calloc(int capacity)
```
    Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDisplayPlanePropertiesKHR.Buffer create(int capacity)
```
    Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDisplayPlanePropertiesKHR.Buffer create(long address,
                                                        int capacity)
```
    Create a VkDisplayPlanePropertiesKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkDisplayPlanePropertiesKHR.Buffer createSafe(long address,
                                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkDisplayPlanePropertiesKHR mallocStack()
```
    Returns a new VkDisplayPlanePropertiesKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDisplayPlanePropertiesKHR callocStack()
```
    Returns a new VkDisplayPlanePropertiesKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDisplayPlanePropertiesKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPlanePropertiesKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDisplayPlanePropertiesKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPlanePropertiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkDisplayPlanePropertiesKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDisplayPlanePropertiesKHR.Buffer callocStack(int capacity)
```
    Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDisplayPlanePropertiesKHR.Buffer mallocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPlanePropertiesKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDisplayPlanePropertiesKHR.Buffer callocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPlanePropertiesKHR.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
  - ncurrentDisplay
```
public static long ncurrentDisplay(long struct)
```
    Unsafe version of currentDisplay().
  - ncurrentStackIndex
```
public static int ncurrentStackIndex(long struct)
```
    Unsafe version of currentStackIndex().

Class VkDisplayPlanePropertiesKHR

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

CURRENTDISPLAY

CURRENTSTACKINDEX

Constructor Detail

VkDisplayPlanePropertiesKHR

Method Detail

sizeof

currentDisplay

currentStackIndex

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ncurrentDisplay

ncurrentStackIndex