Package org.lwjgl.vulkan
Class VkCommandBufferBeginInfo
- 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
containsCOMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT
, therenderPass
member ofpInheritanceInfo
must be a validVkRenderPass
- If
flags
containsCOMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT
, thesubpass
member ofpInheritanceInfo
must be a valid subpass index within therenderPass
member ofpInheritanceInfo
- If
flags
containsCOMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT
, theframebuffer
member ofpInheritanceInfo
must be eitherNULL_HANDLE
, or a validVkFramebuffer
that is compatible with therenderPass
member ofpInheritanceInfo
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO
pNext
must beNULL
or a pointer to a valid instance ofVkDeviceGroupCommandBufferBeginInfo
flags
must be a valid combination ofVkCommandBufferUsageFlagBits
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 ofVkCommandBufferUsageFlagBits
specifying usage behavior for the command buffer.pInheritanceInfo
– a pointer to aVkCommandBufferInheritanceInfo
structure, which is used ifcommandBuffer
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 Description static class
VkCommandBufferBeginInfo.Buffer
An array ofVkCommandBufferBeginInfo
structs.
-
Constructor Summary
Constructors Constructor Description VkCommandBufferBeginInfo(java.nio.ByteBuffer container)
Creates aVkCommandBufferBeginInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkCommandBufferBeginInfo
calloc()
Returns a newVkCommandBufferBeginInfo
instance allocated withmemCalloc
.static VkCommandBufferBeginInfo.Buffer
calloc(int capacity)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated withmemCalloc
.static VkCommandBufferBeginInfo
callocStack()
Returns a newVkCommandBufferBeginInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkCommandBufferBeginInfo.Buffer
callocStack(int capacity)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkCommandBufferBeginInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCommandBufferBeginInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferBeginInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCommandBufferBeginInfo
create()
Returns a newVkCommandBufferBeginInfo
instance allocated withBufferUtils
.static VkCommandBufferBeginInfo.Buffer
create(int capacity)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated withBufferUtils
.static VkCommandBufferBeginInfo
create(long address)
Returns a newVkCommandBufferBeginInfo
instance for the specified memory address.static VkCommandBufferBeginInfo.Buffer
create(long address, int capacity)
Create aVkCommandBufferBeginInfo.Buffer
instance at the specified memory.static VkCommandBufferBeginInfo
createSafe(long address)
static VkCommandBufferBeginInfo.Buffer
createSafe(long address, int capacity)
int
flags()
Returns the value of theflags
field.VkCommandBufferBeginInfo
flags(int value)
Sets the specified value to theflags
field.static VkCommandBufferBeginInfo
malloc()
Returns a newVkCommandBufferBeginInfo
instance allocated withmemAlloc
.static VkCommandBufferBeginInfo.Buffer
malloc(int capacity)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated withmemAlloc
.static VkCommandBufferBeginInfo
mallocStack()
Returns a newVkCommandBufferBeginInfo
instance allocated on the thread-localMemoryStack
.static VkCommandBufferBeginInfo.Buffer
mallocStack(int capacity)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkCommandBufferBeginInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkCommandBufferBeginInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferBeginInfo
instance allocated on the specifiedMemoryStack
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static VkCommandBufferInheritanceInfo
npInheritanceInfo(long struct)
Unsafe version ofpInheritanceInfo()
.static void
npInheritanceInfo(long struct, VkCommandBufferInheritanceInfo value)
Unsafe version ofpInheritanceInfo
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.VkCommandBufferInheritanceInfo
pInheritanceInfo()
Returns aVkCommandBufferInheritanceInfo
view of the struct pointed to by thepInheritanceInfo
field.VkCommandBufferBeginInfo
pInheritanceInfo(VkCommandBufferInheritanceInfo value)
Sets the address of the specifiedVkCommandBufferInheritanceInfo
to thepInheritanceInfo
field.long
pNext()
Returns the value of thepNext
field.VkCommandBufferBeginInfo
pNext(long value)
Sets the specified value to thepNext
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 thesType
field.VkCommandBufferBeginInfo
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkCommandBufferBeginInfo
public VkCommandBufferBeginInfo(java.nio.ByteBuffer container)
Creates aVkCommandBufferBeginInfo
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
pInheritanceInfo
@Nullable public VkCommandBufferInheritanceInfo pInheritanceInfo()
Returns aVkCommandBufferInheritanceInfo
view of the struct pointed to by thepInheritanceInfo
field.
-
sType
public VkCommandBufferBeginInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkCommandBufferBeginInfo pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkCommandBufferBeginInfo flags(int value)
Sets the specified value to theflags
field.
-
pInheritanceInfo
public VkCommandBufferBeginInfo pInheritanceInfo(@Nullable VkCommandBufferInheritanceInfo value)
Sets the address of the specifiedVkCommandBufferInheritanceInfo
to thepInheritanceInfo
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 newVkCommandBufferBeginInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkCommandBufferBeginInfo calloc()
Returns a newVkCommandBufferBeginInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkCommandBufferBeginInfo create()
Returns a newVkCommandBufferBeginInfo
instance allocated withBufferUtils
.
-
create
public static VkCommandBufferBeginInfo create(long address)
Returns a newVkCommandBufferBeginInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkCommandBufferBeginInfo createSafe(long address)
-
malloc
public static VkCommandBufferBeginInfo.Buffer malloc(int capacity)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkCommandBufferBeginInfo.Buffer calloc(int capacity)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkCommandBufferBeginInfo.Buffer create(int capacity)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkCommandBufferBeginInfo.Buffer create(long address, int capacity)
Create aVkCommandBufferBeginInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkCommandBufferBeginInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkCommandBufferBeginInfo mallocStack()
Returns a newVkCommandBufferBeginInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkCommandBufferBeginInfo callocStack()
Returns a newVkCommandBufferBeginInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkCommandBufferBeginInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferBeginInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkCommandBufferBeginInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferBeginInfo
instance allocated on the specifiedMemoryStack
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 newVkCommandBufferBeginInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkCommandBufferBeginInfo.Buffer callocStack(int capacity)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated on the thread-localMemoryStack
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 newVkCommandBufferBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkCommandBufferBeginInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
nflags
public static int nflags(long struct)
Unsafe version offlags()
.
-
npInheritanceInfo
@Nullable public static VkCommandBufferInheritanceInfo npInheritanceInfo(long struct)
Unsafe version ofpInheritanceInfo()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nflags
public static void nflags(long struct, int value)
Unsafe version offlags
.
-
npInheritanceInfo
public static void npInheritanceInfo(long struct, @Nullable VkCommandBufferInheritanceInfo value)
Unsafe version ofpInheritanceInfo
.
-
-