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, NativeResource, Pointer
public class VkDispatchIndirectCommand extends Struct
Khronos Reference Page
Vulkan SpecificationDescribes an indirect dispatch command.
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]
Member documentation
x
– the number of local workgroups to dispatch in the X dimensiony
– the number of local workgroups to dispatch in the Y dimensionz
– 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 and Description static class
VkDispatchIndirectCommand.Buffer
An array ofVkDispatchIndirectCommand
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 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 and 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, MemoryStack stack)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDispatchIndirectCommand
callocStack(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 ornull
if the address isNULL
.static VkDispatchIndirectCommand.Buffer
create(long address, int capacity)
Create aVkDispatchIndirectCommand.Buffer
instance at the specified memory.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, MemoryStack stack)
Returns a newVkDispatchIndirectCommand.Buffer
instance allocated on the specifiedMemoryStack
.static VkDispatchIndirectCommand
mallocStack(MemoryStack stack)
Returns a newVkDispatchIndirectCommand
instance allocated on the specifiedMemoryStack
.int
sizeof()
Returns thesizeof(struct)
.int
x()
Returns the value of thex
field.int
y()
Returns the value of they
field.int
z()
Returns the value of thez
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
-
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()
Description copied from class:Struct
Returns thesizeof(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.
-
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 ornull
if the address isNULL
.
-
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
-
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(MemoryStack stack)
Returns a newVkDispatchIndirectCommand
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDispatchIndirectCommand callocStack(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, 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, 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
-
-