Package org.lwjgl.vulkan

Class VkCommandBufferInheritanceInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer
    public class VkCommandBufferInheritanceInfo
extends Struct
implements NativeResource
    Structure specifying command buffer inheritance info.
    Valid Usage
    Valid Usage (Implicit)
    See Also

    VkCommandBufferBeginInfo

    Member documentation

    • sType – the type of this structure.
    • pNext – NULL or a pointer to an extension-specific structure.
    • renderPass – a VkRenderPass object defining which render passes the VkCommandBuffer will be compatible with and can be executed within. If the VkCommandBuffer will not be executed within a render pass instance, renderPass is ignored.
    • subpass – the index of the subpass within the render pass instance that the VkCommandBuffer will be executed within. If the VkCommandBuffer will not be executed within a render pass instance, subpass is ignored.
    • framebuffer – optionally refers to the VkFramebuffer object that the VkCommandBuffer will be rendering to if it is executed within a render pass instance. It can be NULL_HANDLE if the framebuffer is not known, or if the VkCommandBuffer will not be executed within a render pass instance.
      Note

      Specifying the exact framebuffer that the secondary command buffer will be executed with may result in better performance at command buffer execution time.

    • occlusionQueryEnable – specifies whether the command buffer can be executed while an occlusion query is active in the primary command buffer. If this is TRUE, then this command buffer can be executed whether the primary command buffer has an occlusion query active or not. If this is FALSE, then the primary command buffer must not have an occlusion query active.
    • 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. If this value includes the QUERY_CONTROL_PRECISE_BIT bit, then the active query can return boolean results or actual sample counts. If this bit is not set, then the active query must not use the QUERY_CONTROL_PRECISE_BIT bit.
    • 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. If this value includes a given bit, then this command buffer can be executed whether the primary command buffer has a pipeline statistics query active that includes this bit or not. If this value excludes a given bit, then the active pipeline statistics query must not be from a query pool that counts that statistic.

    Layout

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

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • STYPE, PNEXT, RENDERPASS, SUBPASS, FRAMEBUFFER, OCCLUSIONQUERYENABLE, QUERYFLAGS, PIPELINESTATISTICS

        The struct member offsets.

    • Constructor Detail

      • VkCommandBufferInheritanceInfo

        public VkCommandBufferInheritanceInfo​(java.nio.ByteBuffer container)
        Creates a VkCommandBufferInheritanceInfo 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.