VkDisplayModePropertiesKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDisplayModePropertiesKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing display mode properties.
Member documentation
- displayMode – a handle to the display mode described in this structure. This handle will be valid for the lifetime of the Vulkan instance.
- parameters – a VkDisplayModeParametersKHR structure describing the display parameters associated with displayMode.
Layout
```
 struct VkDisplayModePropertiesKHR {
     VkDisplayModeKHR displayMode;
     VkDisplayModeParametersKHR parameters;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

Class VkDisplayModePropertiesKHR

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

DISPLAYMODE

PARAMETERS

Constructor Detail

VkDisplayModePropertiesKHR

Method Detail

sizeof

displayMode

parameters

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

ndisplayMode

nparameters