Class VkRenderPassMultiviewCreateInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer
    Direct Known Subclasses:
    VkRenderPassMultiviewCreateInfoKHR

    public class VkRenderPassMultiviewCreateInfo
    extends Struct
    implements NativeResource
    Structure containing multiview info for all subpasses.
    Description

    When a subpass uses a non-zero view mask, multiview functionality is considered to be enabled. Multiview is all-or-nothing for a render pass - that is, either all subpasses must have a non-zero view mask (though some subpasses may have only one view) or all must be zero. Multiview causes all drawing and clear commands in the subpass to behave as if they were broadcast to each view, where a view is represented by one layer of the framebuffer attachments. All draws and clears are broadcast to each view index whose bit is set in the view mask. The view index is provided in the ViewIndex shader input variable, and color, depth/stencil, and input attachments all read/write the layer of the framebuffer corresponding to the view index.

    If the view mask is zero for all subpasses, multiview is considered to be disabled and all drawing commands execute normally, without this additional broadcasting.

    Some implementations may not support multiview in conjunction with geometry shaders or tessellation shaders.

    When multiview is enabled, the DEPENDENCY_VIEW_LOCAL_BIT bit in a dependency can be used to express a view-local dependency, meaning that each view in the destination subpass depends on a single view in the source subpass. Unlike pipeline barriers, a subpass dependency can potentially have a different view mask in the source subpass and the destination subpass. If the dependency is view-local, then each view (dstView) in the destination subpass depends on the view dstView + pViewOffsets[dependency] in the source subpass. If there is not such a view in the source subpass, then this dependency does not affect that view in the destination subpass. If the dependency is not view-local, then all views in the destination subpass depend on all views in the source subpass, and the view offset is ignored. A non-zero view offset is not allowed in a self-dependency.

    The elements of pCorrelationMasks are a set of masks of views indicating that views in the same mask may exhibit spatial coherency between the views, making it more efficient to render them concurrently. Correlation masks must not have a functional effect on the results of the multiview rendering.

    When multiview is enabled, at the beginning of each subpass all non-render pass state is undefined. In particular, each time CmdBeginRenderPass or CmdNextSubpass is called the graphics pipeline must be bound, any relevant descriptor sets or vertex/index buffers must be bound, and any relevant dynamic state or push constants must be set before they are used.

    A multiview subpass can declare that its shaders will write per-view attributes for all views in a single invocation, by setting the SUBPASS_DESCRIPTION_PER_VIEW_ATTRIBUTES_BIT_NVX bit in the subpass description. The only supported per-view attributes are position and viewport mask, and per-view position and viewport masks are written to output array variables decorated with PositionPerViewNV and ViewportMaskPerViewNV, respectively. If VK_NV_viewport_array2 is not supported and enabled, ViewportMaskPerViewNV must not be used. Values written to elements of PositionPerViewNV and ViewportMaskPerViewNV must not depend on the ViewIndex. The shader must also write to an output variable decorated with Position, and the value written to Position must equal the value written to PositionPerViewNV[ViewIndex]. Similarly, if ViewportMaskPerViewNV is written to then the shader must also write to an output variable decorated with ViewportMaskNV, and the value written to ViewportMaskNV must equal the value written to ViewportMaskPerViewNV[ViewIndex]. Implementations will either use values taken from Position and ViewportMaskNV and invoke the shader once for each view, or will use values taken from PositionPerViewNV and ViewportMaskPerViewNV and invoke the shader fewer times. The values written to Position and ViewportMaskNV must not depend on the values written to PositionPerViewNV and ViewportMaskPerViewNV, or vice versa (to allow compilers to eliminate the unused outputs). All attributes that do not have *PerViewNV counterparts must not depend on ViewIndex.

    Per-view attributes are all-or-nothing for a subpass. That is, all pipelines compiled against a subpass that includes the SUBPASS_DESCRIPTION_PER_VIEW_ATTRIBUTES_BIT_NVX bit must write per-view attributes to the *PerViewNV[] shader outputs, in addition to the non-per-view (e.g. Position) outputs. Pipelines compiled against a subpass that does not include this bit must not include the *PerViewNV[] outputs in their interfaces.

    Valid Usage
    • Each view index must not be set in more than one element of pCorrelationMasks
    Valid Usage (Implicit)
    • sType must be STRUCTURE_TYPE_RENDER_PASS_MULTIVIEW_CREATE_INFO
    • If subpassCount is not 0, pViewMasks must be a valid pointer to an array of subpassCount uint32_t values
    • If dependencyCount is not 0, pViewOffsets must be a valid pointer to an array of dependencyCount int32_t values
    • If correlationMaskCount is not 0, pCorrelationMasks must be a valid pointer to an array of correlationMaskCount uint32_t values

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • subpassCount – zero or is the number of subpasses in the render pass.
    • pViewMasks – points to an array of subpassCount number of view masks, where each mask is a bitfield of view indices describing which views rendering is broadcast to in each subpass, when multiview is enabled. If subpassCount is zero, each view mask is treated as zero.
    • dependencyCount – zero or the number of dependencies in the render pass.
    • pViewOffsets – points to an array of dependencyCount view offsets, one for each dependency. If dependencyCount is zero, each dependency’s view offset is treated as zero. Each view offset controls which views in the source subpass the views in the destination subpass depend on.
    • correlationMaskCount – zero or a number of correlation masks.
    • pCorrelationMasks – an array of view masks indicating sets of views that may be more efficient to render concurrently.

    Layout

    
     struct VkRenderPassMultiviewCreateInfo {
         VkStructureType sType;
         void const * pNext;
         uint32_t subpassCount;
         uint32_t const * pViewMasks;
         uint32_t dependencyCount;
         int32_t const * pViewOffsets;
         uint32_t correlationMaskCount;
         uint32_t const * pCorrelationMasks;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • STYPE, PNEXT, SUBPASSCOUNT, PVIEWMASKS, DEPENDENCYCOUNT, PVIEWOFFSETS, CORRELATIONMASKCOUNT, PCORRELATIONMASKS

        The struct member offsets.
    • Constructor Detail

      • VkRenderPassMultiviewCreateInfo

        public VkRenderPassMultiviewCreateInfo​(java.nio.ByteBuffer container)
        Creates a VkRenderPassMultiviewCreateInfo 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct
      • sType

        public int sType()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • subpassCount

        public int subpassCount()
        Returns the value of the subpassCount field.
      • pViewMasks

        @Nullable
        public java.nio.IntBuffer pViewMasks()
        Returns a IntBuffer view of the data pointed to by the pViewMasks field.
      • dependencyCount

        public int dependencyCount()
        Returns the value of the dependencyCount field.
      • pViewOffsets

        @Nullable
        public java.nio.IntBuffer pViewOffsets()
        Returns a IntBuffer view of the data pointed to by the pViewOffsets field.
      • correlationMaskCount

        public int correlationMaskCount()
        Returns the value of the correlationMaskCount field.
      • pCorrelationMasks

        @Nullable
        public java.nio.IntBuffer pCorrelationMasks()
        Returns a IntBuffer view of the data pointed to by the pCorrelationMasks field.
      • pViewMasks

        public VkRenderPassMultiviewCreateInfo pViewMasks​(@Nullable
                                                          java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the pViewMasks field.
      • pViewOffsets

        public VkRenderPassMultiviewCreateInfo pViewOffsets​(@Nullable
                                                            java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the pViewOffsets field.
      • pCorrelationMasks

        public VkRenderPassMultiviewCreateInfo pCorrelationMasks​(@Nullable
                                                                 java.nio.IntBuffer value)
        Sets the address of the specified IntBuffer to the pCorrelationMasks field.
      • set

        public VkRenderPassMultiviewCreateInfo set​(int sType,
                                                   long pNext,
                                                   @Nullable
                                                   java.nio.IntBuffer pViewMasks,
                                                   @Nullable
                                                   java.nio.IntBuffer pViewOffsets,
                                                   @Nullable
                                                   java.nio.IntBuffer pCorrelationMasks)
        Initializes this struct with the specified values.
      • create

        public static VkRenderPassMultiviewCreateInfo create​(long address)
        Returns a new VkRenderPassMultiviewCreateInfo instance for the specified memory address.
      • callocStack

        public static VkRenderPassMultiviewCreateInfo callocStack()
        Returns a new VkRenderPassMultiviewCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • callocStack

        public static VkRenderPassMultiviewCreateInfo callocStack​(MemoryStack stack)
        Returns a new VkRenderPassMultiviewCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • nsType

        public static int nsType​(long struct)
        Unsafe version of sType().
      • npNext

        public static long npNext​(long struct)
        Unsafe version of pNext().
      • nsubpassCount

        public static int nsubpassCount​(long struct)
        Unsafe version of subpassCount().
      • npViewMasks

        @Nullable
        public static java.nio.IntBuffer npViewMasks​(long struct)
        Unsafe version of pViewMasks.
      • ndependencyCount

        public static int ndependencyCount​(long struct)
        Unsafe version of dependencyCount().
      • npViewOffsets

        @Nullable
        public static java.nio.IntBuffer npViewOffsets​(long struct)
        Unsafe version of pViewOffsets.
      • ncorrelationMaskCount

        public static int ncorrelationMaskCount​(long struct)
        Unsafe version of correlationMaskCount().
      • npCorrelationMasks

        @Nullable
        public static java.nio.IntBuffer npCorrelationMasks​(long struct)
        Unsafe version of pCorrelationMasks.
      • 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.
      • nsubpassCount

        public static void nsubpassCount​(long struct,
                                         int value)
        Sets the specified value to the subpassCount field of the specified struct.
      • npViewMasks

        public static void npViewMasks​(long struct,
                                       @Nullable
                                       java.nio.IntBuffer value)
        Unsafe version of pViewMasks.
      • ndependencyCount

        public static void ndependencyCount​(long struct,
                                            int value)
        Sets the specified value to the dependencyCount field of the specified struct.
      • npViewOffsets

        public static void npViewOffsets​(long struct,
                                         @Nullable
                                         java.nio.IntBuffer value)
        Unsafe version of pViewOffsets.
      • ncorrelationMaskCount

        public static void ncorrelationMaskCount​(long struct,
                                                 int value)
        Sets the specified value to the correlationMaskCount field of the specified struct.
      • npCorrelationMasks

        public static void npCorrelationMasks​(long struct,
                                              @Nullable
                                              java.nio.IntBuffer value)
        Unsafe version of pCorrelationMasks.
      • 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