Package org.lwjgl.vulkan
Class VkCommandBufferInheritanceInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.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.NativeResourceStructure specifying command buffer inheritance information.Description
If the
VkCommandBufferwill not be executed within a render pass instance, or if the render pass instance was begun withCmdBeginRendering,renderPass,subpass, andframebufferare ignored.Valid Usage
- If the inherited queries feature is not enabled,
occlusionQueryEnablemust beFALSE - If the inherited queries feature is enabled,
queryFlagsmust be a valid combination ofVkQueryControlFlagBitsvalues - If the inherited queries feature is not enabled,
queryFlagsmust be 0 - If the pipeline statistics queries feature is enabled,
pipelineStatisticsmust be a valid combination ofVkQueryPipelineStatisticFlagBitsvalues - If the pipeline statistics queries feature is not enabled,
pipelineStatisticsmust be 0
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO- Each
pNextmember of any structure (including this one) in thepNextchain must be eitherNULLor a pointer to a valid instance ofVkAttachmentSampleCountInfoAMD,VkCommandBufferInheritanceConditionalRenderingInfoEXT,VkCommandBufferInheritanceRenderPassTransformInfoQCOM,VkCommandBufferInheritanceRenderingInfo,VkCommandBufferInheritanceViewportScissorInfoNV, orVkMultiviewPerViewAttributesInfoNVX - The
sTypevalue of each struct in thepNextchain must be unique - Both of
framebuffer, andrenderPassthat are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the sameVkDevice
See Also
Layout
struct VkCommandBufferInheritanceInfo { VkStructureTypesType(); void const *pNext(); VkRenderPassrenderPass(); uint32_tsubpass(); VkFramebufferframebuffer(); VkBool32occlusionQueryEnable(); VkQueryControlFlagsqueryFlags(); VkQueryPipelineStatisticFlagspipelineStatistics(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkCommandBufferInheritanceInfo.BufferAn array ofVkCommandBufferInheritanceInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intFRAMEBUFFER
OCCLUSIONQUERYENABLE
PIPELINESTATISTICS
PNEXT
QUERYFLAGS
RENDERPASSThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTYPE
SUBPASSThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkCommandBufferInheritanceInfo(java.nio.ByteBuffer container)Creates aVkCommandBufferInheritanceInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkCommandBufferInheritanceInfocalloc()Returns a newVkCommandBufferInheritanceInfoinstance allocated withmemCalloc.static VkCommandBufferInheritanceInfo.Buffercalloc(int capacity)Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withmemCalloc.static VkCommandBufferInheritanceInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkCommandBufferInheritanceInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkCommandBufferInheritanceInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkCommandBufferInheritanceInfocallocStack()Deprecated.static VkCommandBufferInheritanceInfo.BuffercallocStack(int capacity)Deprecated.static VkCommandBufferInheritanceInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkCommandBufferInheritanceInfocallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkCommandBufferInheritanceInfocreate()Returns a newVkCommandBufferInheritanceInfoinstance allocated withBufferUtils.static VkCommandBufferInheritanceInfo.Buffercreate(int capacity)Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withBufferUtils.static VkCommandBufferInheritanceInfocreate(long address)Returns a newVkCommandBufferInheritanceInfoinstance for the specified memory address.static VkCommandBufferInheritanceInfo.Buffercreate(long address, int capacity)Create aVkCommandBufferInheritanceInfo.Bufferinstance at the specified memory.static VkCommandBufferInheritanceInfocreateSafe(long address)static VkCommandBufferInheritanceInfo.BuffercreateSafe(long address, int capacity)longframebuffer()can refer to theVkFramebufferobject that theVkCommandBufferwill be rendering to if it is executed within a render pass instance.VkCommandBufferInheritanceInfoframebuffer(long value)Sets the specified value to theframebuffer()field.static VkCommandBufferInheritanceInfomalloc()Returns a newVkCommandBufferInheritanceInfoinstance allocated withmemAlloc.static VkCommandBufferInheritanceInfo.Buffermalloc(int capacity)Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withmemAlloc.static VkCommandBufferInheritanceInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkCommandBufferInheritanceInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkCommandBufferInheritanceInfoinstance allocated on the specifiedMemoryStack.static VkCommandBufferInheritanceInfomallocStack()Deprecated.static VkCommandBufferInheritanceInfo.BuffermallocStack(int capacity)Deprecated.static VkCommandBufferInheritanceInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkCommandBufferInheritanceInfomallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static longnframebuffer(long struct)Unsafe version offramebuffer().static voidnframebuffer(long struct, long value)Unsafe version offramebuffer.static intnocclusionQueryEnable(long struct)Unsafe version ofocclusionQueryEnable().static voidnocclusionQueryEnable(long struct, int value)Unsafe version ofocclusionQueryEnable.static intnpipelineStatistics(long struct)Unsafe version ofpipelineStatistics().static voidnpipelineStatistics(long struct, int value)Unsafe version ofpipelineStatistics.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnqueryFlags(long struct)Unsafe version ofqueryFlags().static voidnqueryFlags(long struct, int value)Unsafe version ofqueryFlags.static longnrenderPass(long struct)Unsafe version ofrenderPass().static voidnrenderPass(long struct, long value)Unsafe version ofrenderPass.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.static intnsubpass(long struct)Unsafe version ofsubpass().static voidnsubpass(long struct, int value)Unsafe version ofsubpass.booleanocclusionQueryEnable()specifies whether the command buffer can be executed while an occlusion query is active in the primary command buffer.VkCommandBufferInheritanceInfoocclusionQueryEnable(boolean value)Sets the specified value to theocclusionQueryEnable()field.intpipelineStatistics()a bitmask ofVkQueryPipelineStatisticFlagBitsspecifying 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.VkCommandBufferInheritanceInfopipelineStatistics(int value)Sets the specified value to thepipelineStatistics()field.longpNext()NULLor a pointer to a structure extending this structure.VkCommandBufferInheritanceInfopNext(long value)Sets the specified value to thepNext()field.VkCommandBufferInheritanceInfopNext(VkAttachmentSampleCountInfoAMD value)Prepends the specifiedVkAttachmentSampleCountInfoAMDvalue to thepNextchain.VkCommandBufferInheritanceInfopNext(VkAttachmentSampleCountInfoNV value)Prepends the specifiedVkAttachmentSampleCountInfoNVvalue to thepNextchain.VkCommandBufferInheritanceInfopNext(VkCommandBufferInheritanceConditionalRenderingInfoEXT value)Prepends the specifiedVkCommandBufferInheritanceConditionalRenderingInfoEXTvalue to thepNextchain.VkCommandBufferInheritanceInfopNext(VkCommandBufferInheritanceRenderingInfo value)Prepends the specifiedVkCommandBufferInheritanceRenderingInfovalue to thepNextchain.VkCommandBufferInheritanceInfopNext(VkCommandBufferInheritanceRenderingInfoKHR value)Prepends the specifiedVkCommandBufferInheritanceRenderingInfoKHRvalue to thepNextchain.VkCommandBufferInheritanceInfopNext(VkCommandBufferInheritanceRenderPassTransformInfoQCOM value)Prepends the specifiedVkCommandBufferInheritanceRenderPassTransformInfoQCOMvalue to thepNextchain.VkCommandBufferInheritanceInfopNext(VkCommandBufferInheritanceViewportScissorInfoNV value)Prepends the specifiedVkCommandBufferInheritanceViewportScissorInfoNVvalue to thepNextchain.VkCommandBufferInheritanceInfopNext(VkMultiviewPerViewAttributesInfoNVX value)Prepends the specifiedVkMultiviewPerViewAttributesInfoNVXvalue to thepNextchain.intqueryFlags()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.VkCommandBufferInheritanceInfoqueryFlags(int value)Sets the specified value to thequeryFlags()field.longrenderPass()aVkRenderPassobject defining which render passes theVkCommandBufferwill be compatible with and can be executed within.VkCommandBufferInheritanceInforenderPass(long value)Sets the specified value to therenderPass()field.VkCommandBufferInheritanceInfoset(int sType, long pNext, long renderPass, int subpass, long framebuffer, boolean occlusionQueryEnable, int queryFlags, int pipelineStatistics)Initializes this struct with the specified values.VkCommandBufferInheritanceInfoset(VkCommandBufferInheritanceInfo src)Copies the specified struct data to this struct.intsizeof()intsType()the type of this structure.VkCommandBufferInheritanceInfosType(int value)Sets the specified value to thesType()field.VkCommandBufferInheritanceInfosType$Default()Sets theSTRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFOvalue to thesType()field.intsubpass()the index of the subpass within the render pass instance that theVkCommandBufferwill be executed within.VkCommandBufferInheritanceInfosubpass(int value)Sets the specified value to thesubpass()field.
-
-
-
Constructor Detail
-
VkCommandBufferInheritanceInfo
public VkCommandBufferInheritanceInfo(java.nio.ByteBuffer container)
Creates aVkCommandBufferInheritanceInfoinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
renderPass
public long renderPass()
aVkRenderPassobject defining which render passes theVkCommandBufferwill be compatible with and can be executed within.
-
subpass
public int subpass()
the index of the subpass within the render pass instance that theVkCommandBufferwill be executed within.
-
framebuffer
public long framebuffer()
can refer to theVkFramebufferobject that theVkCommandBufferwill be rendering to if it is executed within a render pass instance. It can beNULL_HANDLEif the framebuffer is not known.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
public boolean occlusionQueryEnable()
specifies whether the command buffer can be executed while an occlusion query is active in the primary command buffer. If this isTRUE, then this command buffer can be executed whether the primary command buffer has an occlusion query active or not. If this isFALSE, then the primary command buffer must not have an occlusion query active.
-
queryFlags
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. If this value includes theQUERY_CONTROL_PRECISE_BITbit, 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 theQUERY_CONTROL_PRECISE_BITbit.
-
pipelineStatistics
public int pipelineStatistics()
a bitmask ofVkQueryPipelineStatisticFlagBitsspecifying 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.
-
sType
public VkCommandBufferInheritanceInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkCommandBufferInheritanceInfo sType$Default()
Sets theSTRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFOvalue to thesType()field.
-
pNext
public VkCommandBufferInheritanceInfo pNext(long value)
Sets the specified value to thepNext()field.
-
pNext
public VkCommandBufferInheritanceInfo pNext(VkAttachmentSampleCountInfoAMD value)
Prepends the specifiedVkAttachmentSampleCountInfoAMDvalue to thepNextchain.
-
pNext
public VkCommandBufferInheritanceInfo pNext(VkAttachmentSampleCountInfoNV value)
Prepends the specifiedVkAttachmentSampleCountInfoNVvalue to thepNextchain.
-
pNext
public VkCommandBufferInheritanceInfo pNext(VkCommandBufferInheritanceConditionalRenderingInfoEXT value)
Prepends the specifiedVkCommandBufferInheritanceConditionalRenderingInfoEXTvalue to thepNextchain.
-
pNext
public VkCommandBufferInheritanceInfo pNext(VkCommandBufferInheritanceRenderPassTransformInfoQCOM value)
Prepends the specifiedVkCommandBufferInheritanceRenderPassTransformInfoQCOMvalue to thepNextchain.
-
pNext
public VkCommandBufferInheritanceInfo pNext(VkCommandBufferInheritanceRenderingInfo value)
Prepends the specifiedVkCommandBufferInheritanceRenderingInfovalue to thepNextchain.
-
pNext
public VkCommandBufferInheritanceInfo pNext(VkCommandBufferInheritanceRenderingInfoKHR value)
Prepends the specifiedVkCommandBufferInheritanceRenderingInfoKHRvalue to thepNextchain.
-
pNext
public VkCommandBufferInheritanceInfo pNext(VkCommandBufferInheritanceViewportScissorInfoNV value)
Prepends the specifiedVkCommandBufferInheritanceViewportScissorInfoNVvalue to thepNextchain.
-
pNext
public VkCommandBufferInheritanceInfo pNext(VkMultiviewPerViewAttributesInfoNVX value)
Prepends the specifiedVkMultiviewPerViewAttributesInfoNVXvalue to thepNextchain.
-
renderPass
public VkCommandBufferInheritanceInfo renderPass(long value)
Sets the specified value to therenderPass()field.
-
subpass
public VkCommandBufferInheritanceInfo subpass(int value)
Sets the specified value to thesubpass()field.
-
framebuffer
public VkCommandBufferInheritanceInfo framebuffer(long value)
Sets the specified value to theframebuffer()field.
-
occlusionQueryEnable
public VkCommandBufferInheritanceInfo occlusionQueryEnable(boolean value)
Sets the specified value to theocclusionQueryEnable()field.
-
queryFlags
public VkCommandBufferInheritanceInfo queryFlags(int value)
Sets the specified value to thequeryFlags()field.
-
pipelineStatistics
public VkCommandBufferInheritanceInfo pipelineStatistics(int value)
Sets the specified value to thepipelineStatistics()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.
-
set
public VkCommandBufferInheritanceInfo set(VkCommandBufferInheritanceInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkCommandBufferInheritanceInfo malloc()
Returns a newVkCommandBufferInheritanceInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkCommandBufferInheritanceInfo calloc()
Returns a newVkCommandBufferInheritanceInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkCommandBufferInheritanceInfo create()
Returns a newVkCommandBufferInheritanceInfoinstance allocated withBufferUtils.
-
create
public static VkCommandBufferInheritanceInfo create(long address)
Returns a newVkCommandBufferInheritanceInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkCommandBufferInheritanceInfo createSafe(long address)
-
malloc
public static VkCommandBufferInheritanceInfo.Buffer malloc(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkCommandBufferInheritanceInfo.Buffer calloc(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkCommandBufferInheritanceInfo.Buffer create(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkCommandBufferInheritanceInfo.Buffer create(long address, int capacity)
Create aVkCommandBufferInheritanceInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkCommandBufferInheritanceInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkCommandBufferInheritanceInfo mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkCommandBufferInheritanceInfo callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkCommandBufferInheritanceInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkCommandBufferInheritanceInfo callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkCommandBufferInheritanceInfo.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkCommandBufferInheritanceInfo.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkCommandBufferInheritanceInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkCommandBufferInheritanceInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkCommandBufferInheritanceInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkCommandBufferInheritanceInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkCommandBufferInheritanceInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkCommandBufferInheritanceInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nrenderPass
public static long nrenderPass(long struct)
Unsafe version ofrenderPass().
-
nsubpass
public static int nsubpass(long struct)
Unsafe version ofsubpass().
-
nframebuffer
public static long nframebuffer(long struct)
Unsafe version offramebuffer().
-
nocclusionQueryEnable
public static int nocclusionQueryEnable(long struct)
Unsafe version ofocclusionQueryEnable().
-
nqueryFlags
public static int nqueryFlags(long struct)
Unsafe version ofqueryFlags().
-
npipelineStatistics
public static int npipelineStatistics(long struct)
Unsafe version ofpipelineStatistics().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nrenderPass
public static void nrenderPass(long struct, long value)Unsafe version ofrenderPass.
-
nsubpass
public static void nsubpass(long struct, int value)Unsafe version ofsubpass.
-
nframebuffer
public static void nframebuffer(long struct, long value)Unsafe version offramebuffer.
-
nocclusionQueryEnable
public static void nocclusionQueryEnable(long struct, int value)Unsafe version ofocclusionQueryEnable.
-
nqueryFlags
public static void nqueryFlags(long struct, int value)Unsafe version ofqueryFlags.
-
npipelineStatistics
public static void npipelineStatistics(long struct, int value)Unsafe version ofpipelineStatistics.
-
-