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, NativeResource, Pointer
public class VkCommandBufferBeginInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContrains information about a command buffer recording.
Valid Usage
sType
must beSTRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO
pNext
must beNULL
flags
must be a valid combination ofVkCommandBufferUsageFlagBits
values- 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
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO
pNext
– reserved for use by extensionsflags
– 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 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; 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 ofVkCommandBufferBeginInfo
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 aVkCommandBufferBeginInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and 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, MemoryStack stack)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkCommandBufferBeginInfo
callocStack(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 ornull
if the address isNULL
.static VkCommandBufferBeginInfo.Buffer
create(long address, int capacity)
Create aVkCommandBufferBeginInfo.Buffer
instance at the specified memory.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, MemoryStack stack)
Returns a newVkCommandBufferBeginInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkCommandBufferBeginInfo
mallocStack(MemoryStack stack)
Returns a newVkCommandBufferBeginInfo
instance allocated on the specifiedMemoryStack
.VkCommandBufferBeginInfo
nset(long struct)
Unsafe version ofset
.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()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkCommandBufferBeginInfo
sType(int value)
Sets the specified value to thesType
field.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
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()
Description copied from class:Struct
Returns thesizeof(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
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(VkCommandBufferInheritanceInfo value)
Sets the address of the specifiedVkCommandBufferInheritanceInfo
to thepInheritanceInfo
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 ofset
.
-
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 ornull
if the address isNULL
.
-
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
-
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(MemoryStack stack)
Returns a newVkCommandBufferBeginInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkCommandBufferBeginInfo callocStack(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, 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, 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
-
-