VkDisplayModeCreateInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDisplayModeCreateInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of a newly created display mode object.
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR
- pNext must be NULL
- flags must be 0
- parameters must be a valid VkDisplayModeParametersKHR structure
See Also

VkDisplayModeParametersKHR, CreateDisplayModeKHR

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – reserved for future use, and must be zero.
- parameters – a VkDisplayModeParametersKHR structure describing the display parameters to use in creating the new mode. If the parameters are not compatible with the specified display, the implementation must return ERROR_INITIALIZATION_FAILED.
Layout
```
 struct VkDisplayModeCreateInfoKHR {
     VkStructureType sType;
     void const * pNext;
     VkDisplayModeCreateFlagsKHR flags;
     VkDisplayModeParametersKHR parameters;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

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

Class VkDisplayModeCreateInfoKHR

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

FLAGS

PARAMETERS

Constructor Detail

VkDisplayModeCreateInfoKHR

Method Detail

sizeof

sType

pNext

flags

parameters

sType

pNext

flags

parameters

parameters

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

nparameters

nsType

npNext

nflags

nparameters