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
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]
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 classVkDispatchIndirectCommand.BufferAn array ofVkDispatchIndirectCommandstructs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static intSIZEOFThe 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 aVkDispatchIndirectCommandinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkDispatchIndirectCommandcalloc()Returns a newVkDispatchIndirectCommandinstance allocated withmemCalloc.static VkDispatchIndirectCommand.Buffercalloc(int capacity)Returns a newVkDispatchIndirectCommand.Bufferinstance allocated withmemCalloc.static VkDispatchIndirectCommandcallocStack()Returns a newVkDispatchIndirectCommandinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDispatchIndirectCommand.BuffercallocStack(int capacity)Returns a newVkDispatchIndirectCommand.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkDispatchIndirectCommand.BuffercallocStack(int capacity, MemoryStack stack)Returns a newVkDispatchIndirectCommand.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkDispatchIndirectCommandcallocStack(MemoryStack stack)Returns a newVkDispatchIndirectCommandinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.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 ornullif the address isNULL.static VkDispatchIndirectCommand.Buffercreate(long address, int capacity)Create aVkDispatchIndirectCommand.Bufferinstance at the specified memory.static VkDispatchIndirectCommandmalloc()Returns a newVkDispatchIndirectCommandinstance allocated withmemAlloc.static VkDispatchIndirectCommand.Buffermalloc(int capacity)Returns a newVkDispatchIndirectCommand.Bufferinstance allocated withmemAlloc.static VkDispatchIndirectCommandmallocStack()Returns a newVkDispatchIndirectCommandinstance allocated on the thread-localMemoryStack.static VkDispatchIndirectCommand.BuffermallocStack(int capacity)Returns a newVkDispatchIndirectCommand.Bufferinstance allocated on the thread-localMemoryStack.static VkDispatchIndirectCommand.BuffermallocStack(int capacity, MemoryStack stack)Returns a newVkDispatchIndirectCommand.Bufferinstance allocated on the specifiedMemoryStack.static VkDispatchIndirectCommandmallocStack(MemoryStack stack)Returns a newVkDispatchIndirectCommandinstance allocated on the specifiedMemoryStack.intsizeof()Returns thesizeof(struct).intx()Returns the value of thexfield.inty()Returns the value of theyfield.intz()Returns the value of thezfield.-
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 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()
Description copied from class:StructReturns thesizeof(struct).
-
x
public int x()
Returns the value of thexfield.
-
y
public int y()
Returns the value of theyfield.
-
z
public int z()
Returns the value of thezfield.
-
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 ornullif the address isNULL.
-
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
-
mallocStack
public static VkDispatchIndirectCommand mallocStack()
Returns a newVkDispatchIndirectCommandinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkDispatchIndirectCommand callocStack()
Returns a newVkDispatchIndirectCommandinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkDispatchIndirectCommand mallocStack(MemoryStack stack)
Returns a newVkDispatchIndirectCommandinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkDispatchIndirectCommand callocStack(MemoryStack stack)
Returns a newVkDispatchIndirectCommandinstance allocated on the specifiedMemoryStackand 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.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkDispatchIndirectCommand.Buffer callocStack(int capacity)
Returns a newVkDispatchIndirectCommand.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkDispatchIndirectCommand.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDispatchIndirectCommand.Bufferinstance 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.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
-