VkDeviceGroupPresentInfoKHR (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkDeviceGroupPresentInfoKHR
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Mode and mask controlling which physical devices' images are presented.
Description

If mode is DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR, then each element of pDeviceMasks selects which instance of the swapchain image is presented. Each element of pDeviceMasks must have exactly one bit set, and the corresponding physical device must have a presentation engine as reported by VkDeviceGroupPresentCapabilitiesKHR.

If mode is DEVICE_GROUP_PRESENT_MODE_REMOTE_BIT_KHR, then each element of pDeviceMasks selects which instance of the swapchain image is presented. Each element of pDeviceMasks must have exactly one bit set, and some physical device in the logical device must include that bit in its VkDeviceGroupPresentCapabilitiesKHR::presentMask.

If mode is DEVICE_GROUP_PRESENT_MODE_SUM_BIT_KHR, then each element of pDeviceMasks selects which instances of the swapchain image are component-wise summed and the sum of those images is presented. If the sum in any component is outside the representable range, the value of that component is undefined. Each element of pDeviceMasks must have a value for which all set bits are set in one of the elements of VkDeviceGroupPresentCapabilitiesKHR::presentMask.

If mode is DEVICE_GROUP_PRESENT_MODE_LOCAL_MULTI_DEVICE_BIT_KHR, then each element of pDeviceMasks selects which instance(s) of the swapchain images are presented. For each bit set in each element of pDeviceMasks, the corresponding physical device must have a presentation engine as reported by VkDeviceGroupPresentCapabilitiesKHR.

If VkDeviceGroupPresentInfoKHR is not provided or swapchainCount is zero then the masks are considered to be 1. If VkDeviceGroupPresentInfoKHR is not provided, mode is considered to be DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR.

Valid Usage
- swapchainCount must equal 0 or VkPresentInfoKHR::swapchainCount
- If mode is DEVICE_GROUP_PRESENT_MODE_LOCAL_BIT_KHR, then each element of pDeviceMasks must have exactly one bit set, and the corresponding element of VkDeviceGroupPresentCapabilitiesKHR::presentMask must be non-zero
- If mode is DEVICE_GROUP_PRESENT_MODE_REMOTE_BIT_KHR, then each element of pDeviceMasks must have exactly one bit set, and some physical device in the logical device must include that bit in its VkDeviceGroupPresentCapabilitiesKHR::presentMask.
- If mode is DEVICE_GROUP_PRESENT_MODE_SUM_BIT_KHR, then each element of pDeviceMasks must have a value for which all set bits are set in one of the elements of VkDeviceGroupPresentCapabilitiesKHR::presentMask
- If mode is DEVICE_GROUP_PRESENT_MODE_LOCAL_MULTI_DEVICE_BIT_KHR, then for each bit set in each element of pDeviceMasks, the corresponding element of VkDeviceGroupPresentCapabilitiesKHR::presentMask must be non-zero
- The value of each element of pDeviceMasks must be equal to the device mask passed in VkAcquireNextImageInfoKHR::deviceMask when the image index was last acquired
- mode must have exactly one bit set, and that bit must have been included in VkDeviceGroupSwapchainCreateInfoKHR::modes
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_DEVICE_GROUP_PRESENT_INFO_KHR
- If swapchainCount is not 0, pDeviceMasks must be a valid pointer to an array of swapchainCount uint32_t values
- mode must be a valid VkDeviceGroupPresentModeFlagBitsKHR value
Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- swapchainCount – zero or the number of elements in pDeviceMasks.
- pDeviceMasks – a pointer to an array of device masks, one for each element of VkPresentInfoKHR::pSwapchains.
- mode – the device group present mode that will be used for this present.
Layout
```
 struct VkDeviceGroupPresentInfoKHR {
     VkStructureType sType;
     void const * pNext;
     uint32_t swapchainCount;
     uint32_t const * pDeviceMasks;
     VkDeviceGroupPresentModeFlagBitsKHR mode;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkDeviceGroupPresentInfoKHR.Buffer
An array of VkDeviceGroupPresentInfoKHR 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`	`VkDeviceGroupPresentInfoKHR.Buffer` An array of `VkDeviceGroupPresentInfoKHR` 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`	`PDEVICEMASKS` 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.
`static int`	`SWAPCHAINCOUNT` 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
`VkDeviceGroupPresentInfoKHR(java.nio.ByteBuffer container)` Creates a `VkDeviceGroupPresentInfoKHR` 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 VkDeviceGroupPresentInfoKHR`	`calloc()` Returns a new `VkDeviceGroupPresentInfoKHR` instance allocated with `memCalloc`.
`static VkDeviceGroupPresentInfoKHR.Buffer`	`calloc(int capacity)` Returns a new `VkDeviceGroupPresentInfoKHR.Buffer` instance allocated with `memCalloc`.
`static VkDeviceGroupPresentInfoKHR`	`callocStack()` Returns a new `VkDeviceGroupPresentInfoKHR` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDeviceGroupPresentInfoKHR.Buffer`	`callocStack(int capacity)` Returns a new `VkDeviceGroupPresentInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkDeviceGroupPresentInfoKHR.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDeviceGroupPresentInfoKHR.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDeviceGroupPresentInfoKHR`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDeviceGroupPresentInfoKHR` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkDeviceGroupPresentInfoKHR`	`create()` Returns a new `VkDeviceGroupPresentInfoKHR` instance allocated with `BufferUtils`.
`static VkDeviceGroupPresentInfoKHR.Buffer`	`create(int capacity)` Returns a new `VkDeviceGroupPresentInfoKHR.Buffer` instance allocated with `BufferUtils`.
`static VkDeviceGroupPresentInfoKHR`	`create(long address)` Returns a new `VkDeviceGroupPresentInfoKHR` instance for the specified memory address.
`static VkDeviceGroupPresentInfoKHR.Buffer`	`create(long address, int capacity)` Create a `VkDeviceGroupPresentInfoKHR.Buffer` instance at the specified memory.
`static VkDeviceGroupPresentInfoKHR`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDeviceGroupPresentInfoKHR.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkDeviceGroupPresentInfoKHR`	`malloc()` Returns a new `VkDeviceGroupPresentInfoKHR` instance allocated with `memAlloc`.
`static VkDeviceGroupPresentInfoKHR.Buffer`	`malloc(int capacity)` Returns a new `VkDeviceGroupPresentInfoKHR.Buffer` instance allocated with `memAlloc`.
`static VkDeviceGroupPresentInfoKHR`	`mallocStack()` Returns a new `VkDeviceGroupPresentInfoKHR` instance allocated on the thread-local `MemoryStack`.
`static VkDeviceGroupPresentInfoKHR.Buffer`	`mallocStack(int capacity)` Returns a new `VkDeviceGroupPresentInfoKHR.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkDeviceGroupPresentInfoKHR.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkDeviceGroupPresentInfoKHR.Buffer` instance allocated on the specified `MemoryStack`.
`static VkDeviceGroupPresentInfoKHR`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkDeviceGroupPresentInfoKHR` instance allocated on the specified `MemoryStack`.
`int`	`mode()` Returns the value of the `mode` field.
`VkDeviceGroupPresentInfoKHR`	`mode(int value)` Sets the specified value to the `mode` field.
`static int`	`nmode(long struct)` Unsafe version of `mode()`.
`static void`	`nmode(long struct, int value)` Unsafe version of `mode`.
`static java.nio.IntBuffer`	`npDeviceMasks(long struct)` Unsafe version of `pDeviceMasks`.
`static void`	`npDeviceMasks(long struct, java.nio.IntBuffer value)` Unsafe version of `pDeviceMasks`.
`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`.
`static int`	`nswapchainCount(long struct)` Unsafe version of `swapchainCount()`.
`static void`	`nswapchainCount(long struct, int value)` Sets the specified value to the `swapchainCount` field of the specified `struct`.
`java.nio.IntBuffer`	`pDeviceMasks()` Returns a `IntBuffer` view of the data pointed to by the `pDeviceMasks` field.
`VkDeviceGroupPresentInfoKHR`	`pDeviceMasks(java.nio.IntBuffer value)` Sets the address of the specified `IntBuffer` to the `pDeviceMasks` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkDeviceGroupPresentInfoKHR`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkDeviceGroupPresentInfoKHR`	`set(int sType, long pNext, java.nio.IntBuffer pDeviceMasks, int mode)` Initializes this struct with the specified values.
`VkDeviceGroupPresentInfoKHR`	`set(VkDeviceGroupPresentInfoKHR src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkDeviceGroupPresentInfoKHR`	`sType(int value)` Sets the specified value to the `sType` field.
`int`	`swapchainCount()` Returns the value of the `swapchainCount` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

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.
  - SWAPCHAINCOUNT
```
public static final int SWAPCHAINCOUNT
```
    The struct member offsets.
  - PDEVICEMASKS
```
public static final int PDEVICEMASKS
```
    The struct member offsets.
  - MODE
```
public static final int MODE
```
    The struct member offsets.
- Constructor Detail
  - VkDeviceGroupPresentInfoKHR
```
public VkDeviceGroupPresentInfoKHR(java.nio.ByteBuffer container)
```
    Creates a VkDeviceGroupPresentInfoKHR 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.
  - swapchainCount
```
public int swapchainCount()
```
    Returns the value of the swapchainCount field.
  - pDeviceMasks
```
@Nullable
public java.nio.IntBuffer pDeviceMasks()
```
    Returns a IntBuffer view of the data pointed to by the pDeviceMasks field.
  - mode
```
public int mode()
```
    Returns the value of the mode field.
  - sType
```
public VkDeviceGroupPresentInfoKHR sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkDeviceGroupPresentInfoKHR pNext(long value)
```
    Sets the specified value to the pNext field.
  - pDeviceMasks
```
public VkDeviceGroupPresentInfoKHR pDeviceMasks(@Nullable
                                                java.nio.IntBuffer value)
```
    Sets the address of the specified IntBuffer to the pDeviceMasks field.
  - mode
```
public VkDeviceGroupPresentInfoKHR mode(int value)
```
    Sets the specified value to the mode field.
  - set
```
public VkDeviceGroupPresentInfoKHR set(int sType,
                                       long pNext,
                                       @Nullable
                                       java.nio.IntBuffer pDeviceMasks,
                                       int mode)
```
    Initializes this struct with the specified values.
  - set
```
public VkDeviceGroupPresentInfoKHR set(VkDeviceGroupPresentInfoKHR src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkDeviceGroupPresentInfoKHR malloc()
```
    Returns a new VkDeviceGroupPresentInfoKHR instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkDeviceGroupPresentInfoKHR calloc()
```
    Returns a new VkDeviceGroupPresentInfoKHR instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkDeviceGroupPresentInfoKHR create()
```
    Returns a new VkDeviceGroupPresentInfoKHR instance allocated with BufferUtils.
  - create
```
public static VkDeviceGroupPresentInfoKHR create(long address)
```
    Returns a new VkDeviceGroupPresentInfoKHR instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkDeviceGroupPresentInfoKHR createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkDeviceGroupPresentInfoKHR.Buffer malloc(int capacity)
```
    Returns a new VkDeviceGroupPresentInfoKHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkDeviceGroupPresentInfoKHR.Buffer calloc(int capacity)
```
    Returns a new VkDeviceGroupPresentInfoKHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDeviceGroupPresentInfoKHR.Buffer create(int capacity)
```
    Returns a new VkDeviceGroupPresentInfoKHR.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkDeviceGroupPresentInfoKHR.Buffer create(long address,
                                                        int capacity)
```
    Create a VkDeviceGroupPresentInfoKHR.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkDeviceGroupPresentInfoKHR.Buffer createSafe(long address,
                                                                      int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkDeviceGroupPresentInfoKHR mallocStack()
```
    Returns a new VkDeviceGroupPresentInfoKHR instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkDeviceGroupPresentInfoKHR callocStack()
```
    Returns a new VkDeviceGroupPresentInfoKHR instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkDeviceGroupPresentInfoKHR mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDeviceGroupPresentInfoKHR instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkDeviceGroupPresentInfoKHR callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDeviceGroupPresentInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkDeviceGroupPresentInfoKHR.Buffer mallocStack(int capacity)
```
    Returns a new VkDeviceGroupPresentInfoKHR.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDeviceGroupPresentInfoKHR.Buffer callocStack(int capacity)
```
    Returns a new VkDeviceGroupPresentInfoKHR.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkDeviceGroupPresentInfoKHR.Buffer mallocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDeviceGroupPresentInfoKHR.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkDeviceGroupPresentInfoKHR.Buffer callocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkDeviceGroupPresentInfoKHR.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().
  - nswapchainCount
```
public static int nswapchainCount(long struct)
```
    Unsafe version of swapchainCount().
  - npDeviceMasks
```
@Nullable
public static java.nio.IntBuffer npDeviceMasks(long struct)
```
    Unsafe version of pDeviceMasks.
  - nmode
```
public static int nmode(long struct)
```
    Unsafe version of mode().
  - 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.
  - nswapchainCount
```
public static void nswapchainCount(long struct,
                                   int value)
```
    Sets the specified value to the swapchainCount field of the specified struct.
  - npDeviceMasks
```
public static void npDeviceMasks(long struct,
                                 @Nullable
                                 java.nio.IntBuffer value)
```
    Unsafe version of pDeviceMasks.
  - nmode
```
public static void nmode(long struct,
                         int value)
```
    Unsafe version of mode.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class VkDeviceGroupPresentInfoKHR

Description

Valid Usage

Valid Usage (Implicit)

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

SWAPCHAINCOUNT

PDEVICEMASKS

MODE

Constructor Detail

VkDeviceGroupPresentInfoKHR

Method Detail

sizeof

sType

pNext

swapchainCount

pDeviceMasks

mode

sType

pNext

pDeviceMasks

mode

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nswapchainCount

npDeviceMasks

nmode

nsType

npNext

nswapchainCount

npDeviceMasks

nmode

validate

validate