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.NativeResource
Structure specifying a dispatch indirect command.Description
The members of
VkDispatchIndirectCommand
have the same meaning as the corresponding parameters ofCmdDispatch
.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
Member documentation
x
– the number of local workgroups to dispatch in the X dimension.y
– the number of local workgroups to dispatch in the Y dimension.z
– the number of local workgroups to dispatch in the Z dimension.
Layout
struct VkDispatchIndirectCommand { uint32_t x; uint32_t y; uint32_t z; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkDispatchIndirectCommand.Buffer
An array ofVkDispatchIndirectCommand
structs.
-
Constructor Summary
Constructors Constructor Description VkDispatchIndirectCommand(java.nio.ByteBuffer container)
Creates aVkDispatchIndirectCommand
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 VkDispatchIndirectCommand
calloc()
Returns a newVkDispatchIndirectCommand
instance allocated withmemCalloc
.static VkDispatchIndirectCommand.Buffer
calloc(int capacity)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated withmemCalloc
.static VkDispatchIndirectCommand
callocStack()
Returns a newVkDispatchIndirectCommand
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDispatchIndirectCommand.Buffer
callocStack(int capacity)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDispatchIndirectCommand.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDispatchIndirectCommand
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDispatchIndirectCommand
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDispatchIndirectCommand
create()
Returns a newVkDispatchIndirectCommand
instance allocated withBufferUtils
.static VkDispatchIndirectCommand.Buffer
create(int capacity)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated withBufferUtils
.static VkDispatchIndirectCommand
create(long address)
Returns a newVkDispatchIndirectCommand
instance for the specified memory address.static VkDispatchIndirectCommand.Buffer
create(long address, int capacity)
Create aVkDispatchIndirectCommand.Buffer
instance at the specified memory.static VkDispatchIndirectCommand
createSafe(long address)
static VkDispatchIndirectCommand.Buffer
createSafe(long address, int capacity)
static VkDispatchIndirectCommand
malloc()
Returns a newVkDispatchIndirectCommand
instance allocated withmemAlloc
.static VkDispatchIndirectCommand.Buffer
malloc(int capacity)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated withmemAlloc
.static VkDispatchIndirectCommand
mallocStack()
Returns a newVkDispatchIndirectCommand
instance allocated on the thread-localMemoryStack
.static VkDispatchIndirectCommand.Buffer
mallocStack(int capacity)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the thread-localMemoryStack
.static VkDispatchIndirectCommand.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the specifiedMemoryStack
.static VkDispatchIndirectCommand
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDispatchIndirectCommand
instance allocated on the specifiedMemoryStack
.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
.VkDispatchIndirectCommand
set(int x, int y, int z)
Initializes this struct with the specified values.VkDispatchIndirectCommand
set(VkDispatchIndirectCommand src)
Copies the specified struct data to this struct.int
sizeof()
int
x()
Returns the value of thex
field.VkDispatchIndirectCommand
x(int value)
Sets the specified value to thex
field.int
y()
Returns the value of they
field.VkDispatchIndirectCommand
y(int value)
Sets the specified value to they
field.int
z()
Returns the value of thez
field.VkDispatchIndirectCommand
z(int value)
Sets the specified value to thez
field.
-
-
-
Constructor Detail
-
VkDispatchIndirectCommand
public VkDispatchIndirectCommand(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
x
public int x()
Returns the value of thex
field.
-
y
public int y()
Returns the value of they
field.
-
z
public int z()
Returns the value of thez
field.
-
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 newVkDispatchIndirectCommand
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDispatchIndirectCommand calloc()
Returns a newVkDispatchIndirectCommand
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDispatchIndirectCommand create()
Returns a newVkDispatchIndirectCommand
instance allocated withBufferUtils
.
-
create
public static VkDispatchIndirectCommand create(long address)
Returns a newVkDispatchIndirectCommand
instance for the specified memory address.
-
createSafe
@Nullable public static VkDispatchIndirectCommand createSafe(long address)
-
malloc
public static VkDispatchIndirectCommand.Buffer malloc(int capacity)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDispatchIndirectCommand.Buffer calloc(int capacity)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDispatchIndirectCommand.Buffer create(int capacity)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDispatchIndirectCommand.Buffer create(long address, int capacity)
Create aVkDispatchIndirectCommand.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkDispatchIndirectCommand.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkDispatchIndirectCommand mallocStack()
Returns a newVkDispatchIndirectCommand
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDispatchIndirectCommand callocStack()
Returns a newVkDispatchIndirectCommand
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDispatchIndirectCommand mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDispatchIndirectCommand
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDispatchIndirectCommand callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkDispatchIndirectCommand
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDispatchIndirectCommand.Buffer mallocStack(int capacity)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDispatchIndirectCommand.Buffer callocStack(int capacity)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDispatchIndirectCommand.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDispatchIndirectCommand.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-
-