Package org.lwjgl.vulkan

Class VkDeviceGroupRenderPassBeginInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
    Direct Known Subclasses:
    VkDeviceGroupRenderPassBeginInfoKHR
    public class VkDeviceGroupRenderPassBeginInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
    Set the initial device mask and render areas for a render pass instance.
    Description

    The deviceMask serves several purposes. It is an upper bound on the set of physical devices that can be used during the render pass instance, and the initial device mask when the render pass instance begins. In addition, commands transitioning to the next subpass in the render pass instance and commands ending the render pass instance, and, accordingly render pass attachment load, store, and resolve operations and subpass dependencies corresponding to the render pass instance, are executed on the physical devices included in the device mask provided here.

    If deviceRenderAreaCount is not zero, then the elements of pDeviceRenderAreas override the value of VkRenderPassBeginInfo::renderArea, and provide a render area specific to each physical device. These render areas serve the same purpose as VkRenderPassBeginInfo::renderArea, including controlling the region of attachments that are cleared by ATTACHMENT_LOAD_OP_CLEAR and that are resolved into resolve attachments.

    If this structure is not present, the render pass instance's device mask is the value of VkDeviceGroupCommandBufferBeginInfo::deviceMask. If this structure is not present or if deviceRenderAreaCount is zero, VkRenderPassBeginInfo::renderArea is used for all physical devices.

    Valid Usage
    • deviceMask must be a valid device mask value
    • deviceMask must not be zero
    • deviceMask must be a subset of the command buffer’s initial device mask
    • deviceRenderAreaCount must either be zero or equal to the number of physical devices in the logical device.
    Valid Usage (Implicit)
    See Also

    VkRect2D

    Member documentation

    • sType – the type of this structure.
    • pNext – NULL or a pointer to an extension-specific structure.
    • deviceMask – the device mask for the render pass instance.
    • deviceRenderAreaCount – the number of elements in the pDeviceRenderAreas array.
    • pDeviceRenderAreas – an array of structures of type VkRect2D defining the render area for each physical device.

    Layout

    
 struct VkDeviceGroupRenderPassBeginInfo {
     VkStructureType sType;
     void const * pNext;
     uint32_t deviceMask;
     uint32_t deviceRenderAreaCount;
     VkRect2D const * pDeviceRenderAreas;
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • STYPE, PNEXT, DEVICEMASK, DEVICERENDERAREACOUNT, PDEVICERENDERAREAS

        The struct member offsets.

    • Constructor Detail

      • VkDeviceGroupRenderPassBeginInfo

        public VkDeviceGroupRenderPassBeginInfo​(java.nio.ByteBuffer container)
        Creates a VkDeviceGroupRenderPassBeginInfo 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.