Structure specifying a command buffer begin operation.

Valid Usage

If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, the VkCommandPool that commandBuffer was allocated from must support graphics operations
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
If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT and the dynamicRendering feature is not enabled, the renderPass member of pInheritanceInfo must not be NULL_HANDLE
If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT and the renderPass member of pInheritanceInfo is NULL_HANDLE, the pNext chain of pInheritanceInfo must include a VkCommandBufferInheritanceRenderingInfo structure
If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT, the renderPass member of pInheritanceInfo is NULL_HANDLE, and the pNext chain of pInheritanceInfo includes a VkAttachmentSampleCountInfoAMD or VkAttachmentSampleCountInfoNV structure, the colorAttachmentCount member of that structure must be equal to the value of VkCommandBufferInheritanceRenderingInfo::colorAttachmentCount
If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT and the renderPass member of pInheritanceInfo is not NULL_HANDLE, the renderPass member of pInheritanceInfo must be a valid VkRenderPass
If flags contains COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT and the renderPass member of pInheritanceInfo is not NULL_HANDLE, the subpass member of pInheritanceInfo must be a valid subpass index within 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
The sType value of each struct in the pNext chain must be unique
flags must be a valid combination of VkCommandBufferUsageFlagBits values

Layout


struct VkCommandBufferBeginInfo {
    VkStructureType sType;
    void const * pNext;
    VkCommandBufferUsageFlags flags;
    VkCommandBufferInheritanceInfo const * pInheritanceInfo;
}

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	FLAGS The struct member offsets.
public static final int	PINHERITANCEINFO The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.

Inherited from org.lwjgl.system.Struct:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	VkCommandBufferBeginInfo(long address, ByteBuffer container)
public	VkCommandBufferBeginInfo(ByteBuffer container) Creates a `VkCommandBufferBeginInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public static VkCommandBufferBeginInfo	calloc() Returns a new `VkCommandBufferBeginInfo` instance allocated with `memCalloc`.
public static VkCommandBufferBeginInfo.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated with `memCalloc`.
public static VkCommandBufferBeginInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkCommandBufferBeginInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkCommandBufferBeginInfo.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkCommandBufferBeginInfo	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkCommandBufferBeginInfo	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkCommandBufferBeginInfo.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkCommandBufferBeginInfo.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkCommandBufferBeginInfo	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkCommandBufferBeginInfo	create() Returns a new `VkCommandBufferBeginInfo` instance allocated with `BufferUtils`.
public static VkCommandBufferBeginInfo	create(long address) Returns a new `VkCommandBufferBeginInfo` instance for the specified memory address.
public static VkCommandBufferBeginInfo.Buffer	create(int the buffer capacity capacity) Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated with `BufferUtils`.
public static VkCommandBufferBeginInfo.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkCommandBufferBeginInfo.Buffer` instance at the specified memory.
public static VkCommandBufferBeginInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkCommandBufferBeginInfo.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	flags() a bitmask of `VkCommandBufferUsageFlagBits` specifying usage behavior for the command buffer.
public VkCommandBufferBeginInfo	flags(int value) Sets the specified value to the `flags` field.
public static VkCommandBufferBeginInfo	malloc() Returns a new `VkCommandBufferBeginInfo` instance allocated with `memAlloc`.
public static VkCommandBufferBeginInfo.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated with `memAlloc`.
public static VkCommandBufferBeginInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkCommandBufferBeginInfo` instance allocated on the specified `MemoryStack`.
public static VkCommandBufferBeginInfo.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated on the specified `MemoryStack`.
public static VkCommandBufferBeginInfo	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkCommandBufferBeginInfo	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkCommandBufferBeginInfo.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkCommandBufferBeginInfo.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static VkCommandBufferInheritanceInfo	npInheritanceInfo(long struct) Unsafe version of `pInheritanceInfo`.
public static void	npInheritanceInfo(long struct, VkCommandBufferInheritanceInfo value) Unsafe version of `pInheritanceInfo`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public VkCommandBufferInheritanceInfo	pInheritanceInfo() a pointer to a `VkCommandBufferInheritanceInfo` structure, used if `commandBuffer` is a secondary command buffer.
public VkCommandBufferBeginInfo	pInheritanceInfo(VkCommandBufferInheritanceInfo value) Sets the address of the specified `VkCommandBufferInheritanceInfo` to the `pInheritanceInfo` field.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkCommandBufferBeginInfo	pNext(long value) Sets the specified value to the `pNext` field.
public VkCommandBufferBeginInfo	pNext(VkDeviceGroupCommandBufferBeginInfo value) Prepends the specified `VkDeviceGroupCommandBufferBeginInfo` value to the `pNext` chain.
public VkCommandBufferBeginInfo	pNext(VkDeviceGroupCommandBufferBeginInfoKHR value) Prepends the specified `VkDeviceGroupCommandBufferBeginInfoKHR` value to the `pNext` chain.
public VkCommandBufferBeginInfo	set(int sType, long pNext, int flags, VkCommandBufferInheritanceInfo pInheritanceInfo) Initializes this struct with the specified values.
public VkCommandBufferBeginInfo	Returns: this struct set(VkCommandBufferBeginInfo the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	sType() a `VkStructureType` value identifying this structure.
public VkCommandBufferBeginInfo	sType(int value) Sets the specified value to the `sType` field.
public VkCommandBufferBeginInfo	sType$Default() Sets the `STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO` value to the `sType` field.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

FLAGS	back to summary
public static final int FLAGS The struct member offsets.

PINHERITANCEINFO	back to summary
public static final int PINHERITANCEINFO The struct member offsets.

PNEXT	back to summary
public static final int PNEXT The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

STYPE	back to summary
public static final int STYPE The struct member offsets.

Constructor Detail

VkCommandBufferBeginInfo	back to summary
protected VkCommandBufferBeginInfo(long address, ByteBuffer container)

VkCommandBufferBeginInfo back to summary

VkCommandBufferBeginInfo	back to summary
public VkCommandBufferBeginInfo(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.

public VkCommandBufferBeginInfo(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

calloc	back to summary
public static VkCommandBufferBeginInfo calloc() Returns a new `VkCommandBufferBeginInfo` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static VkCommandBufferBeginInfo.Buffer calloc(int capacity) Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkCommandBufferBeginInfo.Buffer calloc(int capacity)

Returns a new VkCommandBufferBeginInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static VkCommandBufferBeginInfo calloc(MemoryStack stack) Returns a new `VkCommandBufferBeginInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static VkCommandBufferBeginInfo calloc(MemoryStack stack)

Returns a new VkCommandBufferBeginInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static VkCommandBufferBeginInfo.Buffer calloc(int capacity, MemoryStack stack) Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkCommandBufferBeginInfo.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkCommandBufferBeginInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

callocStack back to summary

callocStack	back to summary
public static VkCommandBufferBeginInfo callocStack() Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkCommandBufferBeginInfo callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkCommandBufferBeginInfo callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(MemoryStack)` instead. Annotations @Deprecated

public static VkCommandBufferBeginInfo callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkCommandBufferBeginInfo.Buffer callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkCommandBufferBeginInfo.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

callocStack back to summary

callocStack	back to summary
public static VkCommandBufferBeginInfo.Buffer callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `calloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkCommandBufferBeginInfo.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations

@Deprecated

create back to summary

create	back to summary
protected VkCommandBufferBeginInfo create(long address, ByteBuffer container) Implements abstract org.lwjgl.system.Struct.create. Doc from org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass. Effectively, every `Struct` instance is a factory for more instances of the same type. This is used by `StructBuffer`. Parameters address:long the struct memory address container:ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. Annotations @Override

protected VkCommandBufferBeginInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters

address:long: the struct memory address
container:ByteBuffer: an optional container buffer, to be referenced strongly by the struct instance.

Annotations

@Override

create	back to summary
public static VkCommandBufferBeginInfo create() Returns a new `VkCommandBufferBeginInfo` instance allocated with `BufferUtils`.

create	back to summary
public static VkCommandBufferBeginInfo create(long address) Returns a new `VkCommandBufferBeginInfo` instance for the specified memory address.

create back to summary

create	back to summary
public static VkCommandBufferBeginInfo.Buffer create(int capacity) Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static VkCommandBufferBeginInfo.Buffer create(int capacity)

Returns a new VkCommandBufferBeginInfo.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static VkCommandBufferBeginInfo.Buffer create(long address, int capacity) Create a `VkCommandBufferBeginInfo.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

public static VkCommandBufferBeginInfo.Buffer create(long address, int capacity)

Create a VkCommandBufferBeginInfo.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

createSafe back to summary

createSafe	back to summary
public static VkCommandBufferBeginInfo createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkCommandBufferBeginInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static VkCommandBufferBeginInfo.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static VkCommandBufferBeginInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations

@Nullable

flags back to summary

flags	back to summary
public int flags() a bitmask of `VkCommandBufferUsageFlagBits` specifying usage behavior for the command buffer. Annotations @NativeType:VkCommandBufferUsageFlags

public int flags()

a bitmask of VkCommandBufferUsageFlagBits specifying usage behavior for the command buffer.

Annotations

@NativeType:VkCommandBufferUsageFlags

flags	back to summary
public VkCommandBufferBeginInfo flags(int value) Sets the specified value to the `flags` field.

malloc	back to summary
public static VkCommandBufferBeginInfo malloc() Returns a new `VkCommandBufferBeginInfo` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static VkCommandBufferBeginInfo.Buffer malloc(int capacity) Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static VkCommandBufferBeginInfo.Buffer malloc(int capacity)

Returns a new VkCommandBufferBeginInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static VkCommandBufferBeginInfo malloc(MemoryStack stack) Returns a new `VkCommandBufferBeginInfo` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static VkCommandBufferBeginInfo malloc(MemoryStack stack)

Returns a new VkCommandBufferBeginInfo instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static VkCommandBufferBeginInfo.Buffer malloc(int capacity, MemoryStack stack) Returns a new `VkCommandBufferBeginInfo.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static VkCommandBufferBeginInfo.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkCommandBufferBeginInfo.Buffer instance allocated on the specified MemoryStack.

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

mallocStack back to summary

mallocStack	back to summary
public static VkCommandBufferBeginInfo mallocStack() Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkCommandBufferBeginInfo mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkCommandBufferBeginInfo mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(MemoryStack)` instead. Annotations @Deprecated

public static VkCommandBufferBeginInfo mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkCommandBufferBeginInfo.Buffer mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkCommandBufferBeginInfo.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

mallocStack back to summary

mallocStack	back to summary
public static VkCommandBufferBeginInfo.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0. Use `malloc(int, MemoryStack)` instead. Annotations @Deprecated

public static VkCommandBufferBeginInfo.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations

@Deprecated

nflags	back to summary
public static int nflags(long struct) Unsafe version of `flags`.

nflags	back to summary
public static void nflags(long struct, int value) Unsafe version of `flags`.

npInheritanceInfo back to summary

npInheritanceInfo	back to summary
public static VkCommandBufferInheritanceInfo npInheritanceInfo(long struct) Unsafe version of `pInheritanceInfo`. Annotations @Nullable

public static VkCommandBufferInheritanceInfo npInheritanceInfo(long struct)

Unsafe version of pInheritanceInfo.

Annotations

@Nullable

npInheritanceInfo	back to summary
public static void npInheritanceInfo(long struct, VkCommandBufferInheritanceInfo value) Unsafe version of `pInheritanceInfo`.

npNext	back to summary
public static long npNext(long struct) Unsafe version of `pNext`.

npNext	back to summary
public static void npNext(long struct, long value) Unsafe version of `pNext`.

nsType	back to summary
public static int nsType(long struct) Unsafe version of `sType`.

nsType	back to summary
public static void nsType(long struct, int value) Unsafe version of `sType`.

pInheritanceInfo back to summary

pInheritanceInfo	back to summary
public VkCommandBufferInheritanceInfo 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. Annotations @Nullable @NativeType:VkCommandBufferInheritanceInfo const *

public VkCommandBufferInheritanceInfo 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.

Annotations

@Nullable
@NativeType:VkCommandBufferInheritanceInfo const *

pInheritanceInfo	back to summary
public VkCommandBufferBeginInfo pInheritanceInfo(VkCommandBufferInheritanceInfo value) Sets the address of the specified `VkCommandBufferInheritanceInfo` to the `pInheritanceInfo` field.

pNext back to summary

pNext	back to summary
public long pNext() `NULL` or a pointer to a structure extending this structure. Annotations @NativeType:void const *

public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations

@NativeType:void const *

pNext	back to summary
public VkCommandBufferBeginInfo pNext(long value) Sets the specified value to the `pNext` field.

pNext	back to summary
public VkCommandBufferBeginInfo pNext(VkDeviceGroupCommandBufferBeginInfo value) Prepends the specified `VkDeviceGroupCommandBufferBeginInfo` value to the `pNext` chain.

pNext	back to summary
public VkCommandBufferBeginInfo pNext(VkDeviceGroupCommandBufferBeginInfoKHR value) Prepends the specified `VkDeviceGroupCommandBufferBeginInfoKHR` value to the `pNext` chain.

set	back to summary
public VkCommandBufferBeginInfo set(int sType, long pNext, int flags, VkCommandBufferInheritanceInfo pInheritanceInfo) Initializes this struct with the specified values.

set

back to summary

public VkCommandBufferBeginInfo set(VkCommandBufferBeginInfo src)

Copies the specified struct data to this struct.

Parameters

src:VkCommandBufferBeginInfo: the source struct

Returns:VkCommandBufferBeginInfo

this struct

sizeof back to summary

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

sType back to summary

public int sType()

a VkStructureType value identifying this structure.

Annotations

@NativeType:VkStructureType

sType	back to summary
public VkCommandBufferBeginInfo sType(int value) Sets the specified value to the `sType` field.

sType$Default	back to summary
public VkCommandBufferBeginInfo sType$Default() Sets the `STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO` value to the `sType` field.

org.lwjgl.vulkan back to summary

public Class VkCommandBufferBeginInfo.Buffer

Class Inheritance

extends StructBuffer<VkCommandBufferBeginInfo, VkCommandBufferBeginInfo.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.vulkan.VkCommandBufferBeginInfo.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkCommandBufferBeginInfo structs.

Field Summary

Modifier and Type	Field and Description
private static final VkCommandBufferBeginInfo	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `VkCommandBufferBeginInfo.Buffer` instance backed by the specified container.
public	Buffer(long address, int cap)
pack-priv	Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and Type	Method and Description
public int	Returns: the value of the `VkCommandBufferBeginInfo#flags` field. flags()
public VkCommandBufferBeginInfo.Buffer	flags(int value) Sets the specified value to the `VkCommandBufferBeginInfo#flags` field.
protected VkCommandBufferBeginInfo	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public VkCommandBufferInheritanceInfo	Returns: a `VkCommandBufferInheritanceInfo` view of the struct pointed to by the `VkCommandBufferBeginInfo#pInheritanceInfo` field. pInheritanceInfo()
public VkCommandBufferBeginInfo.Buffer	pInheritanceInfo(VkCommandBufferInheritanceInfo value) Sets the address of the specified `VkCommandBufferInheritanceInfo` to the `VkCommandBufferBeginInfo#pInheritanceInfo` field.
public long	Returns: the value of the `VkCommandBufferBeginInfo#pNext` field. pNext()
public VkCommandBufferBeginInfo.Buffer	pNext(long value) Sets the specified value to the `VkCommandBufferBeginInfo#pNext` field.
public VkCommandBufferBeginInfo.Buffer	pNext(VkDeviceGroupCommandBufferBeginInfo value) Prepends the specified `VkDeviceGroupCommandBufferBeginInfo` value to the `pNext` chain.
public VkCommandBufferBeginInfo.Buffer	pNext(VkDeviceGroupCommandBufferBeginInfoKHR value) Prepends the specified `VkDeviceGroupCommandBufferBeginInfoKHR` value to the `pNext` chain.
protected VkCommandBufferBeginInfo.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `VkCommandBufferBeginInfo#sType` field. sType()
public VkCommandBufferBeginInfo.Buffer	sType(int value) Sets the specified value to the `VkCommandBufferBeginInfo#sType` field.
public VkCommandBufferBeginInfo.Buffer	sType$Default() Sets the `STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO` value to the `VkCommandBufferBeginInfo#sType` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final VkCommandBufferBeginInfo ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new VkCommandBufferBeginInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkCommandBufferBeginInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

flags	back to summary
public int flags() Returns:int the value of the `VkCommandBufferBeginInfo#flags` field. Annotations @NativeType:VkCommandBufferUsageFlags

flags	back to summary
public VkCommandBufferBeginInfo.Buffer flags(int value) Sets the specified value to the `VkCommandBufferBeginInfo#flags` field.

getElementFactory

back to summary

protected VkCommandBufferBeginInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations

@Override

pInheritanceInfo	back to summary
public VkCommandBufferInheritanceInfo pInheritanceInfo() Returns:VkCommandBufferInheritanceInfo a `VkCommandBufferInheritanceInfo` view of the struct pointed to by the `VkCommandBufferBeginInfo#pInheritanceInfo` field. Annotations @Nullable @NativeType:VkCommandBufferInheritanceInfo const *

pInheritanceInfo	back to summary
public VkCommandBufferBeginInfo.Buffer pInheritanceInfo(VkCommandBufferInheritanceInfo value) Sets the address of the specified `VkCommandBufferInheritanceInfo` to the `VkCommandBufferBeginInfo#pInheritanceInfo` field.

pNext	back to summary
public long pNext() Returns:long the value of the `VkCommandBufferBeginInfo#pNext` field. Annotations @NativeType:void const *

pNext	back to summary
public VkCommandBufferBeginInfo.Buffer pNext(long value) Sets the specified value to the `VkCommandBufferBeginInfo#pNext` field.

pNext	back to summary
public VkCommandBufferBeginInfo.Buffer pNext(VkDeviceGroupCommandBufferBeginInfo value) Prepends the specified `VkDeviceGroupCommandBufferBeginInfo` value to the `pNext` chain.

pNext	back to summary
public VkCommandBufferBeginInfo.Buffer pNext(VkDeviceGroupCommandBufferBeginInfoKHR value) Prepends the specified `VkDeviceGroupCommandBufferBeginInfoKHR` value to the `pNext` chain.

self

back to summary

protected VkCommandBufferBeginInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations

@Override

sType	back to summary
public int sType() Returns:int the value of the `VkCommandBufferBeginInfo#sType` field. Annotations @NativeType:VkStructureType

sType	back to summary
public VkCommandBufferBeginInfo.Buffer sType(int value) Sets the specified value to the `VkCommandBufferBeginInfo#sType` field.

sType$Default	back to summary
public VkCommandBufferBeginInfo.Buffer sType$Default() Sets the `STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO` value to the `VkCommandBufferBeginInfo#sType` field.

public Class VkCommandBufferBeginInfo

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class VkCommandBufferBeginInfo.Buffer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail