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 info.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_INFOpNextmust beNULLor a pointer to a valid instance ofVkCommandBufferInheritanceConditionalRenderingInfoEXT- Both of
framebuffer, andrenderPassthat are valid handles must have been created, allocated, or retrieved from the sameVkDevice
See Also
Member documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.renderPass– aVkRenderPassobject defining which render passes theVkCommandBufferwill be compatible with and can be executed within. If theVkCommandBufferwill not be executed within a render pass instance,renderPassis ignored.subpass– the index of the subpass within the render pass instance that theVkCommandBufferwill be executed within. If theVkCommandBufferwill not be executed within a render pass instance,subpassis ignored.framebuffer– optionally refers 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, or if theVkCommandBufferwill 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 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– 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– 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.
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 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 Modifier and Type Method Description static VkCommandBufferInheritanceInfocalloc()Returns a newVkCommandBufferInheritanceInfoinstance allocated withmemCalloc.static VkCommandBufferInheritanceInfo.Buffercalloc(int capacity)Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withmemCalloc.static VkCommandBufferInheritanceInfocallocStack()Returns a newVkCommandBufferInheritanceInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkCommandBufferInheritanceInfo.BuffercallocStack(int capacity)Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkCommandBufferInheritanceInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkCommandBufferInheritanceInfocallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkCommandBufferInheritanceInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.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()Returns the value of theframebufferfield.VkCommandBufferInheritanceInfoframebuffer(long value)Sets the specified value to theframebufferfield.static VkCommandBufferInheritanceInfomalloc()Returns a newVkCommandBufferInheritanceInfoinstance allocated withmemAlloc.static VkCommandBufferInheritanceInfo.Buffermalloc(int capacity)Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated withmemAlloc.static VkCommandBufferInheritanceInfomallocStack()Returns a newVkCommandBufferInheritanceInfoinstance allocated on the thread-localMemoryStack.static VkCommandBufferInheritanceInfo.BuffermallocStack(int capacity)Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkCommandBufferInheritanceInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkCommandBufferInheritanceInfomallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkCommandBufferInheritanceInfoinstance allocated on the specifiedMemoryStack.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()Returns the value of theocclusionQueryEnablefield.VkCommandBufferInheritanceInfoocclusionQueryEnable(boolean value)Sets the specified value to theocclusionQueryEnablefield.intpipelineStatistics()Returns the value of thepipelineStatisticsfield.VkCommandBufferInheritanceInfopipelineStatistics(int value)Sets the specified value to thepipelineStatisticsfield.longpNext()Returns the value of thepNextfield.VkCommandBufferInheritanceInfopNext(long value)Sets the specified value to thepNextfield.intqueryFlags()Returns the value of thequeryFlagsfield.VkCommandBufferInheritanceInfoqueryFlags(int value)Sets the specified value to thequeryFlagsfield.longrenderPass()Returns the value of therenderPassfield.VkCommandBufferInheritanceInforenderPass(long value)Sets the specified value to therenderPassfield.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()Returns the value of thesTypefield.VkCommandBufferInheritanceInfosType(int value)Sets the specified value to thesTypefield.intsubpass()Returns the value of thesubpassfield.VkCommandBufferInheritanceInfosubpass(int value)Sets the specified value to thesubpassfield.
-
-
-
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()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
renderPass
public long renderPass()
Returns the value of therenderPassfield.
-
subpass
public int subpass()
Returns the value of thesubpassfield.
-
framebuffer
public long framebuffer()
Returns the value of theframebufferfield.
-
occlusionQueryEnable
public boolean occlusionQueryEnable()
Returns the value of theocclusionQueryEnablefield.
-
queryFlags
public int queryFlags()
Returns the value of thequeryFlagsfield.
-
pipelineStatistics
public int pipelineStatistics()
Returns the value of thepipelineStatisticsfield.
-
sType
public VkCommandBufferInheritanceInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkCommandBufferInheritanceInfo pNext(long value)
Sets the specified value to thepNextfield.
-
renderPass
public VkCommandBufferInheritanceInfo renderPass(long value)
Sets the specified value to therenderPassfield.
-
subpass
public VkCommandBufferInheritanceInfo subpass(int value)
Sets the specified value to thesubpassfield.
-
framebuffer
public VkCommandBufferInheritanceInfo framebuffer(long value)
Sets the specified value to theframebufferfield.
-
occlusionQueryEnable
public VkCommandBufferInheritanceInfo occlusionQueryEnable(boolean value)
Sets the specified value to theocclusionQueryEnablefield.
-
queryFlags
public VkCommandBufferInheritanceInfo queryFlags(int value)
Sets the specified value to thequeryFlagsfield.
-
pipelineStatistics
public VkCommandBufferInheritanceInfo pipelineStatistics(int value)
Sets the specified value to thepipelineStatisticsfield.
-
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
public static VkCommandBufferInheritanceInfo mallocStack()
Returns a newVkCommandBufferInheritanceInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkCommandBufferInheritanceInfo callocStack()
Returns a newVkCommandBufferInheritanceInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkCommandBufferInheritanceInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkCommandBufferInheritanceInfo callocStack(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
-
mallocStack
public static VkCommandBufferInheritanceInfo.Buffer mallocStack(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkCommandBufferInheritanceInfo.Buffer callocStack(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkCommandBufferInheritanceInfo.Buffer mallocStack(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
-
callocStack
public static VkCommandBufferInheritanceInfo.Buffer callocStack(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.
-
-