Package org.lwjgl.vulkan

Class VkCommandBufferBeginInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkCommandBufferBeginInfo>

org.lwjgl.vulkan.VkCommandBufferBeginInfo

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkCommandBufferBeginInfo
extends org.lwjgl.system.Struct<VkCommandBufferBeginInfo>
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 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

See Also

VkCommandBufferInheritanceInfo, BeginCommandBuffer

Layout

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FLAGS	The struct member offsets.
static final int	PINHERITANCEINFO	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final 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	Description
VkCommandBufferBeginInfo(ByteBuffer container)	Creates a VkCommandBufferBeginInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	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.Buffer	calloc(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	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkCommandBufferBeginInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkCommandBufferBeginInfo	callocStack()	Deprecated.
static VkCommandBufferBeginInfo.Buffer	callocStack(int capacity)	Deprecated.
static VkCommandBufferBeginInfo.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkCommandBufferBeginInfo	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
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 @Nullable VkCommandBufferBeginInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkCommandBufferBeginInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	a bitmask of VkCommandBufferUsageFlagBits specifying usage behavior for the command buffer.
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.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkCommandBufferBeginInfo.Buffer instance allocated on the specified MemoryStack.
static VkCommandBufferBeginInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkCommandBufferBeginInfo instance allocated on the specified MemoryStack.
static VkCommandBufferBeginInfo	mallocStack()	Deprecated.
static VkCommandBufferBeginInfo.Buffer	mallocStack(int capacity)	Deprecated.
static VkCommandBufferBeginInfo.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkCommandBufferBeginInfo	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static @Nullable VkCommandBufferInheritanceInfo	npInheritanceInfo(long struct)	Unsafe version of pInheritanceInfo().
static void	npInheritanceInfo(long struct, @Nullable 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.
@Nullable VkCommandBufferInheritanceInfo	pInheritanceInfo()	a pointer to a VkCommandBufferInheritanceInfo structure, used if commandBuffer is a secondary command buffer.
VkCommandBufferBeginInfo	pInheritanceInfo(@Nullable VkCommandBufferInheritanceInfo value)	Sets the address of the specified VkCommandBufferInheritanceInfo to the pInheritanceInfo() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkCommandBufferBeginInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkCommandBufferBeginInfo	pNext(VkDeviceGroupCommandBufferBeginInfo value)	Prepends the specified VkDeviceGroupCommandBufferBeginInfo value to the pNext chain.
VkCommandBufferBeginInfo	pNext(VkDeviceGroupCommandBufferBeginInfoKHR value)	Prepends the specified VkDeviceGroupCommandBufferBeginInfoKHR value to the pNext chain.
VkCommandBufferBeginInfo	set(int sType, long pNext, int flags, @Nullable 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()	a VkStructureType value identifying this structure.
VkCommandBufferBeginInfo	sType(int value)	Sets the specified value to the sType() field.
VkCommandBufferBeginInfo	sType$Default()	Sets the STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

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 Details

VkCommandBufferBeginInfo

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkCommandBufferBeginInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

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

pInheritanceInfo

public @Nullable 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.

sType

public VkCommandBufferBeginInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkCommandBufferBeginInfo sType$Default()

Sets the STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO value to the sType() field.

pNext

public VkCommandBufferBeginInfo pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkCommandBufferBeginInfo pNext(VkDeviceGroupCommandBufferBeginInfo value)

Prepends the specified VkDeviceGroupCommandBufferBeginInfo value to the pNext chain.

pNext

public VkCommandBufferBeginInfo pNext(VkDeviceGroupCommandBufferBeginInfoKHR value)

Prepends the specified VkDeviceGroupCommandBufferBeginInfoKHR value to the pNext chain.

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

public static @Nullable 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

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkCommandBufferBeginInfo mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkCommandBufferBeginInfo callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkCommandBufferBeginInfo mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkCommandBufferBeginInfo callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkCommandBufferBeginInfo.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkCommandBufferBeginInfo.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkCommandBufferBeginInfo.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkCommandBufferBeginInfo.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkCommandBufferBeginInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkCommandBufferBeginInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkCommandBufferBeginInfo.Buffer calloc(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:

capacity - the buffer capacity

stack - the stack from which to allocate

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

public static @Nullable 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.