VkDisplayPlaneInfo2KHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDisplayPlaneInfo2KHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure defining the intended configuration of a display plane.
Description

Note

This parameter also implicitly specifies a display.
- planeIndex is the plane which the application intends to use with the display.
The members of VkDisplayPlaneInfo2KHR correspond to the arguments to GetDisplayPlaneCapabilitiesKHR, with sType and pNext added for extensibility.

Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR
- pNext must be NULL
- mode must be a valid VkDisplayModeKHR handle
Host Synchronization
- Host access to mode must be externally synchronized
See Also

GetDisplayPlaneCapabilities2KHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- mode – the display mode the application intends to program when using the specified plane.
Layout
```
 struct VkDisplayPlaneInfo2KHR {
     VkStructureType sType;
     void const * pNext;
     VkDisplayModeKHR mode;
     uint32_t planeIndex;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`MODE` The struct member offsets.
`static int`	`PLANEINDEX` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`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
`VkDisplayPlaneInfo2KHR(java.nio.ByteBuffer container)` Creates a `VkDisplayPlaneInfo2KHR` 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 VkDisplayPlaneInfo2KHR`	`calloc()` Returns a new `VkDisplayPlaneInfo2KHR` instance allocated with `memCalloc`.
`static VkDisplayPlaneInfo2KHR.Buffer`	`calloc(int capacity)` Returns a new `VkDisplayPlaneInfo2KHR.Buffer` instance allocated with `memCalloc`.
`static VkDisplayPlaneInfo2KHR`	`callocStack()` Returns a new `VkDisplayPlaneInfo2KHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPlaneInfo2KHR.Buffer`	`callocStack(int capacity)` Returns a new `VkDisplayPlaneInfo2KHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPlaneInfo2KHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPlaneInfo2KHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPlaneInfo2KHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPlaneInfo2KHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDisplayPlaneInfo2KHR`	`create()` Returns a new `VkDisplayPlaneInfo2KHR` instance allocated with `BufferUtils`.
`static VkDisplayPlaneInfo2KHR.Buffer`	`create(int capacity)` Returns a new `VkDisplayPlaneInfo2KHR.Buffer` instance allocated with `BufferUtils`.
`static VkDisplayPlaneInfo2KHR`	`create(long address)` Returns a new `VkDisplayPlaneInfo2KHR` instance for the specified memory address.
`static VkDisplayPlaneInfo2KHR.Buffer`	`create(long address, int capacity)` Create a `VkDisplayPlaneInfo2KHR.Buffer` instance at the specified memory.
`static VkDisplayPlaneInfo2KHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDisplayPlaneInfo2KHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDisplayPlaneInfo2KHR`	`malloc()` Returns a new `VkDisplayPlaneInfo2KHR` instance allocated with `memAlloc`.
`static VkDisplayPlaneInfo2KHR.Buffer`	`malloc(int capacity)` Returns a new `VkDisplayPlaneInfo2KHR.Buffer` instance allocated with `memAlloc`.
`static VkDisplayPlaneInfo2KHR`	`mallocStack()` Returns a new `VkDisplayPlaneInfo2KHR` instance allocated on the thread-local `MemoryStack`.
`static VkDisplayPlaneInfo2KHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkDisplayPlaneInfo2KHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDisplayPlaneInfo2KHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPlaneInfo2KHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDisplayPlaneInfo2KHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDisplayPlaneInfo2KHR` instance allocated on the specified `MemoryStack`.
`long`	`mode()` Returns the value of the `mode` field.
`VkDisplayPlaneInfo2KHR`	`mode(long value)` Sets the specified value to the `mode` field.
`static long`	`nmode(long struct)` Unsafe version of `mode()`.
`static void`	`nmode(long struct, long value)` Unsafe version of `mode`.
`static int`	`nplaneIndex(long struct)` Unsafe version of `planeIndex()`.
`static void`	`nplaneIndex(long struct, int value)` Unsafe version of `planeIndex`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`int`	`planeIndex()` Returns the value of the `planeIndex` field.
`VkDisplayPlaneInfo2KHR`	`planeIndex(int value)` Sets the specified value to the `planeIndex` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkDisplayPlaneInfo2KHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkDisplayPlaneInfo2KHR`	`set(int sType, long pNext, long mode, int planeIndex)` Initializes this struct with the specified values.
`VkDisplayPlaneInfo2KHR`	`set(VkDisplayPlaneInfo2KHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkDisplayPlaneInfo2KHR`	`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.
  - MODE
```
public static final int MODE
```
    The struct member offsets.
  - PLANEINDEX
```
public static final int PLANEINDEX
```
    The struct member offsets.
- Constructor Detail
  - VkDisplayPlaneInfo2KHR
```
public VkDisplayPlaneInfo2KHR(java.nio.ByteBuffer container)
```
    Creates a VkDisplayPlaneInfo2KHR 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.
  - mode
```
public long mode()
```
    Returns the value of the mode field.
  - planeIndex
```
public int planeIndex()
```
    Returns the value of the planeIndex field.
  - sType
```
public VkDisplayPlaneInfo2KHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkDisplayPlaneInfo2KHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - mode
```
public VkDisplayPlaneInfo2KHR mode(long value)
```
    Sets the specified value to the mode field.
  - planeIndex
```
public VkDisplayPlaneInfo2KHR planeIndex(int value)
```
    Sets the specified value to the planeIndex field.
  - set
```
public VkDisplayPlaneInfo2KHR set(int sType,
                                  long pNext,
                                  long mode,
                                  int planeIndex)
```
    Initializes this struct with the specified values.
  - set
```
public VkDisplayPlaneInfo2KHR set(VkDisplayPlaneInfo2KHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkDisplayPlaneInfo2KHR malloc()
```
    Returns a new VkDisplayPlaneInfo2KHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDisplayPlaneInfo2KHR calloc()
```
    Returns a new VkDisplayPlaneInfo2KHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDisplayPlaneInfo2KHR create()
```
    Returns a new VkDisplayPlaneInfo2KHR instance allocated with BufferUtils.
  - create
```
public static VkDisplayPlaneInfo2KHR create(long address)
```
    Returns a new VkDisplayPlaneInfo2KHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkDisplayPlaneInfo2KHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkDisplayPlaneInfo2KHR.Buffer malloc(int capacity)
```
    Returns a new VkDisplayPlaneInfo2KHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDisplayPlaneInfo2KHR.Buffer calloc(int capacity)
```
    Returns a new VkDisplayPlaneInfo2KHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDisplayPlaneInfo2KHR.Buffer create(int capacity)
```
    Returns a new VkDisplayPlaneInfo2KHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDisplayPlaneInfo2KHR.Buffer create(long address,
                                                   int capacity)
```
    Create a VkDisplayPlaneInfo2KHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkDisplayPlaneInfo2KHR.Buffer createSafe(long address,
                                                                 int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkDisplayPlaneInfo2KHR mallocStack()
```
    Returns a new VkDisplayPlaneInfo2KHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDisplayPlaneInfo2KHR callocStack()
```
    Returns a new VkDisplayPlaneInfo2KHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDisplayPlaneInfo2KHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPlaneInfo2KHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDisplayPlaneInfo2KHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPlaneInfo2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkDisplayPlaneInfo2KHR.Buffer mallocStack(int capacity)
```
    Returns a new VkDisplayPlaneInfo2KHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDisplayPlaneInfo2KHR.Buffer callocStack(int capacity)
```
    Returns a new VkDisplayPlaneInfo2KHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDisplayPlaneInfo2KHR.Buffer mallocStack(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPlaneInfo2KHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDisplayPlaneInfo2KHR.Buffer callocStack(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDisplayPlaneInfo2KHR.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().
  - nmode
```
public static long nmode(long struct)
```
    Unsafe version of mode().
  - nplaneIndex
```
public static int nplaneIndex(long struct)
```
    Unsafe version of planeIndex().
  - 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.
  - nmode
```
public static void nmode(long struct,
                         long value)
```
    Unsafe version of mode.
  - nplaneIndex
```
public static void nplaneIndex(long struct,
                               int value)
```
    Unsafe version of planeIndex.

Class VkDisplayPlaneInfo2KHR

Description

Note

Valid Usage (Implicit)

Host Synchronization

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

MODE

PLANEINDEX

Constructor Detail

VkDisplayPlaneInfo2KHR

Method Detail

sizeof

sType

pNext

mode

planeIndex

sType

pNext

mode

planeIndex

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nmode

nplaneIndex

nsType

npNext

nmode

nplaneIndex