Package org.lwjgl.vulkan
Class VkCommandBufferInheritanceInfo
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkCommandBufferInheritanceInfo>
org.lwjgl.vulkan.VkCommandBufferInheritanceInfo
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkCommandBufferInheritanceInfo
extends org.lwjgl.system.Struct<VkCommandBufferInheritanceInfo>
implements org.lwjgl.system.NativeResource
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
inheritedQueriesfeature is not enabled,occlusionQueryEnablemust beFALSE - If the
inheritedQueriesfeature is enabled,queryFlagsmust be a valid combination ofVkQueryControlFlagBitsvalues - If the
inheritedQueriesfeature is not enabled,queryFlagsmust be 0 - If the
pipelineStatisticsQueryfeature is enabled,pipelineStatisticsmust be a valid combination ofVkQueryPipelineStatisticFlagBitsvalues - If the
pipelineStatisticsQueryfeature 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,VkExternalFormatANDROID,VkMultiviewPerViewAttributesInfoNVX,VkRenderingAttachmentLocationInfo, orVkRenderingInputAttachmentIndexInfo - 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 {
VkStructureType sType();
void const * pNext();
VkRenderPass renderPass();
uint32_t subpass();
VkFramebuffer framebuffer();
VkBool32 occlusionQueryEnable();
VkQueryControlFlags queryFlags();
VkQueryPipelineStatisticFlags pipelineStatistics();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkCommandBufferInheritanceInfostructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkCommandBufferInheritanceInfo(ByteBuffer container) Creates aVkCommandBufferInheritanceInfoinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkCommandBufferInheritanceInfoinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferInheritanceInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.Deprecated.callocStack(int capacity) Deprecated.callocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.callocStack(org.lwjgl.system.MemoryStack stack) Deprecated.create()Returns a newVkCommandBufferInheritanceInfoinstance allocated withBufferUtils.create(int capacity) Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkCommandBufferInheritanceInfoinstance for the specified memory address.create(long address, int capacity) Create aVkCommandBufferInheritanceInfo.Bufferinstance at the specified memory.static @Nullable VkCommandBufferInheritanceInfocreateSafe(long address) static @Nullable VkCommandBufferInheritanceInfo.BuffercreateSafe(long address, int capacity) longcan refer to theVkFramebufferobject that theVkCommandBufferwill be rendering to if it is executed within a render pass instance.framebuffer(long value) Sets the specified value to theframebuffer()field.malloc()Returns a newVkCommandBufferInheritanceInfoinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkCommandBufferInheritanceInfoinstance allocated on the specifiedMemoryStack.Deprecated.mallocStack(int capacity) Deprecated.mallocStack(int capacity, org.lwjgl.system.MemoryStack stack) Deprecated.mallocStack(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.booleanspecifies whether the command buffer can be executed while an occlusion query is active in the primary command buffer.occlusionQueryEnable(boolean value) Sets the specified value to theocclusionQueryEnable()field.inta 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.pipelineStatistics(int value) Sets the specified value to thepipelineStatistics()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.Prepends the specifiedVkAttachmentSampleCountInfoAMDvalue to thepNextchain.Prepends the specifiedVkAttachmentSampleCountInfoNVvalue to thepNextchain.Prepends the specifiedVkCommandBufferInheritanceConditionalRenderingInfoEXTvalue to thepNextchain.Prepends the specifiedVkCommandBufferInheritanceRenderingInfovalue to thepNextchain.Prepends the specifiedVkCommandBufferInheritanceRenderingInfoKHRvalue to thepNextchain.Prepends the specifiedVkCommandBufferInheritanceRenderPassTransformInfoQCOMvalue to thepNextchain.Prepends the specifiedVkCommandBufferInheritanceViewportScissorInfoNVvalue to thepNextchain.pNext(VkExternalFormatANDROID value) Prepends the specifiedVkExternalFormatANDROIDvalue to thepNextchain.Prepends the specifiedVkMultiviewPerViewAttributesInfoNVXvalue to thepNextchain.Prepends the specifiedVkRenderingAttachmentLocationInfovalue to thepNextchain.Prepends the specifiedVkRenderingAttachmentLocationInfoKHRvalue to thepNextchain.Prepends the specifiedVkRenderingInputAttachmentIndexInfovalue to thepNextchain.Prepends the specifiedVkRenderingInputAttachmentIndexInfoKHRvalue to thepNextchain.intspecifies the query flags that can be used by an active occlusion query in the primary command buffer when this secondary command buffer is executed.queryFlags(int value) Sets the specified value to thequeryFlags()field.longaVkRenderPassobject defining which render passes theVkCommandBufferwill be compatible with and can be executed within.renderPass(long value) Sets the specified value to therenderPass()field.set(int sType, long pNext, long renderPass, int subpass, long framebuffer, boolean occlusionQueryEnable, int queryFlags, int pipelineStatistics) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.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.subpass(int value) Sets the specified value to thesubpass()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
RENDERPASS
public static final int RENDERPASSThe struct member offsets. -
SUBPASS
public static final int SUBPASSThe struct member offsets. -
FRAMEBUFFER
public static final int FRAMEBUFFERThe struct member offsets. -
OCCLUSIONQUERYENABLE
public static final int OCCLUSIONQUERYENABLEThe struct member offsets. -
QUERYFLAGS
public static final int QUERYFLAGSThe struct member offsets. -
PIPELINESTATISTICS
public static final int PIPELINESTATISTICSThe struct member offsets.
-
-
Constructor Details
-
VkCommandBufferInheritanceInfo
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 Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkCommandBufferInheritanceInfo>
-
sType
public int sType()aVkStructureTypevalue identifying 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
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFOvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkAttachmentSampleCountInfoAMDvalue to thepNextchain. -
pNext
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
Prepends the specifiedVkCommandBufferInheritanceRenderingInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkCommandBufferInheritanceRenderingInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkCommandBufferInheritanceViewportScissorInfoNVvalue to thepNextchain. -
pNext
Prepends the specifiedVkExternalFormatANDROIDvalue to thepNextchain. -
pNext
Prepends the specifiedVkMultiviewPerViewAttributesInfoNVXvalue to thepNextchain. -
pNext
Prepends the specifiedVkRenderingAttachmentLocationInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkRenderingAttachmentLocationInfoKHRvalue to thepNextchain. -
pNext
Prepends the specifiedVkRenderingInputAttachmentIndexInfovalue to thepNextchain. -
pNext
Prepends the specifiedVkRenderingInputAttachmentIndexInfoKHRvalue to thepNextchain. -
renderPass
Sets the specified value to therenderPass()field. -
subpass
Sets the specified value to thesubpass()field. -
framebuffer
Sets the specified value to theframebuffer()field. -
occlusionQueryEnable
Sets the specified value to theocclusionQueryEnable()field. -
queryFlags
Sets the specified value to thequeryFlags()field. -
pipelineStatistics
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
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkCommandBufferInheritanceInfoinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkCommandBufferInheritanceInfoinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkCommandBufferInheritanceInfoinstance allocated withBufferUtils. -
create
Returns a newVkCommandBufferInheritanceInfoinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkCommandBufferInheritanceInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkCommandBufferInheritanceInfo.Buffer createSafe(long address, int capacity) -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead. -
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.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead. -
callocStack
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
Returns a newVkCommandBufferInheritanceInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
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:
capacity- the buffer capacitystack- the stack from which to allocate
-
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:
capacity- the buffer capacitystack- the stack from which to allocate
-
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.
-