VkDisplayModeParametersKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDisplayModeParametersKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure describing display parameters associated with a display mode.
Description

Note

For example, a 60Hz display mode would report a refreshRate of 60,000.

Valid Usage
- The width member of visibleRegion must be greater than 0
- The height member of visibleRegion must be greater than 0
- refreshRate must be greater than 0
See Also

VkDisplayModeCreateInfoKHR, VkDisplayModePropertiesKHR, VkExtent2D

Member documentation
- visibleRegion – the 2D extents of the visible region.
- refreshRate – a uint32_t that is the number of times the display is refreshed each second multiplied by 1000.
Layout
```
 struct VkDisplayModeParametersKHR {
     VkExtent2D visibleRegion;
     uint32_t refreshRate;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

Class VkDisplayModeParametersKHR

Description

Note

Valid Usage

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

VISIBLEREGION

REFRESHRATE

Constructor Detail

VkDisplayModeParametersKHR

Method Detail

sizeof

visibleRegion

refreshRate

visibleRegion

visibleRegion

refreshRate

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nvisibleRegion

nrefreshRate

nvisibleRegion

nrefreshRate