java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkCommandBufferBeginInfo

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkCommandBufferBeginInfo
extends Struct
```
Khronos Reference Page
Vulkan Specification
Contrains information about a command buffer recording.

Valid Usage
- sType must be STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO
- pNext must be NULL
- flags must be a valid combination of VkCommandBufferUsageFlagBits values
- If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, the renderPass member of pInheritanceInfo must be a valid VkRenderPass
- If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, the subpass member of pInheritanceInfo must be a valid subpass index within the renderPass member of pInheritanceInfo
- If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, the framebuffer member of pInheritanceInfo must be either NULL_HANDLE, or a valid VkFramebuffer that is compatible with the renderPass member of pInheritanceInfo
Member documentation
- sType – the type of this structure. Must be: STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO
- pNext – reserved for use by extensions
- flags – a combination of bitfield flags indicating usage behavior for the command buffer. One or more of:
  COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT
  COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT
  COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT
- pInheritanceInfo – a pointer to a VkCommandBufferInheritanceInfo structure, which is used if commandBuffer is a secondary command buffer. If this is a primary command buffer, then this value is ignored.
Layout
```
struct VkCommandBufferBeginInfo {
    VkStructureType sType;
    const void * pNext;
    VkCommandBufferUsageFlags flags;
    const VkCommandBufferInheritanceInfo * pInheritanceInfo;
}
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkCommandBufferBeginInfo.Buffer
An array of VkCommandBufferBeginInfo 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
`VkCommandBufferBeginInfo(java.nio.ByteBuffer container)` Creates a `VkCommandBufferBeginInfo` 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 VkCommandBufferBeginInfo`	`calloc()` Returns a new `VkCommandBufferBeginInfo` instance allocated with `memCalloc`.
`static VkCommandBufferBeginInfo.Buffer`	`calloc(int capacity)` Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated with `memCalloc`.
`static VkCommandBufferBeginInfo`	`callocStack()` Returns a new `VkCommandBufferBeginInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferBeginInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferBeginInfo.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferBeginInfo`	`callocStack(MemoryStack stack)` Returns a new `VkCommandBufferBeginInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferBeginInfo`	`create()` Returns a new `VkCommandBufferBeginInfo` instance allocated with `BufferUtils`.
`static VkCommandBufferBeginInfo.Buffer`	`create(int capacity)` Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated with `BufferUtils`.
`static VkCommandBufferBeginInfo`	`create(long address)` Returns a new `VkCommandBufferBeginInfo` instance for the specified memory address or `null` if the address is `NULL`.
`static VkCommandBufferBeginInfo.Buffer`	`create(long address, int capacity)` Create a `VkCommandBufferBeginInfo.Buffer` instance at the specified memory.
`int`	`flags()` Returns the value of the `flags` field.
`VkCommandBufferBeginInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`static VkCommandBufferBeginInfo`	`malloc()` Returns a new `VkCommandBufferBeginInfo` instance allocated with `memAlloc`.
`static VkCommandBufferBeginInfo.Buffer`	`malloc(int capacity)` Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated with `memAlloc`.
`static VkCommandBufferBeginInfo`	`mallocStack()` Returns a new `VkCommandBufferBeginInfo` instance allocated on the thread-local `MemoryStack`.
`static VkCommandBufferBeginInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkCommandBufferBeginInfo.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkCommandBufferBeginInfo`	`mallocStack(MemoryStack stack)` Returns a new `VkCommandBufferBeginInfo` instance allocated on the specified `MemoryStack`.
`VkCommandBufferBeginInfo`	`nset(long struct)` Unsafe version of `set`.
`VkCommandBufferInheritanceInfo`	`pInheritanceInfo()` Returns a `VkCommandBufferInheritanceInfo` view of the struct pointed to by the `pInheritanceInfo` field.
`VkCommandBufferBeginInfo`	`pInheritanceInfo(VkCommandBufferInheritanceInfo value)` Sets the address of the specified `VkCommandBufferInheritanceInfo` to the `pInheritanceInfo` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkCommandBufferBeginInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkCommandBufferBeginInfo`	`set(int sType, long pNext, int flags, VkCommandBufferInheritanceInfo pInheritanceInfo)` Initializes this struct with the specified values.
`VkCommandBufferBeginInfo`	`set(VkCommandBufferBeginInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`int`	`sType()` Returns the value of the `sType` field.
`VkCommandBufferBeginInfo`	`sType(int value)` Sets the specified value to the `sType` 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
  - VkCommandBufferBeginInfo
```
public VkCommandBufferBeginInfo(java.nio.ByteBuffer container)
```
    Creates a VkCommandBufferBeginInfo 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.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - pInheritanceInfo
```
public VkCommandBufferInheritanceInfo pInheritanceInfo()
```
    Returns a VkCommandBufferInheritanceInfo view of the struct pointed to by the pInheritanceInfo field.
  - sType
```
public VkCommandBufferBeginInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkCommandBufferBeginInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkCommandBufferBeginInfo flags(int value)
```
    Sets the specified value to the flags field.
  - pInheritanceInfo
```
public VkCommandBufferBeginInfo pInheritanceInfo(VkCommandBufferInheritanceInfo value)
```
    Sets the address of the specified VkCommandBufferInheritanceInfo to the pInheritanceInfo field.
  - set
```
public VkCommandBufferBeginInfo set(int sType,
                                    long pNext,
                                    int flags,
                                    VkCommandBufferInheritanceInfo pInheritanceInfo)
```
    Initializes this struct with the specified values.
  - nset
```
public VkCommandBufferBeginInfo nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkCommandBufferBeginInfo set(VkCommandBufferBeginInfo src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkCommandBufferBeginInfo malloc()
```
    Returns a new VkCommandBufferBeginInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkCommandBufferBeginInfo calloc()
```
    Returns a new VkCommandBufferBeginInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkCommandBufferBeginInfo create()
```
    Returns a new VkCommandBufferBeginInfo instance allocated with BufferUtils.
  - create
```
public static VkCommandBufferBeginInfo create(long address)
```
    Returns a new VkCommandBufferBeginInfo instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkCommandBufferBeginInfo.Buffer malloc(int capacity)
```
    Returns a new VkCommandBufferBeginInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkCommandBufferBeginInfo.Buffer calloc(int capacity)
```
    Returns a new VkCommandBufferBeginInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCommandBufferBeginInfo.Buffer create(int capacity)
```
    Returns a new VkCommandBufferBeginInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkCommandBufferBeginInfo.Buffer create(long address,
                                                     int capacity)
```
    Create a VkCommandBufferBeginInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkCommandBufferBeginInfo mallocStack()
```
    Returns a new VkCommandBufferBeginInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkCommandBufferBeginInfo callocStack()
```
    Returns a new VkCommandBufferBeginInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkCommandBufferBeginInfo mallocStack(MemoryStack stack)
```
    Returns a new VkCommandBufferBeginInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkCommandBufferBeginInfo callocStack(MemoryStack stack)
```
    Returns a new VkCommandBufferBeginInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkCommandBufferBeginInfo.Buffer mallocStack(int capacity)
```
    Returns a new VkCommandBufferBeginInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkCommandBufferBeginInfo.Buffer callocStack(int capacity)
```
    Returns a new VkCommandBufferBeginInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkCommandBufferBeginInfo.Buffer mallocStack(int capacity,
                                                          MemoryStack stack)
```
    Returns a new VkCommandBufferBeginInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkCommandBufferBeginInfo.Buffer callocStack(int capacity,
                                                          MemoryStack stack)
```
    Returns a new VkCommandBufferBeginInfo.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 VkCommandBufferBeginInfo

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

VkCommandBufferBeginInfo

Method Detail

sizeof

sType

pNext

flags

pInheritanceInfo

sType

pNext

flags

pInheritanceInfo

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack