VkCommandBufferBeginInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkCommandBufferBeginInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying a command buffer begin operation.
Valid Usage
- 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
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO
- pNext must be NULL or a pointer to a valid instance of VkDeviceGroupCommandBufferBeginInfo
- flags must be a valid combination of VkCommandBufferUsageFlagBits values
See Also

VkCommandBufferInheritanceInfo, BeginCommandBuffer

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – a bitmask of VkCommandBufferUsageFlagBits specifying usage behavior for the command buffer.
- pInheritanceInfo – a pointer to a VkCommandBufferInheritanceInfo structure, 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;
     void const * pNext;
     VkCommandBufferUsageFlags flags;
     VkCommandBufferInheritanceInfo const * 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
  org.lwjgl.system.Pointer.Default

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

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FLAGS` The struct member offsets.
`static int`	`PINHERITANCEINFO` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` 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
`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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkCommandBufferBeginInfo`	`callocStack(org.lwjgl.system.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.
`static VkCommandBufferBeginInfo.Buffer`	`create(long address, int capacity)` Create a `VkCommandBufferBeginInfo.Buffer` instance at the specified memory.
`static VkCommandBufferBeginInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkCommandBufferBeginInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkCommandBufferBeginInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkCommandBufferBeginInfo` instance allocated on the specified `MemoryStack`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static VkCommandBufferInheritanceInfo`	`npInheritanceInfo(long struct)` Unsafe version of `pInheritanceInfo()`.
`static void`	`npInheritanceInfo(long struct, VkCommandBufferInheritanceInfo value)` Unsafe version of `pInheritanceInfo`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`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()`
`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, 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.
  - FLAGS
```
public static final int FLAGS
```
    The struct member offsets.
  - PINHERITANCEINFO
```
public static final int PINHERITANCEINFO
```
    The struct member offsets.
- 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()
```
    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.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - pInheritanceInfo
```
@Nullable
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(@Nullable
                                                 VkCommandBufferInheritanceInfo value)
```
    Sets the address of the specified VkCommandBufferInheritanceInfo to the pInheritanceInfo field.
  - set
```
public VkCommandBufferBeginInfo set(int sType,
                                    long pNext,
                                    int flags,
                                    @Nullable
                                    VkCommandBufferInheritanceInfo pInheritanceInfo)
```
    Initializes this struct with the specified values.
  - 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.
  - createSafe
```
@Nullable
public static VkCommandBufferBeginInfo createSafe(long address)
```
    Like create, but returns null if 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
  - createSafe
```
@Nullable
public static VkCommandBufferBeginInfo.Buffer createSafe(long address,
                                                                   int capacity)
```
    Like create, but returns null if address is NULL.
  - 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(org.lwjgl.system.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(org.lwjgl.system.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,
                                                          org.lwjgl.system.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,
                                                          org.lwjgl.system.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
  - nsType
```
public static int nsType(long struct)
```
    Unsafe version of sType().
  - npNext
```
public static long npNext(long struct)
```
    Unsafe version of pNext().
  - nflags
```
public static int nflags(long struct)
```
    Unsafe version of flags().
  - npInheritanceInfo
```
@Nullable
public static VkCommandBufferInheritanceInfo npInheritanceInfo(long struct)
```
    Unsafe version of pInheritanceInfo().
  - 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.
  - nflags
```
public static void nflags(long struct,
                          int value)
```
    Unsafe version of flags.
  - npInheritanceInfo
```
public static void npInheritanceInfo(long struct,
                                     @Nullable
                                     VkCommandBufferInheritanceInfo value)
```
    Unsafe version of pInheritanceInfo.

Class VkCommandBufferBeginInfo

Valid Usage

Valid Usage (Implicit)

See Also

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

ALIGNOF

STYPE

PNEXT

FLAGS

PINHERITANCEINFO

Constructor Detail

VkCommandBufferBeginInfo

Method Detail

sizeof

sType

pNext

flags

pInheritanceInfo

sType

pNext

flags

pInheritanceInfo

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

npInheritanceInfo

nsType

npNext

nflags

npInheritanceInfo