LWJGL 3.3.3 · org.lwjgl.vulkan.VkSubpassDependency2

Structure specifying a subpass dependency.

Description

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

viewOffset has the same effect for the described subpass dependency as VkRenderPassMultiviewCreateInfo::pViewOffsets has on each corresponding subpass dependency.

If a VkMemoryBarrier2 is included in the pNext chain, srcStageMask, dstStageMask, srcAccessMask, and dstAccessMask parameters are ignored. The synchronization and access scopes instead are defined by the parameters of VkMemoryBarrier2.

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 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 srcStageMask and dstStageMask both include a framebuffer-space stage, then dependencyFlags must include DEPENDENCY_BY_REGION_BIT
If viewOffset is not equal to 0, srcSubpass must not be equal to dstSubpass
If dependencyFlags does not include DEPENDENCY_VIEW_LOCAL_BIT, viewOffset must be 0

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_SUBPASS_DEPENDENCY_2
pNext must be NULL or a pointer to a valid instance of VkMemoryBarrier2
The sType value of each struct in the pNext chain must be unique
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 VkSubpassDependency2 {
    VkStructureType sType;
    void const * pNext;
    uint32_t srcSubpass;
    uint32_t dstSubpass;
    VkPipelineStageFlags srcStageMask;
    VkPipelineStageFlags dstStageMask;
    VkAccessFlags srcAccessMask;
    VkAccessFlags dstAccessMask;
    VkDependencyFlags dependencyFlags;
    int32_t viewOffset;
}

Modifier and Type	Class and Description
public static class	VkSubpassDependency2.Buffer An array of `VkSubpassDependency2` 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	PNEXT 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.
public static final int	STYPE The struct member offsets.
public static final int	VIEWOFFSET The struct member offsets.

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

Method Summary

Modifier and Type	Method and Description
public static VkSubpassDependency2	calloc() Returns a new `VkSubpassDependency2` instance allocated with `memCalloc`.
public static VkSubpassDependency2.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkSubpassDependency2.Buffer` instance allocated with `memCalloc`.
public static VkSubpassDependency2	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSubpassDependency2` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkSubpassDependency2.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSubpassDependency2.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected VkSubpassDependency2	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 VkSubpassDependency2	create() Returns a new `VkSubpassDependency2` instance allocated with `BufferUtils`.
public static VkSubpassDependency2	create(long address) Returns a new `VkSubpassDependency2` instance for the specified memory address.
public static VkSubpassDependency2.Buffer	create(int the buffer capacity capacity) Returns a new `VkSubpassDependency2.Buffer` instance allocated with `BufferUtils`.
public static VkSubpassDependency2.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkSubpassDependency2.Buffer` instance at the specified memory.
public static VkSubpassDependency2	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkSubpassDependency2.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	dependencyFlags() a bitmask of `VkDependencyFlagBits`.
public VkSubpassDependency2	dependencyFlags(int value) Sets the specified value to the `dependencyFlags` field.
public int	dstAccessMask() a bitmask of `VkAccessFlagBits` specifying a destination access mask.
public VkSubpassDependency2	dstAccessMask(int value) Sets the specified value to the `dstAccessMask` field.
public int	dstStageMask() a bitmask of `VkPipelineStageFlagBits` specifying the destination stage mask
public VkSubpassDependency2	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 VkSubpassDependency2	dstSubpass(int value) Sets the specified value to the `dstSubpass` field.
public static VkSubpassDependency2	malloc() Returns a new `VkSubpassDependency2` instance allocated with `memAlloc`.
public static VkSubpassDependency2.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkSubpassDependency2.Buffer` instance allocated with `memAlloc`.
public static VkSubpassDependency2	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkSubpassDependency2` instance allocated on the specified `MemoryStack`.
public static VkSubpassDependency2.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkSubpassDependency2.Buffer` instance allocated on the specified `MemoryStack`.
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 long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
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 static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public static int	nviewOffset(long struct) Unsafe version of `viewOffset`.
public static void	nviewOffset(long struct, int value) Unsafe version of `viewOffset`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkSubpassDependency2	pNext(long value) Sets the specified value to the `pNext` field.
public VkSubpassDependency2	pNext(VkMemoryBarrier2 value) Prepends the specified `VkMemoryBarrier2` value to the `pNext` chain.
public VkSubpassDependency2	pNext(VkMemoryBarrier2KHR value) Prepends the specified `VkMemoryBarrier2KHR` value to the `pNext` chain.
public VkSubpassDependency2	set(int sType, long pNext, int srcSubpass, int dstSubpass, int srcStageMask, int dstStageMask, int srcAccessMask, int dstAccessMask, int dependencyFlags, int viewOffset) Initializes this struct with the specified values.
public VkSubpassDependency2	Returns: this struct set(VkSubpassDependency2 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 VkSubpassDependency2	srcAccessMask(int value) Sets the specified value to the `srcAccessMask` field.
public int	srcStageMask() a bitmask of `VkPipelineStageFlagBits` specifying the source stage mask.
public VkSubpassDependency2	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 VkSubpassDependency2	srcSubpass(int value) Sets the specified value to the `srcSubpass` field.
public int	sType() a `VkStructureType` value identifying this structure.
public VkSubpassDependency2	sType(int value) Sets the specified value to the `sType` field.
public VkSubpassDependency2	sType$Default() Sets the `STRUCTURE_TYPE_SUBPASS_DEPENDENCY_2` value to the `sType` field.
public int	viewOffset() controls which views in the source subpass the views in the destination subpass depend on.
public VkSubpassDependency2	viewOffset(int value) Sets the specified value to the `viewOffset` field.

public Class VkSubpassDependency2

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary