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, NativeResource, Pointer
public class VkCommandBufferInheritanceInfo extends Struct
Khronos Reference Page
Vulkan SpecificationDefines any state that will be inherited from a primary command buffer to a secondary command buffer.
Valid Usage
sType
must beSTRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO
pNext
must beNULL
- Each of
renderPass
andframebuffer
that are valid handles must have been created, allocated or retrieved from the sameVkDevice
- 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 pipeline statistics queries feature is not enabled,
pipelineStatistics
must be 0
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO
pNext
– reserved for use by extensionsrenderPass
– aVkRenderPass
object that must be compatible with the one that is bound when theVkCommandBuffer
is executed if the command buffer was allocated with theCOMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT
setsubpass
– the index of the subpass withinrenderPass
that theVkCommandBuffer
will be rendering against if it was allocated with theCOMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT
setframebuffer
– refers to theVkFramebuffer
object that theVkCommandBuffer
will be rendering to if it was allocated with theCOMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT
set. It can beNULL_HANDLE
if the framebuffer is not known.occlusionQueryEnable
– indicates whether the command buffer can be executed while an occlusion query is active in the primary command bufferqueryFlags
– indicates the query flags that can be used by an active occlusion query in the primary command buffer when this secondary command buffer is executed. One or more of:QUERY_CONTROL_PRECISE_BIT
pipelineStatistics
– indicates 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. One or more of:
Layout
struct VkCommandBufferInheritanceInfo { VkStructureType sType; const void * pNext; VkRenderPass renderPass; uint32_t subpass; VkFramebuffer framebuffer; VkBool32 occlusionQueryEnable; VkQueryControlFlags queryFlags; VkQueryPipelineStatisticFlags pipelineStatistics; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkCommandBufferInheritanceInfo.Buffer
An array ofVkCommandBufferInheritanceInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and 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 and 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, MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCommandBufferInheritanceInfo
callocStack(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 ornull
if the address isNULL
.static VkCommandBufferInheritanceInfo.Buffer
create(long address, int capacity)
Create aVkCommandBufferInheritanceInfo.Buffer
instance at the specified memory.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, MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkCommandBufferInheritanceInfo
mallocStack(MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfo
instance allocated on the specifiedMemoryStack
.VkCommandBufferInheritanceInfo
nset(long struct)
Unsafe version ofset
.int
occlusionQueryEnable()
Returns the value of theocclusionQueryEnable
field.VkCommandBufferInheritanceInfo
occlusionQueryEnable(int 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, int 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()
Returns thesizeof(struct)
.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.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
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()
Description copied from class:Struct
Returns thesizeof(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 int 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(int 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, int occlusionQueryEnable, int queryFlags, int pipelineStatistics)
Initializes this struct with the specified values.
-
nset
public VkCommandBufferInheritanceInfo nset(long struct)
Unsafe version ofset
.
-
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 ornull
if the address isNULL
.
-
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
-
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(MemoryStack stack)
Returns a newVkCommandBufferInheritanceInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkCommandBufferInheritanceInfo callocStack(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, 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, 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
-
-