Package org.lwjgl.vulkan
Class VkIndirectCommandsTokenNVX
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkIndirectCommandsTokenNVX
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkIndirectCommandsTokenNVX extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying parameters for the reservation of command buffer space.Valid Usage
- The
buffer
’s usage flag must have theBUFFER_USAGE_INDIRECT_BUFFER_BIT
bit set. - The
offset
must be aligned toVkDeviceGeneratedCommandsLimitsNVX
::minCommandsTokenBufferOffsetAlignment
.
Valid Usage (Implicit)
tokenType
must be a validVkIndirectCommandsTokenTypeNVX
valuebuffer
must be a validVkBuffer
handle
See Also
Member documentation
tokenType
– specifies the token command type.buffer
– specifies theVkBuffer
storing the functional arguments for each squence. These argumetns can be written by the device.offset
– specified an offset intobuffer
where the arguments start.
Layout
struct VkIndirectCommandsTokenNVX { VkIndirectCommandsTokenTypeNVX tokenType; VkBuffer buffer; VkDeviceSize offset; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkIndirectCommandsTokenNVX.Buffer
An array ofVkIndirectCommandsTokenNVX
structs.
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.
-
Constructor Summary
Constructors Constructor and Description VkIndirectCommandsTokenNVX(java.nio.ByteBuffer container)
Creates aVkIndirectCommandsTokenNVX
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 long
buffer()
Returns the value of thebuffer
field.VkIndirectCommandsTokenNVX
buffer(long value)
Sets the specified value to thebuffer
field.static VkIndirectCommandsTokenNVX
calloc()
Returns a newVkIndirectCommandsTokenNVX
instance allocated withmemCalloc
.static VkIndirectCommandsTokenNVX.Buffer
calloc(int capacity)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated withmemCalloc
.static VkIndirectCommandsTokenNVX
callocStack()
Returns a newVkIndirectCommandsTokenNVX
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkIndirectCommandsTokenNVX.Buffer
callocStack(int capacity)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkIndirectCommandsTokenNVX.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkIndirectCommandsTokenNVX
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkIndirectCommandsTokenNVX
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkIndirectCommandsTokenNVX
create()
Returns a newVkIndirectCommandsTokenNVX
instance allocated withBufferUtils
.static VkIndirectCommandsTokenNVX.Buffer
create(int capacity)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated withBufferUtils
.static VkIndirectCommandsTokenNVX
create(long address)
Returns a newVkIndirectCommandsTokenNVX
instance for the specified memory address ornull
if the address isNULL
.static VkIndirectCommandsTokenNVX.Buffer
create(long address, int capacity)
Create aVkIndirectCommandsTokenNVX.Buffer
instance at the specified memory.static VkIndirectCommandsTokenNVX
malloc()
Returns a newVkIndirectCommandsTokenNVX
instance allocated withmemAlloc
.static VkIndirectCommandsTokenNVX.Buffer
malloc(int capacity)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated withmemAlloc
.static VkIndirectCommandsTokenNVX
mallocStack()
Returns a newVkIndirectCommandsTokenNVX
instance allocated on the thread-localMemoryStack
.static VkIndirectCommandsTokenNVX.Buffer
mallocStack(int capacity)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated on the thread-localMemoryStack
.static VkIndirectCommandsTokenNVX.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated on the specifiedMemoryStack
.static VkIndirectCommandsTokenNVX
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkIndirectCommandsTokenNVX
instance allocated on the specifiedMemoryStack
.long
offset()
Returns the value of theoffset
field.VkIndirectCommandsTokenNVX
offset(long value)
Sets the specified value to theoffset
field.VkIndirectCommandsTokenNVX
set(int tokenType, long buffer, long offset)
Initializes this struct with the specified values.VkIndirectCommandsTokenNVX
set(VkIndirectCommandsTokenNVX src)
Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
tokenType()
Returns the value of thetokenType
field.VkIndirectCommandsTokenNVX
tokenType(int value)
Sets the specified value to thetokenType
field.
-
-
-
Constructor Detail
-
VkIndirectCommandsTokenNVX
public VkIndirectCommandsTokenNVX(java.nio.ByteBuffer container)
Creates aVkIndirectCommandsTokenNVX
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:org.lwjgl.system.Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
tokenType
public int tokenType()
Returns the value of thetokenType
field.
-
buffer
public long buffer()
Returns the value of thebuffer
field.
-
offset
public long offset()
Returns the value of theoffset
field.
-
tokenType
public VkIndirectCommandsTokenNVX tokenType(int value)
Sets the specified value to thetokenType
field.
-
buffer
public VkIndirectCommandsTokenNVX buffer(long value)
Sets the specified value to thebuffer
field.
-
offset
public VkIndirectCommandsTokenNVX offset(long value)
Sets the specified value to theoffset
field.
-
set
public VkIndirectCommandsTokenNVX set(int tokenType, long buffer, long offset)
Initializes this struct with the specified values.
-
set
public VkIndirectCommandsTokenNVX set(VkIndirectCommandsTokenNVX src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkIndirectCommandsTokenNVX malloc()
Returns a newVkIndirectCommandsTokenNVX
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkIndirectCommandsTokenNVX calloc()
Returns a newVkIndirectCommandsTokenNVX
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkIndirectCommandsTokenNVX create()
Returns a newVkIndirectCommandsTokenNVX
instance allocated withBufferUtils
.
-
create
public static VkIndirectCommandsTokenNVX create(long address)
Returns a newVkIndirectCommandsTokenNVX
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkIndirectCommandsTokenNVX.Buffer malloc(int capacity)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkIndirectCommandsTokenNVX.Buffer calloc(int capacity)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkIndirectCommandsTokenNVX.Buffer create(int capacity)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkIndirectCommandsTokenNVX.Buffer create(long address, int capacity)
Create aVkIndirectCommandsTokenNVX.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkIndirectCommandsTokenNVX mallocStack()
Returns a newVkIndirectCommandsTokenNVX
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkIndirectCommandsTokenNVX callocStack()
Returns a newVkIndirectCommandsTokenNVX
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkIndirectCommandsTokenNVX mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkIndirectCommandsTokenNVX
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkIndirectCommandsTokenNVX callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkIndirectCommandsTokenNVX
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkIndirectCommandsTokenNVX.Buffer mallocStack(int capacity)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkIndirectCommandsTokenNVX.Buffer callocStack(int capacity)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkIndirectCommandsTokenNVX.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkIndirectCommandsTokenNVX.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkIndirectCommandsTokenNVX.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-