LWJGL 3.3.3 · org.lwjgl.vulkan.VkSubpassDescription2

Structure specifying a subpass description.

Description

Parameters defined by this structure with the same name as those in VkSubpassDescription have the identical effect to those parameters.

viewMask has the same effect for the described subpass as VkRenderPassMultiviewCreateInfo::pViewMasks has on each corresponding subpass.

If a VkFragmentShadingRateAttachmentInfoKHR structure is included in the pNext chain, pFragmentShadingRateAttachment is not NULL, and its attachment member is not ATTACHMENT_UNUSED, the identified attachment defines a fragment shading rate attachment for that subpass.

Valid Usage

If the attachment member of an element of pInputAttachments is not ATTACHMENT_UNUSED, its layout member must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL
If the attachment member of an element of pColorAttachments is not ATTACHMENT_UNUSED, its layout member must not be IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
If the attachment member of an element of pResolveAttachments is not ATTACHMENT_UNUSED, its layout member must not be IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
If the attachment member of pDepthStencilAttachment is not ATTACHMENT_UNUSED, ts layout member must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
If the attachment member of an element of pColorAttachments is not ATTACHMENT_UNUSED, its layout member must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
If the attachment member of an element of pResolveAttachments is not ATTACHMENT_UNUSED, its layout member must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
If the attachment member of an element of pInputAttachments is not ATTACHMENT_UNUSED, its layout member must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL
If the attachment member of an element of pColorAttachments is not ATTACHMENT_UNUSED, its layout member must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If the attachment member of an element of pResolveAttachments is not ATTACHMENT_UNUSED, its layout member must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
If the attachment member of an element of pInputAttachments is not ATTACHMENT_UNUSED, its layout member must not be IMAGE_LAYOUT_ATTACHMENT_OPTIMAL_KHR
If the attachment member of an element of pColorAttachments is not ATTACHMENT_UNUSED, its layout member must not be IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR
If the attachment member of an element of pResolveAttachments is not ATTACHMENT_UNUSED, its layout member must not be IMAGE_LAYOUT_READ_ONLY_OPTIMAL_KHR
If the attachment member of pDepthStencilAttachment is not ATTACHMENT_UNUSED and its pNext chain includes a VkAttachmentReferenceStencilLayout structure, the layout member of pDepthStencilAttachment must not be IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
pipelineBindPoint must be PIPELINE_BIND_POINT_GRAPHICS or PIPELINE_BIND_POINT_SUBPASS_SHADING_HUAWEI
colorAttachmentCount must be less than or equal to VkPhysicalDeviceLimits::maxColorAttachments
If the first use of an attachment in this render pass is as an input attachment, and the attachment is not also used as a color or depth/stencil attachment in the same subpass, then loadOp must not be ATTACHMENT_LOAD_OP_CLEAR
If pResolveAttachments is not NULL, for each resolve attachment that does not have the value ATTACHMENT_UNUSED, the corresponding color attachment must not have the value ATTACHMENT_UNUSED
If pResolveAttachments is not NULL, for each resolve attachment that is not ATTACHMENT_UNUSED, the corresponding color attachment must not have a sample count of SAMPLE_COUNT_1_BIT
If pResolveAttachments is not NULL, each resolve attachment that is not ATTACHMENT_UNUSED must have a sample count of SAMPLE_COUNT_1_BIT
Each element of pResolveAttachments must have the same VkFormat as its corresponding color attachment
If none of the VK_AMD_mixed_attachment_samples extension, the VK_NV_framebuffer_mixed_samples extension, or the multisampledRenderToSingleSampled feature are enabled, all attachments in pColorAttachments that are not ATTACHMENT_UNUSED must have the same sample count
All attachments in pInputAttachments that are not ATTACHMENT_UNUSED must have image formats whose potential format features contain at least FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
All attachments in pColorAttachments that are not ATTACHMENT_UNUSED must have image formats whose potential format features contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
All attachments in pResolveAttachments that are not ATTACHMENT_UNUSED must have image formats whose potential format features contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
If pDepthStencilAttachment is not NULL and the attachment is not ATTACHMENT_UNUSED then it must have an image format whose potential format features contain FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
If the linearColorAttachment feature is enabled and the image is created with IMAGE_TILING_LINEAR, all attachments in pInputAttachments that are not ATTACHMENT_UNUSED must have image formats whose potential format features must contain FORMAT_FEATURE_2_LINEAR_COLOR_ATTACHMENT_BIT_NV
If the linearColorAttachment feature is enabled and the image is created with IMAGE_TILING_LINEAR, all attachments in pColorAttachments that are not ATTACHMENT_UNUSED must have image formats whose potential format features must contain FORMAT_FEATURE_2_LINEAR_COLOR_ATTACHMENT_BIT_NV
If the linearColorAttachment feature is enabled and the image is created with IMAGE_TILING_LINEAR, all attachments in pResolveAttachments that are not ATTACHMENT_UNUSED must have image formats whose potential format features must contain FORMAT_FEATURE_2_LINEAR_COLOR_ATTACHMENT_BIT_NV
If the VK_AMD_mixed_attachment_samples extension is enabled, all attachments in pColorAttachments that are not ATTACHMENT_UNUSED must have a sample count that is smaller than or equal to the sample count of pDepthStencilAttachment if it is not ATTACHMENT_UNUSED
If the pNext chain includes a VkMultisampledRenderToSingleSampledInfoEXT structure with multisampledRenderToSingleSampledEnable equal to TRUE, then all attachments in pColorAttachments and pDepthStencilAttachment that are not ATTACHMENT_UNUSED must have a sample count that is either SAMPLE_COUNT_1_BIT or equal to VkMultisampledRenderToSingleSampledInfoEXT::rasterizationSamples
If the pNext chain includes a VkMultisampledRenderToSingleSampledInfoEXT structure with multisampledRenderToSingleSampledEnable equal to TRUE, and pDepthStencilAttachment is not NULL, does not have the value ATTACHMENT_UNUSED, and has a sample count of SAMPLE_COUNT_1_BIT, the pNext chain must also include a VkSubpassDescriptionDepthStencilResolve structure with pDepthStencilResolveAttachment that is either NULL or has the value ATTACHMENT_UNUSED
If none of the VK_AMD_mixed_attachment_samples extension, the VK_NV_framebuffer_mixed_samples extension, or the multisampledRenderToSingleSampled feature are enabled, all attachments in pDepthStencilAttachment or pColorAttachments that are not ATTACHMENT_UNUSED must have the same sample count
Each element of pPreserveAttachments must not be ATTACHMENT_UNUSED
Each element of pPreserveAttachments must not also be an element of any other member of the subpass description
If any attachment is used by more than one VkAttachmentReference2 member, then each use must use the same layout
If flags includes SUBPASS_DESCRIPTION_PER_VIEW_POSITION_X_ONLY_BIT_NVX, it must also include SUBPASS_DESCRIPTION_PER_VIEW_ATTRIBUTES_BIT_NVX
If the attachment member of any element of pInputAttachments is not ATTACHMENT_UNUSED, then the aspectMask member must be a valid combination of VkImageAspectFlagBits
If the attachment member of any element of pInputAttachments is not ATTACHMENT_UNUSED, then the aspectMask member must not be 0
If the attachment member of any element of pInputAttachments is not ATTACHMENT_UNUSED, then the aspectMask member must not include IMAGE_ASPECT_METADATA_BIT
If the attachment member of any element of pInputAttachments is not ATTACHMENT_UNUSED, then the aspectMask member must not include VK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT for any index i
An attachment must not be used in both pDepthStencilAttachment and pColorAttachments
If the multiview feature is not enabled, viewMask must be 0
The index of the most significant bit in viewMask must be less than maxMultiviewViewCount

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_SUBPASS_DESCRIPTION_2
Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkFragmentShadingRateAttachmentInfoKHR, VkMultisampledRenderToSingleSampledInfoEXT, VkRenderPassCreationControlEXT, VkRenderPassSubpassFeedbackCreateInfoEXT, or VkSubpassDescriptionDepthStencilResolve
The sType value of each struct in the pNext chain must be unique
flags must be a valid combination of VkSubpassDescriptionFlagBits values
pipelineBindPoint must be a valid VkPipelineBindPoint value
If inputAttachmentCount is not 0, pInputAttachments must be a valid pointer to an array of inputAttachmentCount valid VkAttachmentReference2 structures
If colorAttachmentCount is not 0, pColorAttachments must be a valid pointer to an array of colorAttachmentCount valid VkAttachmentReference2 structures
If colorAttachmentCount is not 0, and pResolveAttachments is not NULL, pResolveAttachments must be a valid pointer to an array of colorAttachmentCount valid VkAttachmentReference2 structures
If pDepthStencilAttachment is not NULL, pDepthStencilAttachment must be a valid pointer to a valid VkAttachmentReference2 structure
If preserveAttachmentCount is not 0, pPreserveAttachments must be a valid pointer to an array of preserveAttachmentCount uint32_t values

Layout


struct VkSubpassDescription2 {
    VkStructureType sType;
    void const * pNext;
    VkSubpassDescriptionFlags flags;
    VkPipelineBindPoint pipelineBindPoint;
    uint32_t viewMask;
    uint32_t inputAttachmentCount;
    VkAttachmentReference2 const * pInputAttachments;
    uint32_t colorAttachmentCount;
    VkAttachmentReference2 const * pColorAttachments;
    VkAttachmentReference2 const * pResolveAttachments;
    VkAttachmentReference2 const * pDepthStencilAttachment;
    uint32_t preserveAttachmentCount;
    uint32_t const * pPreserveAttachments;
}

Modifier and Type	Class and Description
public static class	VkSubpassDescription2.Buffer An array of `VkSubpassDescription2` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	COLORATTACHMENTCOUNT The struct member offsets.
public static final int	FLAGS The struct member offsets.
public static final int	INPUTATTACHMENTCOUNT The struct member offsets.
public static final int	PCOLORATTACHMENTS The struct member offsets.
public static final int	PDEPTHSTENCILATTACHMENT The struct member offsets.
public static final int	PINPUTATTACHMENTS The struct member offsets.
public static final int	PIPELINEBINDPOINT The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	PPRESERVEATTACHMENTS The struct member offsets.
public static final int	PRESERVEATTACHMENTCOUNT The struct member offsets.
public static final int	PRESOLVEATTACHMENTS The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.
public static final int	VIEWMASK The struct member offsets.

Access	Constructor and Description
protected	VkSubpassDescription2(long address, ByteBuffer container)
public	VkSubpassDescription2(ByteBuffer container) Creates a `VkSubpassDescription2` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkSubpassDescription2	calloc() Returns a new `VkSubpassDescription2` instance allocated with `memCalloc`.
public static VkSubpassDescription2.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkSubpassDescription2.Buffer` instance allocated with `memCalloc`.
public static VkSubpassDescription2	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSubpassDescription2` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSubpassDescription2.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSubpassDescription2.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public int	colorAttachmentCount() the number of color attachments.
public VkSubpassDescription2	colorAttachmentCount(int value) Sets the specified value to the `colorAttachmentCount` field.
protected VkSubpassDescription2	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkSubpassDescription2	create() Returns a new `VkSubpassDescription2` instance allocated with `BufferUtils`.
public static VkSubpassDescription2	create(long address) Returns a new `VkSubpassDescription2` instance for the specified memory address.
public static VkSubpassDescription2.Buffer	create(int the buffer capacity capacity) Returns a new `VkSubpassDescription2.Buffer` instance allocated with `BufferUtils`.
public static VkSubpassDescription2.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkSubpassDescription2.Buffer` instance at the specified memory.
public static VkSubpassDescription2	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkSubpassDescription2.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	flags() a bitmask of `VkSubpassDescriptionFlagBits` specifying usage of the subpass.
public VkSubpassDescription2	flags(int value) Sets the specified value to the `flags` field.
public int	inputAttachmentCount() the number of input attachments.
public static VkSubpassDescription2	malloc() Returns a new `VkSubpassDescription2` instance allocated with `memAlloc`.
public static VkSubpassDescription2.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkSubpassDescription2.Buffer` instance allocated with `memAlloc`.
public static VkSubpassDescription2	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSubpassDescription2` instance allocated on the specified `MemoryStack`.
public static VkSubpassDescription2.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSubpassDescription2.Buffer` instance allocated on the specified `MemoryStack`.
public static int	ncolorAttachmentCount(long struct) Unsafe version of `colorAttachmentCount`.
public static void	ncolorAttachmentCount(long struct, int value) Sets the specified value to the `colorAttachmentCount` field of the specified `struct`.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static int	ninputAttachmentCount(long struct) Unsafe version of `inputAttachmentCount`.
public static void	ninputAttachmentCount(long struct, int value) Sets the specified value to the `inputAttachmentCount` field of the specified `struct`.
public static VkAttachmentReference2.Buffer	npColorAttachments(long struct) Unsafe version of `pColorAttachments`.
public static void	npColorAttachments(long struct, VkAttachmentReference2.Buffer value) Unsafe version of `pColorAttachments`.
public static VkAttachmentReference2	npDepthStencilAttachment(long struct) Unsafe version of `pDepthStencilAttachment`.
public static void	npDepthStencilAttachment(long struct, VkAttachmentReference2 value) Unsafe version of `pDepthStencilAttachment`.
public static VkAttachmentReference2.Buffer	npInputAttachments(long struct) Unsafe version of `pInputAttachments`.
public static void	npInputAttachments(long struct, VkAttachmentReference2.Buffer value) Unsafe version of `pInputAttachments`.
public static int	npipelineBindPoint(long struct) Unsafe version of `pipelineBindPoint`.
public static void	npipelineBindPoint(long struct, int value) Unsafe version of `pipelineBindPoint`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static IntBuffer	npPreserveAttachments(long struct) Unsafe version of `pPreserveAttachments`.
public static void	npPreserveAttachments(long struct, IntBuffer value) Unsafe version of `pPreserveAttachments`.
public static int	npreserveAttachmentCount(long struct) Unsafe version of `preserveAttachmentCount`.
public static void	npreserveAttachmentCount(long struct, int value) Sets the specified value to the `preserveAttachmentCount` field of the specified `struct`.
public static VkAttachmentReference2.Buffer	npResolveAttachments(long struct) Unsafe version of `pResolveAttachments`.
public static void	npResolveAttachments(long struct, VkAttachmentReference2.Buffer value) Unsafe version of `pResolveAttachments`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public static int	nviewMask(long struct) Unsafe version of `viewMask`.
public static void	nviewMask(long struct, int value) Unsafe version of `viewMask`.
public VkAttachmentReference2.Buffer	pColorAttachments() a pointer to an array of `colorAttachmentCount` `VkAttachmentReference2` structures defining the color attachments for this subpass and their layouts.
public VkSubpassDescription2	pColorAttachments(VkAttachmentReference2.Buffer value) Sets the address of the specified `VkAttachmentReference2.Buffer` to the `pColorAttachments` field.
public VkAttachmentReference2	pDepthStencilAttachment() a pointer to a `VkAttachmentReference2` structure specifying the depth/stencil attachment for this subpass and its layout.
public VkSubpassDescription2	pDepthStencilAttachment(VkAttachmentReference2 value) Sets the address of the specified `VkAttachmentReference2` to the `pDepthStencilAttachment` field.
public VkAttachmentReference2.Buffer	pInputAttachments() a pointer to an array of `VkAttachmentReference2` structures defining the input attachments for this subpass and their layouts.
public VkSubpassDescription2	pInputAttachments(VkAttachmentReference2.Buffer value) Sets the address of the specified `VkAttachmentReference2.Buffer` to the `pInputAttachments` field.
public int	pipelineBindPoint() a `VkPipelineBindPoint` value specifying the pipeline type supported for this subpass.
public VkSubpassDescription2	pipelineBindPoint(int value) Sets the specified value to the `pipelineBindPoint` field.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkSubpassDescription2	pNext(long value) Sets the specified value to the `pNext` field.
public VkSubpassDescription2	pNext(VkFragmentShadingRateAttachmentInfoKHR value) Prepends the specified `VkFragmentShadingRateAttachmentInfoKHR` value to the `pNext` chain.
public VkSubpassDescription2	pNext(VkMultisampledRenderToSingleSampledInfoEXT value) Prepends the specified `VkMultisampledRenderToSingleSampledInfoEXT` value to the `pNext` chain.
public VkSubpassDescription2	pNext(VkRenderPassCreationControlEXT value) Prepends the specified `VkRenderPassCreationControlEXT` value to the `pNext` chain.
public VkSubpassDescription2	pNext(VkRenderPassSubpassFeedbackCreateInfoEXT value) Prepends the specified `VkRenderPassSubpassFeedbackCreateInfoEXT` value to the `pNext` chain.
public VkSubpassDescription2	pNext(VkSubpassDescriptionDepthStencilResolve value) Prepends the specified `VkSubpassDescriptionDepthStencilResolve` value to the `pNext` chain.
public VkSubpassDescription2	pNext(VkSubpassDescriptionDepthStencilResolveKHR value) Prepends the specified `VkSubpassDescriptionDepthStencilResolveKHR` value to the `pNext` chain.
public IntBuffer	pPreserveAttachments() a pointer to an array of `preserveAttachmentCount` render pass attachment indices identifying attachments that are not used by this subpass, but whose contents must be preserved throughout the subpass.
public VkSubpassDescription2	pPreserveAttachments(IntBuffer value) Sets the address of the specified `IntBuffer` to the `pPreserveAttachments` field.
public int	preserveAttachmentCount() the number of preserved attachments.
public VkAttachmentReference2.Buffer	pResolveAttachments() `NULL` or a pointer to an array of `colorAttachmentCount` `VkAttachmentReference2` structures defining the resolve attachments for this subpass and their layouts.
public VkSubpassDescription2	pResolveAttachments(VkAttachmentReference2.Buffer value) Sets the address of the specified `VkAttachmentReference2.Buffer` to the `pResolveAttachments` field.
public VkSubpassDescription2	set(int sType, long pNext, int flags, int pipelineBindPoint, int viewMask, VkAttachmentReference2.Buffer pInputAttachments, int colorAttachmentCount, VkAttachmentReference2.Buffer pColorAttachments, VkAttachmentReference2.Buffer pResolveAttachments, VkAttachmentReference2 pDepthStencilAttachment, IntBuffer pPreserveAttachments) Initializes this struct with the specified values.
public VkSubpassDescription2	Returns: this struct set(VkSubpassDescription2 the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	sType() a `VkStructureType` value identifying this structure.
public VkSubpassDescription2	sType(int value) Sets the specified value to the `sType` field.
public VkSubpassDescription2	sType$Default() Sets the `STRUCTURE_TYPE_SUBPASS_DESCRIPTION_2` value to the `sType` field.
public static void	validate(long the struct to validate struct) Validates pointer members that should not be `NULL`.
public int	viewMask() a bitfield of view indices describing which views rendering is broadcast to in this subpass, when multiview is enabled.
public VkSubpassDescription2	viewMask(int value) Sets the specified value to the `viewMask` field.

public Class VkSubpassDescription2

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary