Package org.lwjgl.vulkan

Class VkRenderingInputAttachmentIndexInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkRenderingInputAttachmentIndexInfo>
org.lwjgl.vulkan.VkRenderingInputAttachmentIndexInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
Direct Known Subclasses:
VkRenderingInputAttachmentIndexInfoKHR
public class VkRenderingInputAttachmentIndexInfo extends org.lwjgl.system.Struct<VkRenderingInputAttachmentIndexInfo> implements org.lwjgl.system.NativeResource
Structure specifying input attachment indices.
Description

This structure allows applications to remap attachments to different input attachment indices.

Each element of pColorAttachmentInputIndices set to a value of ATTACHMENT_UNUSED indicates that the corresponding attachment will not be used as an input attachment in this pipeline. Any other value in each of those elements will map the corresponding attachment to a InputAttachmentIndex value defined in shader code.

If pColorAttachmentInputIndices is NULL, it is equivalent to setting each element to its index within the array.

If pDepthInputAttachmentIndex or pStencilInputAttachmentIndex are set to NULL, they map to input attachments without a InputAttachmentIndex decoration. If they point to a value of ATTACHMENT_UNUSED, it indicates that the corresponding attachment will not be used as an input attachment in this pipeline. If they point to any other value it maps the corresponding attachment to a InputAttachmentIndex value defined in shader code.

This structure can be included in the pNext chain of a VkGraphicsPipelineCreateInfo structure to set this state for a pipeline. If this structure is not included in the pNext chain of VkGraphicsPipelineCreateInfo, it is equivalent to specifying this structure with the following properties:

  • colorAttachmentCount set to VkPipelineRenderingCreateInfo::colorAttachmentCount.
  • pColorAttachmentInputIndices set to NULL.
  • pDepthInputAttachmentIndex set to NULL.
  • pStencilInputAttachmentIndex set to NULL.

This structure can be included in the pNext chain of a VkCommandBufferInheritanceInfo structure to specify inherited state from the primary command buffer. If this structure is not included in the pNext chain of VkCommandBufferInheritanceInfo, it is equivalent to specifying this structure with the following properties:

  • colorAttachmentCount set to VkCommandBufferInheritanceRenderingInfo::colorAttachmentCount.
  • pColorAttachmentInputIndices set to NULL.
  • pDepthInputAttachmentIndex set to NULL.
  • pStencilInputAttachmentIndex set to NULL.
Valid Usage
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_RENDERING_INPUT_ATTACHMENT_INDEX_INFO
  • If colorAttachmentCount is not 0, and pColorAttachmentInputIndices is not NULL, pColorAttachmentInputIndices must be a valid pointer to an array of colorAttachmentCount uint32_t values
  • If pDepthInputAttachmentIndex is not NULL, pDepthInputAttachmentIndex must be a valid pointer to a valid uint32_t value
  • If pStencilInputAttachmentIndex is not NULL, pStencilInputAttachmentIndex must be a valid pointer to a valid uint32_t value
See Also

CmdSetRenderingInputAttachmentIndices, CmdSetRenderingInputAttachmentIndicesKHR

Layout


 struct VkRenderingInputAttachmentIndexInfo {
     VkStructureType sType();
     void const * pNext();
     uint32_t colorAttachmentCount();
     uint32_t const * pColorAttachmentInputIndices();
     uint32_t const * pDepthInputAttachmentIndex(int);
     uint32_t const * pStencilInputAttachmentIndex(int);
 }

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

    • COLORATTACHMENTCOUNT

      public static final int COLORATTACHMENTCOUNT
      The struct member offsets.

    • PCOLORATTACHMENTINPUTINDICES

      public static final int PCOLORATTACHMENTINPUTINDICES
      The struct member offsets.

    • PDEPTHINPUTATTACHMENTINDEX

      public static final int PDEPTHINPUTATTACHMENTINDEX
      The struct member offsets.

    • PSTENCILINPUTATTACHMENTINDEX

      public static final int PSTENCILINPUTATTACHMENTINDEX
      The struct member offsets.

  • Constructor Details

    • VkRenderingInputAttachmentIndexInfo

      public VkRenderingInputAttachmentIndexInfo(ByteBuffer container)
      Creates a VkRenderingInputAttachmentIndexInfo 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