Package org.lwjgl.vulkan

Class VkDeviceGroupPresentInfoKHR

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkDeviceGroupPresentInfoKHR>
org.lwjgl.vulkan.VkDeviceGroupPresentInfoKHR
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkDeviceGroupPresentInfoKHR extends org.lwjgl.system.Struct<VkDeviceGroupPresentInfoKHR> 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
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

Layout


 struct VkDeviceGroupPresentInfoKHR {
     VkStructureType sType();
     void const * pNext();
     uint32_t swapchainCount();
     uint32_t const * pDeviceMasks();
     VkDeviceGroupPresentModeFlagBitsKHR mode();
 }

  • Field Details

    • 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 Details

    • VkDeviceGroupPresentInfoKHR

      public VkDeviceGroupPresentInfoKHR(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 Details