VkCommandBufferInheritanceInfo (LWJGL 3.2.4 SNAPSHOT

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 be FALSE
- If the inherited queries feature is enabled, queryFlags must be a valid combination of VkQueryControlFlagBits 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 of VkQueryPipelineStatisticFlagBits values
- If the pipeline statistics queries feature is not enabled, pipelineStatistics must be 0
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO
- pNext must be NULL or a pointer to a valid instance of VkCommandBufferInheritanceConditionalRenderingInfoEXT
- Both of framebuffer, and renderPass that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice
See Also

VkCommandBufferBeginInfo

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- renderPass – a VkRenderPass object defining which render passes the VkCommandBuffer will be compatible with and can be executed within. If the VkCommandBuffer will not be executed within a render pass instance, renderPass is ignored.
- subpass – the index of the subpass within the render pass instance that the VkCommandBuffer will be executed within. If the VkCommandBuffer will not be executed within a render pass instance, subpass is ignored.
- framebuffer – optionally refers to the VkFramebuffer object that the VkCommandBuffer will be rendering to if it is executed within a render pass instance. It can be NULL_HANDLE if the framebuffer is not known, or if the VkCommandBuffer 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 is TRUE, then this command buffer can be executed whether the primary command buffer has an occlusion query active or not. If this is FALSE, 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 the QUERY_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 the QUERY_CONTROL_PRECISE_BIT bit.
- pipelineStatistics – a bitmask of VkQueryPipelineStatisticFlagBits 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 and Description

static class VkCommandBufferInheritanceInfo.Buffer
An array of VkCommandBufferInheritanceInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkCommandBufferInheritanceInfo.Buffer` An array of `VkCommandBufferInheritanceInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FRAMEBUFFER` The struct member offsets.
`static int`	`OCCLUSIONQUERYENABLE` The struct member offsets.
`static int`	`PIPELINESTATISTICS` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`QUERYFLAGS` The struct member offsets.
`static int`	`RENDERPASS` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.
`static int`	`SUBPASS` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkCommandBufferInheritanceInfo(java.nio.ByteBuffer container)` Creates a `VkCommandBufferInheritanceInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkCommandBufferInheritanceInfo`	`calloc()` Returns a new `VkCommandBufferInheritanceInfo` instance allocated with `memCalloc`.
`static VkCommandBufferInheritanceInfo.Buffer`	`calloc(int capacity)` Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated with `memCalloc`.
`static VkCommandBufferInheritanceInfo`	`callocStack()` Returns a new `VkCommandBufferInheritanceInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferInheritanceInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferInheritanceInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferInheritanceInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandBufferInheritanceInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferInheritanceInfo`	`create()` Returns a new `VkCommandBufferInheritanceInfo` instance allocated with `BufferUtils`.
`static VkCommandBufferInheritanceInfo.Buffer`	`create(int capacity)` Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated with `BufferUtils`.
`static VkCommandBufferInheritanceInfo`	`create(long address)` Returns a new `VkCommandBufferInheritanceInfo` instance for the specified memory address.
`static VkCommandBufferInheritanceInfo.Buffer`	`create(long address, int capacity)` Create a `VkCommandBufferInheritanceInfo.Buffer` instance at the specified memory.
`static VkCommandBufferInheritanceInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkCommandBufferInheritanceInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`long`	`framebuffer()` Returns the value of the `framebuffer` field.
`VkCommandBufferInheritanceInfo`	`framebuffer(long value)` Sets the specified value to the `framebuffer` field.
`static VkCommandBufferInheritanceInfo`	`malloc()` Returns a new `VkCommandBufferInheritanceInfo` instance allocated with `memAlloc`.
`static VkCommandBufferInheritanceInfo.Buffer`	`malloc(int capacity)` Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated with `memAlloc`.
`static VkCommandBufferInheritanceInfo`	`mallocStack()` Returns a new `VkCommandBufferInheritanceInfo` instance allocated on the thread-local `MemoryStack`.
`static VkCommandBufferInheritanceInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkCommandBufferInheritanceInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkCommandBufferInheritanceInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandBufferInheritanceInfo` instance allocated on the specified `MemoryStack`.
`static long`	`nframebuffer(long struct)` Unsafe version of `framebuffer()`.
`static void`	`nframebuffer(long struct, long value)` Unsafe version of `framebuffer`.
`static int`	`nocclusionQueryEnable(long struct)` Unsafe version of `occlusionQueryEnable()`.
`static void`	`nocclusionQueryEnable(long struct, int value)` Unsafe version of `occlusionQueryEnable`.
`static int`	`npipelineStatistics(long struct)` Unsafe version of `pipelineStatistics()`.
`static void`	`npipelineStatistics(long struct, int value)` Unsafe version of `pipelineStatistics`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nqueryFlags(long struct)` Unsafe version of `queryFlags()`.
`static void`	`nqueryFlags(long struct, int value)` Unsafe version of `queryFlags`.
`static long`	`nrenderPass(long struct)` Unsafe version of `renderPass()`.
`static void`	`nrenderPass(long struct, long value)` Unsafe version of `renderPass`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`static int`	`nsubpass(long struct)` Unsafe version of `subpass()`.
`static void`	`nsubpass(long struct, int value)` Unsafe version of `subpass`.
`boolean`	`occlusionQueryEnable()` Returns the value of the `occlusionQueryEnable` field.
`VkCommandBufferInheritanceInfo`	`occlusionQueryEnable(boolean value)` Sets the specified value to the `occlusionQueryEnable` field.
`int`	`pipelineStatistics()` Returns the value of the `pipelineStatistics` field.
`VkCommandBufferInheritanceInfo`	`pipelineStatistics(int value)` Sets the specified value to the `pipelineStatistics` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkCommandBufferInheritanceInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`int`	`queryFlags()` Returns the value of the `queryFlags` field.
`VkCommandBufferInheritanceInfo`	`queryFlags(int value)` Sets the specified value to the `queryFlags` field.
`long`	`renderPass()` Returns the value of the `renderPass` field.
`VkCommandBufferInheritanceInfo`	`renderPass(long value)` Sets the specified value to the `renderPass` 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 the `sType` field.
`VkCommandBufferInheritanceInfo`	`sType(int value)` Sets the specified value to the `sType` field.
`int`	`subpass()` Returns the value of the `subpass` field.
`VkCommandBufferInheritanceInfo`	`subpass(int value)` Sets the specified value to the `subpass` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - STYPE
```
public static final int STYPE
```
    The struct member offsets.
  - PNEXT
```
public static final int PNEXT
```
    The struct member offsets.
  - RENDERPASS
```
public static final int RENDERPASS
```
    The struct member offsets.
  - SUBPASS
```
public static final int SUBPASS
```
    The struct member offsets.
  - FRAMEBUFFER
```
public static final int FRAMEBUFFER
```
    The struct member offsets.
  - OCCLUSIONQUERYENABLE
```
public static final int OCCLUSIONQUERYENABLE
```
    The struct member offsets.
  - QUERYFLAGS
```
public static final int QUERYFLAGS
```
    The struct member offsets.
  - PIPELINESTATISTICS
```
public static final int PIPELINESTATISTICS
```
    The struct member offsets.
- Constructor Detail
  - VkCommandBufferInheritanceInfo
```
public VkCommandBufferInheritanceInfo(java.nio.ByteBuffer container)
```
    Creates a VkCommandBufferInheritanceInfo instance at the current position of the specified ByteBuffer 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 class org.lwjgl.system.Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - renderPass
```
public long renderPass()
```
    Returns the value of the renderPass field.
  - subpass
```
public int subpass()
```
    Returns the value of the subpass field.
  - framebuffer
```
public long framebuffer()
```
    Returns the value of the framebuffer field.
  - occlusionQueryEnable
```
public boolean occlusionQueryEnable()
```
    Returns the value of the occlusionQueryEnable field.
  - queryFlags
```
public int queryFlags()
```
    Returns the value of the queryFlags field.
  - pipelineStatistics
```
public int pipelineStatistics()
```
    Returns the value of the pipelineStatistics field.
  - sType
```
public VkCommandBufferInheritanceInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkCommandBufferInheritanceInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - renderPass
```
public VkCommandBufferInheritanceInfo renderPass(long value)
```
    Sets the specified value to the renderPass field.
  - subpass
```
public VkCommandBufferInheritanceInfo subpass(int value)
```
    Sets the specified value to the subpass field.
  - framebuffer
```
public VkCommandBufferInheritanceInfo framebuffer(long value)
```
    Sets the specified value to the framebuffer field.
  - occlusionQueryEnable
```
public VkCommandBufferInheritanceInfo occlusionQueryEnable(boolean value)
```
    Sets the specified value to the occlusionQueryEnable field.
  - queryFlags
```
public VkCommandBufferInheritanceInfo queryFlags(int value)
```
    Sets the specified value to the queryFlags field.
  - pipelineStatistics
```
public VkCommandBufferInheritanceInfo pipelineStatistics(int value)
```
    Sets the specified value to the pipelineStatistics 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 new VkCommandBufferInheritanceInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkCommandBufferInheritanceInfo calloc()
```
    Returns a new VkCommandBufferInheritanceInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkCommandBufferInheritanceInfo create()
```
    Returns a new VkCommandBufferInheritanceInfo instance allocated with BufferUtils.
  - create
```
public static VkCommandBufferInheritanceInfo create(long address)
```
    Returns a new VkCommandBufferInheritanceInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static VkCommandBufferInheritanceInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static VkCommandBufferInheritanceInfo.Buffer malloc(int capacity)
```
    Returns a new VkCommandBufferInheritanceInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkCommandBufferInheritanceInfo.Buffer calloc(int capacity)
```
    Returns a new VkCommandBufferInheritanceInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCommandBufferInheritanceInfo.Buffer create(int capacity)
```
    Returns a new VkCommandBufferInheritanceInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCommandBufferInheritanceInfo.Buffer create(long address,
                                                           int capacity)
```
    Create a VkCommandBufferInheritanceInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static VkCommandBufferInheritanceInfo.Buffer createSafe(long address,
                                                                         int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static VkCommandBufferInheritanceInfo mallocStack()
```
    Returns a new VkCommandBufferInheritanceInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkCommandBufferInheritanceInfo callocStack()
```
    Returns a new VkCommandBufferInheritanceInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkCommandBufferInheritanceInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCommandBufferInheritanceInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkCommandBufferInheritanceInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCommandBufferInheritanceInfo instance allocated on the specified MemoryStack 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 new VkCommandBufferInheritanceInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkCommandBufferInheritanceInfo.Buffer callocStack(int capacity)
```
    Returns a new VkCommandBufferInheritanceInfo.Buffer instance allocated on the thread-local MemoryStack 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 new VkCommandBufferInheritanceInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkCommandBufferInheritanceInfo.Buffer callocStack(int capacity,
                                                                org.lwjgl.system.MemoryStack stack)
```
    Returns a new VkCommandBufferInheritanceInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nrenderPass
```
public static long nrenderPass(long struct)
```
    Unsafe version of renderPass().
  - nsubpass
```
public static int nsubpass(long struct)
```
    Unsafe version of subpass().
  - nframebuffer
```
public static long nframebuffer(long struct)
```
    Unsafe version of framebuffer().
  - nocclusionQueryEnable
```
public static int nocclusionQueryEnable(long struct)
```
    Unsafe version of occlusionQueryEnable().
  - nqueryFlags
```
public static int nqueryFlags(long struct)
```
    Unsafe version of queryFlags().
  - npipelineStatistics
```
public static int npipelineStatistics(long struct)
```
    Unsafe version of pipelineStatistics().
  - nsType
```
public static void nsType(long struct,
                          int value)
```
    Unsafe version of sType.
  - npNext
```
public static void npNext(long struct,
                          long value)
```
    Unsafe version of pNext.
  - nrenderPass
```
public static void nrenderPass(long struct,
                               long value)
```
    Unsafe version of renderPass.
  - nsubpass
```
public static void nsubpass(long struct,
                            int value)
```
    Unsafe version of subpass.
  - nframebuffer
```
public static void nframebuffer(long struct,
                                long value)
```
    Unsafe version of framebuffer.
  - nocclusionQueryEnable
```
public static void nocclusionQueryEnable(long struct,
                                         int value)
```
    Unsafe version of occlusionQueryEnable.
  - nqueryFlags
```
public static void nqueryFlags(long struct,
                               int value)
```
    Unsafe version of queryFlags.
  - npipelineStatistics
```
public static void npipelineStatistics(long struct,
                                       int value)
```
    Unsafe version of pipelineStatistics.

Class VkCommandBufferInheritanceInfo

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Note

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

RENDERPASS

SUBPASS

FRAMEBUFFER

OCCLUSIONQUERYENABLE

QUERYFLAGS

PIPELINESTATISTICS

Constructor Detail

VkCommandBufferInheritanceInfo

Method Detail

sizeof

sType

pNext

renderPass

subpass

framebuffer

occlusionQueryEnable

queryFlags

pipelineStatistics

sType

pNext

renderPass

subpass

framebuffer

occlusionQueryEnable

queryFlags

pipelineStatistics

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nrenderPass

nsubpass

nframebuffer

nocclusionQueryEnable

nqueryFlags

npipelineStatistics

nsType

npNext

nrenderPass

nsubpass