Class VkCommandBufferInheritanceInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class VkCommandBufferInheritanceInfo
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource
    Structure specifying command buffer inheritance info.
    Valid Usage
    Valid Usage (Implicit)
    See Also

    VkCommandBufferBeginInfo

    Member documentation

    • sType – the type of this structure.
    • pNextNULL 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.

    • Method Detail

      • sizeof

        public int sizeof()
        Specified by:
        sizeof in class org.lwjgl.system.Struct
      • sType

        public int sType()
        Returns the value of the sType field.
      • pNext

        public long pNext()
        Returns the value of the pNext field.
      • renderPass

        public long renderPass()
        Returns the value of the renderPass field.
      • subpass

        public int subpass()
        Returns the value of the subpass field.
      • framebuffer

        public long framebuffer()
        Returns the value of the framebuffer field.
      • occlusionQueryEnable

        public boolean occlusionQueryEnable()
        Returns the value of the occlusionQueryEnable field.
      • queryFlags

        public int queryFlags()
        Returns the value of the queryFlags field.
      • pipelineStatistics

        public int pipelineStatistics()
        Returns the value of the pipelineStatistics field.
      • occlusionQueryEnable

        public VkCommandBufferInheritanceInfo occlusionQueryEnable​(boolean value)
        Sets the specified value to the occlusionQueryEnable field.
      • pipelineStatistics

        public VkCommandBufferInheritanceInfo pipelineStatistics​(int value)
        Sets the specified value to the pipelineStatistics field.
      • set

        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.
      • malloc

        public static VkCommandBufferInheritanceInfo malloc()
        Returns a new VkCommandBufferInheritanceInfo instance allocated with memAlloc. The instance must be explicitly freed.
      • calloc

        public static VkCommandBufferInheritanceInfo calloc()
        Returns a new VkCommandBufferInheritanceInfo instance allocated with memCalloc. The instance must be explicitly freed.
      • create

        public static VkCommandBufferInheritanceInfo create​(long address)
        Returns a new VkCommandBufferInheritanceInfo instance for the specified memory address.
      • mallocStack

        public static VkCommandBufferInheritanceInfo mallocStack()
        Returns a new VkCommandBufferInheritanceInfo instance allocated on the thread-local MemoryStack.
      • callocStack

        public static VkCommandBufferInheritanceInfo callocStack()
        Returns a new VkCommandBufferInheritanceInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      • mallocStack

        public static VkCommandBufferInheritanceInfo mallocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkCommandBufferInheritanceInfo instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
      • callocStack

        public static VkCommandBufferInheritanceInfo callocStack​(org.lwjgl.system.MemoryStack stack)
        Returns a new VkCommandBufferInheritanceInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate
      • nsType

        public static int nsType​(long struct)
        Unsafe version of sType().
      • npNext

        public static long npNext​(long struct)
        Unsafe version of pNext().
      • nrenderPass

        public static long nrenderPass​(long struct)
        Unsafe version of renderPass().
      • nsubpass

        public static int nsubpass​(long struct)
        Unsafe version of subpass().
      • nframebuffer

        public static long nframebuffer​(long struct)
        Unsafe version of framebuffer().
      • nocclusionQueryEnable

        public static int nocclusionQueryEnable​(long struct)
        Unsafe version of occlusionQueryEnable().
      • nqueryFlags

        public static int nqueryFlags​(long struct)
        Unsafe version of queryFlags().
      • npipelineStatistics

        public static int npipelineStatistics​(long struct)
        Unsafe version of pipelineStatistics().
      • nsType

        public static void nsType​(long struct,
                                  int value)
        Unsafe version of sType.
      • npNext

        public static void npNext​(long struct,
                                  long value)
        Unsafe version of pNext.
      • nrenderPass

        public static void nrenderPass​(long struct,
                                       long value)
        Unsafe version of renderPass.
      • nsubpass

        public static void nsubpass​(long struct,
                                    int value)
        Unsafe version of subpass.
      • nframebuffer

        public static void nframebuffer​(long struct,
                                        long value)
        Unsafe version of framebuffer.
      • nocclusionQueryEnable

        public static void nocclusionQueryEnable​(long struct,
                                                 int value)
        Unsafe version of occlusionQueryEnable.
      • nqueryFlags

        public static void nqueryFlags​(long struct,
                                       int value)
        Unsafe version of queryFlags.
      • npipelineStatistics

        public static void npipelineStatistics​(long struct,
                                               int value)
        Unsafe version of pipelineStatistics.