LWJGL 3.3.3 · org.lwjgl.vulkan.VkSubpassDependency

Structure specifying a subpass dependency.

Description

If srcSubpass is equal to dstSubpass then the VkSubpassDependency does not directly define a dependency. Instead, it enables pipeline barriers to be used in a render pass instance within the identified subpass, where the scopes of one pipeline barrier must be a subset of those described by one subpass dependency. Subpass dependencies specified in this way that include framebuffer-space stages in the srcStageMask must only include framebuffer-space stages in dstStageMask, and must include DEPENDENCY_BY_REGION_BIT. When a subpass dependency is specified in this way for a subpass that has more than one view in its view mask, its dependencyFlags must include DEPENDENCY_VIEW_LOCAL_BIT.

If srcSubpass and dstSubpass are not equal, when a render pass instance which includes a subpass dependency is submitted to a queue, it defines a dependency between the subpasses identified by srcSubpass and dstSubpass.

If srcSubpass is equal to SUBPASS_EXTERNAL, the first synchronization scope includes commands that occur earlier in submission order than the CmdBeginRenderPass used to begin the render pass instance. Otherwise, the first set of commands includes all commands submitted as part of the subpass instance identified by srcSubpass and any load, store, or multisample resolve operations on attachments used in srcSubpass. In either case, the first synchronization scope is limited to operations on the pipeline stages determined by the source stage mask specified by srcStageMask.

If dstSubpass is equal to SUBPASS_EXTERNAL, the second synchronization scope includes commands that occur later in submission order than the CmdEndRenderPass used to end the render pass instance. Otherwise, the second set of commands includes all commands submitted as part of the subpass instance identified by dstSubpass and any load, store, and multisample resolve operations on attachments used in dstSubpass. In either case, the second synchronization scope is limited to operations on the pipeline stages determined by the destination stage mask specified by dstStageMask.

The first access scope is limited to accesses in the pipeline stages determined by the source stage mask specified by srcStageMask. It is also limited to access types in the source access mask specified by srcAccessMask.

The second access scope is limited to accesses in the pipeline stages determined by the destination stage mask specified by dstStageMask. It is also limited to access types in the destination access mask specified by dstAccessMask.

The availability and visibility operations defined by a subpass dependency affect the execution of image layout transitions within the render pass.

Note

For non-attachment resources, the memory dependency expressed by subpass dependency is nearly identical to that of a VkMemoryBarrier (with matching srcAccessMask and dstAccessMask parameters) submitted as a part of a CmdPipelineBarrier (with matching srcStageMask and dstStageMask parameters). The only difference being that its scopes are limited to the identified subpasses rather than potentially affecting everything before and after.

For attachments however, subpass dependencies work more like a VkImageMemoryBarrier defined similarly to the VkMemoryBarrier above, the queue family indices set to QUEUE_FAMILY_IGNORED, and layouts as follows:

The equivalent to oldLayout is the attachment’s layout according to the subpass description for srcSubpass.
The equivalent to newLayout is the attachment’s layout according to the subpass description for dstSubpass.

Valid Usage

If the geometryShader feature is not enabled, srcStageMask must not contain PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellationShader feature is not enabled, srcStageMask must not contain PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If the conditionalRendering feature is not enabled, srcStageMask must not contain PIPELINE_STAGE_CONDITIONAL_RENDERING_BIT_EXT
If the fragmentDensityMap feature is not enabled, srcStageMask must not contain PIPELINE_STAGE_FRAGMENT_DENSITY_PROCESS_BIT_EXT
If the transformFeedback feature is not enabled, srcStageMask must not contain PIPELINE_STAGE_TRANSFORM_FEEDBACK_BIT_EXT
If the meshShader feature is not enabled, srcStageMask must not contain PIPELINE_STAGE_MESH_SHADER_BIT_EXT
If the taskShader feature is not enabled, srcStageMask must not contain PIPELINE_STAGE_TASK_SHADER_BIT_EXT
If neither the shadingRateImage or attachmentFragmentShadingRate are enabled, srcStageMask must not contain PIPELINE_STAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR
If the synchronization2 feature is not enabled, srcStageMask must not be 0
If neither the VK_NV_ray_tracing extension or rayTracingPipeline feature are enabled, srcStageMask must not contain PIPELINE_STAGE_RAY_TRACING_SHADER_BIT_KHR

If the geometryShader feature is not enabled, dstStageMask must not contain PIPELINE_STAGE_GEOMETRY_SHADER_BIT
If the tessellationShader feature is not enabled, dstStageMask must not contain PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
If the conditionalRendering feature is not enabled, dstStageMask must not contain PIPELINE_STAGE_CONDITIONAL_RENDERING_BIT_EXT
If the fragmentDensityMap feature is not enabled, dstStageMask must not contain PIPELINE_STAGE_FRAGMENT_DENSITY_PROCESS_BIT_EXT
If the transformFeedback feature is not enabled, dstStageMask must not contain PIPELINE_STAGE_TRANSFORM_FEEDBACK_BIT_EXT
If the meshShader feature is not enabled, dstStageMask must not contain PIPELINE_STAGE_MESH_SHADER_BIT_EXT
If the taskShader feature is not enabled, dstStageMask must not contain PIPELINE_STAGE_TASK_SHADER_BIT_EXT
If neither the shadingRateImage or attachmentFragmentShadingRate are enabled, dstStageMask must not contain PIPELINE_STAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR
If the synchronization2 feature is not enabled, dstStageMask must not be 0
If neither the VK_NV_ray_tracing extension or rayTracingPipeline feature are enabled, dstStageMask must not contain PIPELINE_STAGE_RAY_TRACING_SHADER_BIT_KHR
srcSubpass must be less than or equal to dstSubpass, unless one of them is SUBPASS_EXTERNAL, to avoid cyclic dependencies and ensure a valid execution order
srcSubpass and dstSubpass must not both be equal to SUBPASS_EXTERNAL
If srcSubpass is equal to dstSubpass and srcStageMask includes a framebuffer-space stage, dstStageMask must only contain framebuffer-space stages
Any access flag included in srcAccessMask must be supported by one of the pipeline stages in srcStageMask, as specified in the table of supported access types
Any access flag included in dstAccessMask must be supported by one of the pipeline stages in dstStageMask, as specified in the table of supported access types
If srcSubpass equals dstSubpass, and srcStageMask and dstStageMask both include a framebuffer-space stage, then dependencyFlags must include DEPENDENCY_BY_REGION_BIT
If dependencyFlags includes DEPENDENCY_VIEW_LOCAL_BIT, srcSubpass must not be equal to SUBPASS_EXTERNAL
If dependencyFlags includes DEPENDENCY_VIEW_LOCAL_BIT, dstSubpass must not be equal to SUBPASS_EXTERNAL
If srcSubpass equals dstSubpass and that subpass has more than one bit set in the view mask, then dependencyFlags must include DEPENDENCY_VIEW_LOCAL_BIT

Valid Usage (Implicit)

srcStageMask must be a valid combination of VkPipelineStageFlagBits values
dstStageMask must be a valid combination of VkPipelineStageFlagBits values
srcAccessMask must be a valid combination of VkAccessFlagBits values
dstAccessMask must be a valid combination of VkAccessFlagBits values
dependencyFlags must be a valid combination of VkDependencyFlagBits values

Layout


struct VkSubpassDependency {
    uint32_t srcSubpass;
    uint32_t dstSubpass;
    VkPipelineStageFlags srcStageMask;
    VkPipelineStageFlags dstStageMask;
    VkAccessFlags srcAccessMask;
    VkAccessFlags dstAccessMask;
    VkDependencyFlags dependencyFlags;
}

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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	DEPENDENCYFLAGS The struct member offsets.
public static final int	DSTACCESSMASK The struct member offsets.
public static final int	DSTSTAGEMASK The struct member offsets.
public static final int	DSTSUBPASS The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	SRCACCESSMASK The struct member offsets.
public static final int	SRCSTAGEMASK The struct member offsets.
public static final int	SRCSUBPASS The struct member offsets.

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

Method Summary

Modifier and Type	Method and Description
public static VkSubpassDependency	calloc() Returns a new `VkSubpassDependency` instance allocated with `memCalloc`.
public static VkSubpassDependency.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkSubpassDependency.Buffer` instance allocated with `memCalloc`.
public static VkSubpassDependency	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSubpassDependency` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSubpassDependency.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSubpassDependency.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSubpassDependency	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkSubpassDependency	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkSubpassDependency.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkSubpassDependency.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkSubpassDependency	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 VkSubpassDependency	create() Returns a new `VkSubpassDependency` instance allocated with `BufferUtils`.
public static VkSubpassDependency	create(long address) Returns a new `VkSubpassDependency` instance for the specified memory address.
public static VkSubpassDependency.Buffer	create(int the buffer capacity capacity) Returns a new `VkSubpassDependency.Buffer` instance allocated with `BufferUtils`.
public static VkSubpassDependency.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkSubpassDependency.Buffer` instance at the specified memory.
public static VkSubpassDependency	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkSubpassDependency.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	dependencyFlags() a bitmask of `VkDependencyFlagBits`.
public VkSubpassDependency	dependencyFlags(int value) Sets the specified value to the `dependencyFlags` field.
public int	dstAccessMask() a bitmask of `VkAccessFlagBits` specifying a destination access mask.
public VkSubpassDependency	dstAccessMask(int value) Sets the specified value to the `dstAccessMask` field.
public int	dstStageMask() a bitmask of `VkPipelineStageFlagBits` specifying the destination stage mask
public VkSubpassDependency	dstStageMask(int value) Sets the specified value to the `dstStageMask` field.
public int	dstSubpass() the subpass index of the second subpass in the dependency, or `SUBPASS_EXTERNAL`.
public VkSubpassDependency	dstSubpass(int value) Sets the specified value to the `dstSubpass` field.
public static VkSubpassDependency	malloc() Returns a new `VkSubpassDependency` instance allocated with `memAlloc`.
public static VkSubpassDependency.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkSubpassDependency.Buffer` instance allocated with `memAlloc`.
public static VkSubpassDependency	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSubpassDependency` instance allocated on the specified `MemoryStack`.
public static VkSubpassDependency.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSubpassDependency.Buffer` instance allocated on the specified `MemoryStack`.
public static VkSubpassDependency	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkSubpassDependency	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkSubpassDependency.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkSubpassDependency.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	ndependencyFlags(long struct) Unsafe version of `dependencyFlags`.
public static void	ndependencyFlags(long struct, int value) Unsafe version of `dependencyFlags`.
public static int	ndstAccessMask(long struct) Unsafe version of `dstAccessMask`.
public static void	ndstAccessMask(long struct, int value) Unsafe version of `dstAccessMask`.
public static int	ndstStageMask(long struct) Unsafe version of `dstStageMask`.
public static void	ndstStageMask(long struct, int value) Unsafe version of `dstStageMask`.
public static int	ndstSubpass(long struct) Unsafe version of `dstSubpass`.
public static void	ndstSubpass(long struct, int value) Unsafe version of `dstSubpass`.
public static int	nsrcAccessMask(long struct) Unsafe version of `srcAccessMask`.
public static void	nsrcAccessMask(long struct, int value) Unsafe version of `srcAccessMask`.
public static int	nsrcStageMask(long struct) Unsafe version of `srcStageMask`.
public static void	nsrcStageMask(long struct, int value) Unsafe version of `srcStageMask`.
public static int	nsrcSubpass(long struct) Unsafe version of `srcSubpass`.
public static void	nsrcSubpass(long struct, int value) Unsafe version of `srcSubpass`.
public VkSubpassDependency	set(int srcSubpass, int dstSubpass, int srcStageMask, int dstStageMask, int srcAccessMask, int dstAccessMask, int dependencyFlags) Initializes this struct with the specified values.
public VkSubpassDependency	Returns: this struct set(VkSubpassDependency 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	srcAccessMask() a bitmask of `VkAccessFlagBits` specifying a source access mask.
public VkSubpassDependency	srcAccessMask(int value) Sets the specified value to the `srcAccessMask` field.
public int	srcStageMask() a bitmask of `VkPipelineStageFlagBits` specifying the source stage mask.
public VkSubpassDependency	srcStageMask(int value) Sets the specified value to the `srcStageMask` field.
public int	srcSubpass() the subpass index of the first subpass in the dependency, or `SUBPASS_EXTERNAL`.
public VkSubpassDependency	srcSubpass(int value) Sets the specified value to the `srcSubpass` field.

public Class VkSubpassDependency

Description

Note

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary