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 Specification

Defines any state that will be inherited from a primary command buffer to a secondary command buffer.

Valid Usage

sType must be STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO
pNext must be NULL
Each of renderPass and framebuffer that are valid handles must have been created, allocated or retrieved from the same VkDevice
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 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 extensions
renderPass – a VkRenderPass object that must be compatible with the one that is bound when the VkCommandBuffer is executed if the command buffer was allocated with the COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT set
subpass – the index of the subpass within renderPass that the VkCommandBuffer will be rendering against if it was allocated with the COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT set
framebuffer – refers to the VkFramebuffer object that the VkCommandBuffer will be rendering to if it was allocated with the COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT set. It can be NULL_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 buffer
queryFlags – 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:

QUERY_PIPELINE_STATISTIC_CLIPPING_INVOCATIONS_BIT

QUERY_PIPELINE_STATISTIC_CLIPPING_PRIMITIVES_BIT

QUERY_PIPELINE_STATISTIC_COMPUTE_SHADER_INVOCATIONS_BIT

QUERY_PIPELINE_STATISTIC_FRAGMENT_SHADER_INVOCATIONS_BIT

QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_INVOCATIONS_BIT

QUERY_PIPELINE_STATISTIC_GEOMETRY_SHADER_PRIMITIVES_BIT

QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_PRIMITIVES_BIT

QUERY_PIPELINE_STATISTIC_INPUT_ASSEMBLY_VERTICES_BIT

QUERY_PIPELINE_STATISTIC_TESSELLATION_CONTROL_SHADER_PATCHES_BIT

QUERY_PIPELINE_STATISTIC_TESSELLATION_EVALUATION_SHADER_INVOCATIONS_BIT

QUERY_PIPELINE_STATISTIC_VERTEX_SHADER_INVOCATIONS_BIT

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 of VkCommandBufferInheritanceInfo 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 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, MemoryStack stack)` Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferInheritanceInfo`	`callocStack(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 or `null` if the address is `NULL`.
`static VkCommandBufferInheritanceInfo.Buffer`	`create(long address, int capacity)` Create a `VkCommandBufferInheritanceInfo.Buffer` instance at the specified memory.
`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, MemoryStack stack)` Returns a new `VkCommandBufferInheritanceInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkCommandBufferInheritanceInfo`	`mallocStack(MemoryStack stack)` Returns a new `VkCommandBufferInheritanceInfo` instance allocated on the specified `MemoryStack`.
`VkCommandBufferInheritanceInfo`	`nset(long struct)` Unsafe version of `set`.
`int`	`occlusionQueryEnable()` Returns the value of the `occlusionQueryEnable` field.
`VkCommandBufferInheritanceInfo`	`occlusionQueryEnable(int 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, 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 the `sizeof(struct)`.
`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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- 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()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class 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 int 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(int 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,
                                          int occlusionQueryEnable,
                                          int queryFlags,
                                          int pipelineStatistics)
```
    Initializes this struct with the specified values.
  - nset
```
public VkCommandBufferInheritanceInfo nset(long struct)
```
    Unsafe version of set.
  - 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 or null if the 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
  - 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(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(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,
                                                                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,
                                                                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

Class VkCommandBufferInheritanceInfo

Valid Usage

Member documentation

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

Constructor Detail

VkCommandBufferInheritanceInfo

Method Detail

sizeof

sType

pNext

renderPass

subpass

framebuffer

occlusionQueryEnable

queryFlags

pipelineStatistics

sType

pNext

renderPass

subpass

framebuffer

occlusionQueryEnable

queryFlags

pipelineStatistics

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack