Package org.lwjgl.vulkan
Class VkDispatchIndirectCommand
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDispatchIndirectCommand
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkDispatchIndirectCommand extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying a indirect dispatching command.Description
The members of
VkDispatchIndirectCommandhave the same meaning as the corresponding parameters ofCmdDispatch.Valid Usage
xmust be less than or equal toVkPhysicalDeviceLimits::maxComputeWorkGroupCount[0]ymust be less than or equal toVkPhysicalDeviceLimits::maxComputeWorkGroupCount[1]zmust be less than or equal toVkPhysicalDeviceLimits::maxComputeWorkGroupCount[2]
See Also
Layout
struct VkDispatchIndirectCommand { uint32_tx(); uint32_ty(); uint32_tz(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkDispatchIndirectCommand.BufferAn array ofVkDispatchIndirectCommandstructs.
-
Constructor Summary
Constructors Constructor Description VkDispatchIndirectCommand(java.nio.ByteBuffer container)Creates aVkDispatchIndirectCommandinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static VkDispatchIndirectCommandcalloc()Returns a newVkDispatchIndirectCommandinstance allocated withmemCalloc.static VkDispatchIndirectCommand.Buffercalloc(int capacity)Returns a newVkDispatchIndirectCommand.Bufferinstance allocated withmemCalloc.static VkDispatchIndirectCommand.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDispatchIndirectCommand.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDispatchIndirectCommandcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDispatchIndirectCommandinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDispatchIndirectCommandcallocStack()Deprecated.static VkDispatchIndirectCommand.BuffercallocStack(int capacity)Deprecated.static VkDispatchIndirectCommand.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkDispatchIndirectCommandcallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkDispatchIndirectCommandcreate()Returns a newVkDispatchIndirectCommandinstance allocated withBufferUtils.static VkDispatchIndirectCommand.Buffercreate(int capacity)Returns a newVkDispatchIndirectCommand.Bufferinstance allocated withBufferUtils.static VkDispatchIndirectCommandcreate(long address)Returns a newVkDispatchIndirectCommandinstance for the specified memory address.static VkDispatchIndirectCommand.Buffercreate(long address, int capacity)Create aVkDispatchIndirectCommand.Bufferinstance at the specified memory.static VkDispatchIndirectCommandcreateSafe(long address)static VkDispatchIndirectCommand.BuffercreateSafe(long address, int capacity)static VkDispatchIndirectCommandmalloc()Returns a newVkDispatchIndirectCommandinstance allocated withmemAlloc.static VkDispatchIndirectCommand.Buffermalloc(int capacity)Returns a newVkDispatchIndirectCommand.Bufferinstance allocated withmemAlloc.static VkDispatchIndirectCommand.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkDispatchIndirectCommand.Bufferinstance allocated on the specifiedMemoryStack.static VkDispatchIndirectCommandmalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkDispatchIndirectCommandinstance allocated on the specifiedMemoryStack.static VkDispatchIndirectCommandmallocStack()Deprecated.static VkDispatchIndirectCommand.BuffermallocStack(int capacity)Deprecated.static VkDispatchIndirectCommand.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkDispatchIndirectCommandmallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static intnx(long struct)Unsafe version ofx().static voidnx(long struct, int value)Unsafe version ofx.static intny(long struct)Unsafe version ofy().static voidny(long struct, int value)Unsafe version ofy.static intnz(long struct)Unsafe version ofz().static voidnz(long struct, int value)Unsafe version ofz.VkDispatchIndirectCommandset(int x, int y, int z)Initializes this struct with the specified values.VkDispatchIndirectCommandset(VkDispatchIndirectCommand src)Copies the specified struct data to this struct.intsizeof()intx()the number of local workgroups to dispatch in the X dimension.VkDispatchIndirectCommandx(int value)Sets the specified value to thex()field.inty()the number of local workgroups to dispatch in the Y dimension.VkDispatchIndirectCommandy(int value)Sets the specified value to they()field.intz()the number of local workgroups to dispatch in the Z dimension.VkDispatchIndirectCommandz(int value)Sets the specified value to thez()field.
-
-
-
Constructor Detail
-
VkDispatchIndirectCommand
public VkDispatchIndirectCommand(java.nio.ByteBuffer container)
Creates aVkDispatchIndirectCommandinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct
-
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
public VkDispatchIndirectCommand x(int value)
Sets the specified value to thex()field.
-
y
public VkDispatchIndirectCommand y(int value)
Sets the specified value to they()field.
-
z
public VkDispatchIndirectCommand z(int value)
Sets the specified value to thez()field.
-
set
public VkDispatchIndirectCommand set(int x, int y, int z)
Initializes this struct with the specified values.
-
set
public VkDispatchIndirectCommand set(VkDispatchIndirectCommand src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkDispatchIndirectCommand malloc()
Returns a newVkDispatchIndirectCommandinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkDispatchIndirectCommand calloc()
Returns a newVkDispatchIndirectCommandinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkDispatchIndirectCommand create()
Returns a newVkDispatchIndirectCommandinstance allocated withBufferUtils.
-
create
public static VkDispatchIndirectCommand create(long address)
Returns a newVkDispatchIndirectCommandinstance for the specified memory address.
-
createSafe
@Nullable public static VkDispatchIndirectCommand createSafe(long address)
-
malloc
public static VkDispatchIndirectCommand.Buffer malloc(int capacity)
Returns a newVkDispatchIndirectCommand.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkDispatchIndirectCommand.Buffer calloc(int capacity)
Returns a newVkDispatchIndirectCommand.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkDispatchIndirectCommand.Buffer create(int capacity)
Returns a newVkDispatchIndirectCommand.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkDispatchIndirectCommand.Buffer create(long address, int capacity)
Create aVkDispatchIndirectCommand.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkDispatchIndirectCommand.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkDispatchIndirectCommand mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkDispatchIndirectCommand callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDispatchIndirectCommand mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkDispatchIndirectCommand callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDispatchIndirectCommand.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkDispatchIndirectCommand.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkDispatchIndirectCommand.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkDispatchIndirectCommand.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkDispatchIndirectCommand malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDispatchIndirectCommandinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkDispatchIndirectCommand calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkDispatchIndirectCommandinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkDispatchIndirectCommand.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDispatchIndirectCommand.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkDispatchIndirectCommand.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDispatchIndirectCommand.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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.
-
-