Package org.lwjgl.vulkan
Class VkDispatchIndirectCommand
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkDispatchIndirectCommand
extends Struct<VkDispatchIndirectCommand>
implements NativeResource
Structure specifying a indirect dispatching command.
Description
The members of VkDispatchIndirectCommand
have the same meaning as the corresponding parameters of CmdDispatch
.
Valid Usage
x
must be less than or equal toVkPhysicalDeviceLimits
::maxComputeWorkGroupCount
[0]y
must be less than or equal toVkPhysicalDeviceLimits
::maxComputeWorkGroupCount
[1]z
must be less than or equal toVkPhysicalDeviceLimits
::maxComputeWorkGroupCount
[2]
See Also
Layout
struct VkDispatchIndirectCommand {
uint32_t x()
;
uint32_t y()
;
uint32_t z()
;
}
-
Nested Class Summary
Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct size in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkDispatchIndirectCommand
(ByteBuffer container) Creates aVkDispatchIndirectCommand
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkDispatchIndirectCommand
calloc()
Returns a newVkDispatchIndirectCommand
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkDispatchIndirectCommand.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDispatchIndirectCommand
calloc
(MemoryStack stack) Returns a newVkDispatchIndirectCommand
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDispatchIndirectCommand
Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.static VkDispatchIndirectCommand
callocStack
(MemoryStack stack) Deprecated.static VkDispatchIndirectCommand
create()
Returns a newVkDispatchIndirectCommand
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkDispatchIndirectCommand.Buffer
instance allocated withBufferUtils
.static VkDispatchIndirectCommand
create
(long address) Returns a newVkDispatchIndirectCommand
instance for the specified memory address.create
(long address, int capacity) Create aVkDispatchIndirectCommand.Buffer
instance at the specified memory.static VkDispatchIndirectCommand
createSafe
(long address) createSafe
(long address, int capacity) static VkDispatchIndirectCommand
malloc()
Returns a newVkDispatchIndirectCommand
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkDispatchIndirectCommand.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the specifiedMemoryStack
.static VkDispatchIndirectCommand
malloc
(MemoryStack stack) Returns a newVkDispatchIndirectCommand
instance allocated on the specifiedMemoryStack
.static VkDispatchIndirectCommand
Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkDispatchIndirectCommand
mallocStack
(MemoryStack stack) Deprecated.static int
nx
(long struct) Unsafe version ofx()
.static void
nx
(long struct, int value) Unsafe version ofx
.static int
ny
(long struct) Unsafe version ofy()
.static void
ny
(long struct, int value) Unsafe version ofy
.static int
nz
(long struct) Unsafe version ofz()
.static void
nz
(long struct, int value) Unsafe version ofz
.set
(int x, int y, int z) Initializes this struct with the specified values.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.int
x()
the number of local workgroups to dispatch in the X dimension.x
(int value) Sets the specified value to thex()
field.int
y()
the number of local workgroups to dispatch in the Y dimension.y
(int value) Sets the specified value to they()
field.int
z()
the number of local workgroups to dispatch in the Z dimension.z
(int value) Sets the specified value to thez()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
X
public static final int XThe struct member offsets. -
Y
public static final int YThe struct member offsets. -
Z
public static final int ZThe struct member offsets.
-
-
Constructor Details
-
VkDispatchIndirectCommand
Creates aVkDispatchIndirectCommand
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkDispatchIndirectCommand>
-
x
public int x()the number of local workgroups to dispatch in the X dimension. -
y
public int y()the number of local workgroups to dispatch in the Y dimension. -
z
public int z()the number of local workgroups to dispatch in the Z dimension. -
x
Sets the specified value to thex()
field. -
y
Sets the specified value to they()
field. -
z
Sets the specified value to thez()
field. -
set
Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkDispatchIndirectCommand
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkDispatchIndirectCommand
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkDispatchIndirectCommand
instance allocated withBufferUtils
. -
create
Returns a newVkDispatchIndirectCommand
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkDispatchIndirectCommand.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkDispatchIndirectCommand.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkDispatchIndirectCommand.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkDispatchIndirectCommand
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkDispatchIndirectCommand
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
nx
public static int nx(long struct) Unsafe version ofx()
. -
ny
public static int ny(long struct) Unsafe version ofy()
. -
nz
public static int nz(long struct) Unsafe version ofz()
. -
nx
public static void nx(long struct, int value) Unsafe version ofx
. -
ny
public static void ny(long struct, int value) Unsafe version ofy
. -
nz
public static void nz(long struct, int value) Unsafe version ofz
.
-