VkDisplayPlaneProperties2KHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDisplayPlaneProperties2KHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing an available display plane.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR
- pNext must be NULL
See Also

VkDisplayPlanePropertiesKHR, GetPhysicalDeviceDisplayPlaneProperties2KHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- displayPlaneProperties – a VkDisplayPlanePropertiesKHR structure.
Layout
```
 struct VkDisplayPlaneProperties2KHR {
     VkStructureType sType;
     void * pNext;
     VkDisplayPlanePropertiesKHR displayPlaneProperties;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

Class VkDisplayPlaneProperties2KHR

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

DISPLAYPLANEPROPERTIES

Constructor Detail

VkDisplayPlaneProperties2KHR

Method Detail

sizeof

sType

pNext

displayPlaneProperties

sType

pNext

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

ndisplayPlaneProperties

nsType

npNext