LWJGL 3.3.3 · org.lwjgl.vulkan.VkCommandBufferInheritanceInfo

Structure specifying command buffer inheritance information.

Description

If the VkCommandBuffer will not be executed within a render pass instance, or if the render pass instance was begun with CmdBeginRendering, renderPass, subpass, and framebuffer are ignored.

Valid Usage

If the inheritedQueries feature is not enabled, occlusionQueryEnable must be FALSE
If the inheritedQueries feature is enabled, queryFlags must be a valid combination of VkQueryControlFlagBits values
If the inheritedQueries feature is not enabled, queryFlags must be 0
If the pipelineStatisticsQuery feature is enabled, pipelineStatistics must be a valid combination of VkQueryPipelineStatisticFlagBits values
If the pipelineStatisticsQuery feature is not enabled, pipelineStatistics must be 0

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO
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 VkAttachmentSampleCountInfoAMD, VkCommandBufferInheritanceConditionalRenderingInfoEXT, VkCommandBufferInheritanceRenderPassTransformInfoQCOM, VkCommandBufferInheritanceRenderingInfo, VkCommandBufferInheritanceViewportScissorInfoNV, or VkMultiviewPerViewAttributesInfoNVX
The sType value of each struct in the pNext chain must be unique
Both of framebuffer, and renderPass that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice

Layout


struct VkCommandBufferInheritanceInfo {
    VkStructureType sType;
    void const * pNext;
    VkRenderPass renderPass;
    uint32_t subpass;
    VkFramebuffer framebuffer;
    VkBool32 occlusionQueryEnable;
    VkQueryControlFlags queryFlags;
    VkQueryPipelineStatisticFlags pipelineStatistics;
}

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

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	FRAMEBUFFER The struct member offsets.
public static final int	OCCLUSIONQUERYENABLE The struct member offsets.
public static final int	PIPELINESTATISTICS The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	QUERYFLAGS The struct member offsets.
public static final int	RENDERPASS 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	SUBPASS The struct member offsets.

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

Method Summary

Modifier and Type	Method and Description
public static VkCommandBufferInheritanceInfo	calloc() Returns a new `VkCommandBufferInheritanceInfo` instance allocated with `memCalloc`.
public static VkCommandBufferInheritanceInfo.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated with `memCalloc`.
public static VkCommandBufferInheritanceInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkCommandBufferInheritanceInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkCommandBufferInheritanceInfo.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkCommandBufferInheritanceInfo	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkCommandBufferInheritanceInfo	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkCommandBufferInheritanceInfo.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkCommandBufferInheritanceInfo.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkCommandBufferInheritanceInfo	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 VkCommandBufferInheritanceInfo	create() Returns a new `VkCommandBufferInheritanceInfo` instance allocated with `BufferUtils`.
public static VkCommandBufferInheritanceInfo	create(long address) Returns a new `VkCommandBufferInheritanceInfo` instance for the specified memory address.
public static VkCommandBufferInheritanceInfo.Buffer	create(int the buffer capacity capacity) Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated with `BufferUtils`.
public static VkCommandBufferInheritanceInfo.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkCommandBufferInheritanceInfo.Buffer` instance at the specified memory.
public static VkCommandBufferInheritanceInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkCommandBufferInheritanceInfo.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public long	framebuffer() can refer to the `VkFramebuffer` object that the `VkCommandBuffer` will be rendering to if it is executed within a render pass instance.
public VkCommandBufferInheritanceInfo	framebuffer(long value) Sets the specified value to the `framebuffer` field.
public static VkCommandBufferInheritanceInfo	malloc() Returns a new `VkCommandBufferInheritanceInfo` instance allocated with `memAlloc`.
public static VkCommandBufferInheritanceInfo.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated with `memAlloc`.
public static VkCommandBufferInheritanceInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkCommandBufferInheritanceInfo` instance allocated on the specified `MemoryStack`.
public static VkCommandBufferInheritanceInfo.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated on the specified `MemoryStack`.
public static VkCommandBufferInheritanceInfo	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkCommandBufferInheritanceInfo	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkCommandBufferInheritanceInfo.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkCommandBufferInheritanceInfo.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static long	nframebuffer(long struct) Unsafe version of `framebuffer`.
public static void	nframebuffer(long struct, long value) Unsafe version of `framebuffer`.
public static int	nocclusionQueryEnable(long struct) Unsafe version of `occlusionQueryEnable`.
public static void	nocclusionQueryEnable(long struct, int value) Unsafe version of `occlusionQueryEnable`.
public static int	npipelineStatistics(long struct) Unsafe version of `pipelineStatistics`.
public static void	npipelineStatistics(long struct, int value) Unsafe version of `pipelineStatistics`.
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	nqueryFlags(long struct) Unsafe version of `queryFlags`.
public static void	nqueryFlags(long struct, int value) Unsafe version of `queryFlags`.
public static long	nrenderPass(long struct) Unsafe version of `renderPass`.
public static void	nrenderPass(long struct, long value) Unsafe version of `renderPass`.
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	nsubpass(long struct) Unsafe version of `subpass`.
public static void	nsubpass(long struct, int value) Unsafe version of `subpass`.
public boolean	occlusionQueryEnable() specifies whether the command buffer can be executed while an occlusion query is active in the primary command buffer.
public VkCommandBufferInheritanceInfo	occlusionQueryEnable(boolean value) Sets the specified value to the `occlusionQueryEnable` field.
public int	pipelineStatistics() a bitmask of `VkQueryPipelineStatisticFlagBits` specifying the set of pipeline statistics that can be counted by an active query in the primary command buffer when this secondary command buffer is executed.
public VkCommandBufferInheritanceInfo	pipelineStatistics(int value) Sets the specified value to the `pipelineStatistics` field.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkCommandBufferInheritanceInfo	pNext(long value) Sets the specified value to the `pNext` field.
public VkCommandBufferInheritanceInfo	pNext(VkAttachmentSampleCountInfoAMD value) Prepends the specified `VkAttachmentSampleCountInfoAMD` value to the `pNext` chain.
public VkCommandBufferInheritanceInfo	pNext(VkAttachmentSampleCountInfoNV value) Prepends the specified `VkAttachmentSampleCountInfoNV` value to the `pNext` chain.
public VkCommandBufferInheritanceInfo	pNext(VkCommandBufferInheritanceConditionalRenderingInfoEXT value) Prepends the specified `VkCommandBufferInheritanceConditionalRenderingInfoEXT` value to the `pNext` chain.
public VkCommandBufferInheritanceInfo	pNext(VkCommandBufferInheritanceRenderPassTransformInfoQCOM value) Prepends the specified `VkCommandBufferInheritanceRenderPassTransformInfoQCOM` value to the `pNext` chain.
public VkCommandBufferInheritanceInfo	pNext(VkCommandBufferInheritanceRenderingInfo value) Prepends the specified `VkCommandBufferInheritanceRenderingInfo` value to the `pNext` chain.
public VkCommandBufferInheritanceInfo	pNext(VkCommandBufferInheritanceRenderingInfoKHR value) Prepends the specified `VkCommandBufferInheritanceRenderingInfoKHR` value to the `pNext` chain.
public VkCommandBufferInheritanceInfo	pNext(VkCommandBufferInheritanceViewportScissorInfoNV value) Prepends the specified `VkCommandBufferInheritanceViewportScissorInfoNV` value to the `pNext` chain.
public VkCommandBufferInheritanceInfo	pNext(VkMultiviewPerViewAttributesInfoNVX value) Prepends the specified `VkMultiviewPerViewAttributesInfoNVX` value to the `pNext` chain.
public int	queryFlags() specifies the query flags that can be used by an active occlusion query in the primary command buffer when this secondary command buffer is executed.
public VkCommandBufferInheritanceInfo	queryFlags(int value) Sets the specified value to the `queryFlags` field.
public long	renderPass() a `VkRenderPass` object defining which render passes the `VkCommandBuffer` will be compatible with and can be executed within.
public VkCommandBufferInheritanceInfo	renderPass(long value) Sets the specified value to the `renderPass` field.
public VkCommandBufferInheritanceInfo	set(int sType, long pNext, long renderPass, int subpass, long framebuffer, boolean occlusionQueryEnable, int queryFlags, int pipelineStatistics) Initializes this struct with the specified values.
public VkCommandBufferInheritanceInfo	Returns: this struct set(VkCommandBufferInheritanceInfo 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 VkCommandBufferInheritanceInfo	sType(int value) Sets the specified value to the `sType` field.
public VkCommandBufferInheritanceInfo	sType$Default() Sets the `STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO` value to the `sType` field.
public int	subpass() the index of the subpass within the render pass instance that the `VkCommandBuffer` will be executed within.
public VkCommandBufferInheritanceInfo	subpass(int value) Sets the specified value to the `subpass` field.

public Class VkCommandBufferInheritanceInfo

Description

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary