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.NativeResource
Structure specifying command buffer inheritance info.Valid Usage
- If the inherited queries feature is not enabled,
occlusionQueryEnable
must beFALSE
- If the inherited queries feature is enabled,
queryFlags
must be a valid combination ofVkQueryControlFlagBits
values - If the inherited queries feature is not enabled,
queryFlags
must be 0 - If the pipeline statistics queries feature is enabled,
pipelineStatistics
must be a valid combination ofVkQueryPipelineStatisticFlagBits
values - If the pipeline statistics queries feature is not enabled,
pipelineStatistics
must be 0
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO
pNext
must beNULL
or a pointer to a valid instance ofVkCommandBufferInheritanceConditionalRenderingInfoEXT
- Both of
framebuffer
, andrenderPass
that are valid handles must have been created, allocated, or retrieved from the sameVkDevice
See Also
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.renderPass
– aVkRenderPass
object defining which render passes theVkCommandBuffer
will be compatible with and can be executed within. If theVkCommandBuffer
will not be executed within a render pass instance,renderPass
is ignored.subpass
– the index of the subpass within the render pass instance that theVkCommandBuffer
will be executed within. If theVkCommandBuffer
will not be executed within a render pass instance,subpass
is ignored.framebuffer
– optionally refers to theVkFramebuffer
object that theVkCommandBuffer
will be rendering to if it is executed within a render pass instance. It can beNULL_HANDLE
if the framebuffer is not known, or if theVkCommandBuffer
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 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_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 theQUERY_CONTROL_PRECISE_BIT
bit.pipelineStatistics
– a bitmask ofVkQueryPipelineStatisticFlagBits
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; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkCommandBufferInheritanceInfo.Buffer
An array ofVkCommandBufferInheritanceInfo
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
FRAMEBUFFER
OCCLUSIONQUERYENABLE
PIPELINESTATISTICS
PNEXT
QUERYFLAGS
RENDERPASSThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
SUBPASSThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkCommandBufferInheritanceInfo(java.nio.ByteBuffer container)
Creates aVkCommandBufferInheritanceInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkCommandBufferInheritanceInfo
calloc()
Returns a newVkCommandBufferInheritanceInfo
instance allocated withmemCalloc
.static VkCommandBufferInheritanceInfo.Buffer
calloc(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated withmemCalloc
.static VkCommandBufferInheritanceInfo
callocStack()
Returns a newVkCommandBufferInheritanceInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkCommandBufferInheritanceInfo.Buffer
callocStack(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkCommandBufferInheritanceInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCommandBufferInheritanceInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCommandBufferInheritanceInfo
create()
Returns a newVkCommandBufferInheritanceInfo
instance allocated withBufferUtils
.static VkCommandBufferInheritanceInfo.Buffer
create(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated withBufferUtils
.static VkCommandBufferInheritanceInfo
create(long address)
Returns a newVkCommandBufferInheritanceInfo
instance for the specified memory address.static VkCommandBufferInheritanceInfo.Buffer
create(long address, int capacity)
Create aVkCommandBufferInheritanceInfo.Buffer
instance at the specified memory.static VkCommandBufferInheritanceInfo
createSafe(long address)
static VkCommandBufferInheritanceInfo.Buffer
createSafe(long address, int capacity)
long
framebuffer()
Returns the value of theframebuffer
field.VkCommandBufferInheritanceInfo
framebuffer(long value)
Sets the specified value to theframebuffer
field.static VkCommandBufferInheritanceInfo
malloc()
Returns a newVkCommandBufferInheritanceInfo
instance allocated withmemAlloc
.static VkCommandBufferInheritanceInfo.Buffer
malloc(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated withmemAlloc
.static VkCommandBufferInheritanceInfo
mallocStack()
Returns a newVkCommandBufferInheritanceInfo
instance allocated on the thread-localMemoryStack
.static VkCommandBufferInheritanceInfo.Buffer
mallocStack(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkCommandBufferInheritanceInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkCommandBufferInheritanceInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfo
instance allocated on the specifiedMemoryStack
.static long
nframebuffer(long struct)
Unsafe version offramebuffer()
.static void
nframebuffer(long struct, long value)
Unsafe version offramebuffer
.static int
nocclusionQueryEnable(long struct)
Unsafe version ofocclusionQueryEnable()
.static void
nocclusionQueryEnable(long struct, int value)
Unsafe version ofocclusionQueryEnable
.static int
npipelineStatistics(long struct)
Unsafe version ofpipelineStatistics()
.static void
npipelineStatistics(long struct, int value)
Unsafe version ofpipelineStatistics
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nqueryFlags(long struct)
Unsafe version ofqueryFlags()
.static void
nqueryFlags(long struct, int value)
Unsafe version ofqueryFlags
.static long
nrenderPass(long struct)
Unsafe version ofrenderPass()
.static void
nrenderPass(long struct, long value)
Unsafe version ofrenderPass
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static int
nsubpass(long struct)
Unsafe version ofsubpass()
.static void
nsubpass(long struct, int value)
Unsafe version ofsubpass
.boolean
occlusionQueryEnable()
Returns the value of theocclusionQueryEnable
field.VkCommandBufferInheritanceInfo
occlusionQueryEnable(boolean value)
Sets the specified value to theocclusionQueryEnable
field.int
pipelineStatistics()
Returns the value of thepipelineStatistics
field.VkCommandBufferInheritanceInfo
pipelineStatistics(int value)
Sets the specified value to thepipelineStatistics
field.long
pNext()
Returns the value of thepNext
field.VkCommandBufferInheritanceInfo
pNext(long value)
Sets the specified value to thepNext
field.int
queryFlags()
Returns the value of thequeryFlags
field.VkCommandBufferInheritanceInfo
queryFlags(int value)
Sets the specified value to thequeryFlags
field.long
renderPass()
Returns the value of therenderPass
field.VkCommandBufferInheritanceInfo
renderPass(long value)
Sets the specified value to therenderPass
field.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.VkCommandBufferInheritanceInfo
set(VkCommandBufferInheritanceInfo src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkCommandBufferInheritanceInfo
sType(int value)
Sets the specified value to thesType
field.int
subpass()
Returns the value of thesubpass
field.VkCommandBufferInheritanceInfo
subpass(int value)
Sets the specified value to thesubpass
field.
-
-
-
Constructor Detail
-
VkCommandBufferInheritanceInfo
public VkCommandBufferInheritanceInfo(java.nio.ByteBuffer container)
Creates aVkCommandBufferInheritanceInfo
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
renderPass
public long renderPass()
Returns the value of therenderPass
field.
-
subpass
public int subpass()
Returns the value of thesubpass
field.
-
framebuffer
public long framebuffer()
Returns the value of theframebuffer
field.
-
occlusionQueryEnable
public boolean occlusionQueryEnable()
Returns the value of theocclusionQueryEnable
field.
-
queryFlags
public int queryFlags()
Returns the value of thequeryFlags
field.
-
pipelineStatistics
public int pipelineStatistics()
Returns the value of thepipelineStatistics
field.
-
sType
public VkCommandBufferInheritanceInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkCommandBufferInheritanceInfo pNext(long value)
Sets the specified value to thepNext
field.
-
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 newVkCommandBufferInheritanceInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkCommandBufferInheritanceInfo calloc()
Returns a newVkCommandBufferInheritanceInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkCommandBufferInheritanceInfo create()
Returns a newVkCommandBufferInheritanceInfo
instance allocated withBufferUtils
.
-
create
public static VkCommandBufferInheritanceInfo create(long address)
Returns a newVkCommandBufferInheritanceInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkCommandBufferInheritanceInfo createSafe(long address)
-
malloc
public static VkCommandBufferInheritanceInfo.Buffer malloc(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkCommandBufferInheritanceInfo.Buffer calloc(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkCommandBufferInheritanceInfo.Buffer create(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkCommandBufferInheritanceInfo.Buffer create(long address, int capacity)
Create aVkCommandBufferInheritanceInfo.Buffer
instance 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 newVkCommandBufferInheritanceInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkCommandBufferInheritanceInfo callocStack()
Returns a newVkCommandBufferInheritanceInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkCommandBufferInheritanceInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkCommandBufferInheritanceInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfo
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkCommandBufferInheritanceInfo.Buffer callocStack(int capacity)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated on the thread-localMemoryStack
and 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.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-
-