Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDispatchIndirectCommand

extends Struct<VkDispatchIndirectCommand>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying a indirect dispatching command.
Description

The members of VkDispatchIndirectCommand have the same meaning as the corresponding parameters of CmdDispatch.

Valid Usage
See Also

CmdDispatchIndirect

Layout


struct VkDispatchIndirectCommand {
    uint32_t x;
    uint32_t y;
    uint32_t z;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkDispatchIndirectCommand.Buffer

An array of VkDispatchIndirectCommand structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
SIZEOF

The struct size in bytes.

public static final int
X

The struct member offsets.

public static final int
Y

The struct member offsets.

public static final int
Z

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkDispatchIndirectCommand(long address, ByteBuffer container)

public
VkDispatchIndirectCommand(ByteBuffer container)

Creates a VkDispatchIndirectCommand instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkDispatchIndirectCommand
calloc()

Returns a new VkDispatchIndirectCommand instance allocated with memCalloc.

public static VkDispatchIndirectCommand.Buffer
calloc(int
the buffer capacity
capacity)

Returns a new VkDispatchIndirectCommand.Buffer instance allocated with memCalloc.

public static VkDispatchIndirectCommand
calloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkDispatchIndirectCommand instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkDispatchIndirectCommand.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkDispatchIndirectCommand.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkDispatchIndirectCommand
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDispatchIndirectCommand
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDispatchIndirectCommand.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDispatchIndirectCommand.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkDispatchIndirectCommand
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkDispatchIndirectCommand
create()

Returns a new VkDispatchIndirectCommand instance allocated with BufferUtils.

public static VkDispatchIndirectCommand
create(long address)

Returns a new VkDispatchIndirectCommand instance for the specified memory address.

public static VkDispatchIndirectCommand.Buffer
create(int
the buffer capacity
capacity)

Returns a new VkDispatchIndirectCommand.Buffer instance allocated with BufferUtils.

public static VkDispatchIndirectCommand.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Create a VkDispatchIndirectCommand.Buffer instance at the specified memory.

public static VkDispatchIndirectCommand
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkDispatchIndirectCommand.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkDispatchIndirectCommand
malloc()

Returns a new VkDispatchIndirectCommand instance allocated with memAlloc.

public static VkDispatchIndirectCommand.Buffer
malloc(int
the buffer capacity
capacity)

Returns a new VkDispatchIndirectCommand.Buffer instance allocated with memAlloc.

public static VkDispatchIndirectCommand
malloc(MemoryStack
the stack from which to allocate
stack)

Returns a new VkDispatchIndirectCommand instance allocated on the specified MemoryStack.

public static VkDispatchIndirectCommand.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Returns a new VkDispatchIndirectCommand.Buffer instance allocated on the specified MemoryStack.

public static VkDispatchIndirectCommand
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkDispatchIndirectCommand
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDispatchIndirectCommand.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkDispatchIndirectCommand.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static int
nx(long struct)

Unsafe version of x.

public static void
nx(long struct, int value)

Unsafe version of x.

public static int
ny(long struct)

Unsafe version of y.

public static void
ny(long struct, int value)

Unsafe version of y.

public static int
nz(long struct)

Unsafe version of z.

public static void
nz(long struct, int value)

Unsafe version of z.

public VkDispatchIndirectCommand
set(int x, int y, int z)

Initializes this struct with the specified values.

public VkDispatchIndirectCommand

Returns:

this struct
set(VkDispatchIndirectCommand
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
x()

the number of local workgroups to dispatch in the X dimension.

public VkDispatchIndirectCommand
x(int value)

Sets the specified value to the x field.

public int
y()

the number of local workgroups to dispatch in the Y dimension.

public VkDispatchIndirectCommand
y(int value)

Sets the specified value to the y field.

public int
z()

the number of local workgroups to dispatch in the Z dimension.

public VkDispatchIndirectCommand
z(int value)

Sets the specified value to the z field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Xback to summary
public static final int X

The struct member offsets.

Yback to summary
public static final int Y

The struct member offsets.

Zback to summary
public static final int Z

The struct member offsets.

Constructor Detail

VkDispatchIndirectCommandback to summary
protected VkDispatchIndirectCommand(long address, ByteBuffer container)
VkDispatchIndirectCommandback to summary
public VkDispatchIndirectCommand(ByteBuffer container)

Creates a VkDispatchIndirectCommand instance at the current position of the specified ByteBuffer 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

callocback to summary
public static VkDispatchIndirectCommand calloc()

Returns a new VkDispatchIndirectCommand instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkDispatchIndirectCommand.Buffer calloc(int capacity)

Returns a new VkDispatchIndirectCommand.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDispatchIndirectCommand calloc(MemoryStack stack)

Returns a new VkDispatchIndirectCommand instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkDispatchIndirectCommand.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkDispatchIndirectCommand.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkDispatchIndirectCommand callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkDispatchIndirectCommand callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkDispatchIndirectCommand.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkDispatchIndirectCommand.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkDispatchIndirectCommand create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkDispatchIndirectCommand create()

Returns a new VkDispatchIndirectCommand instance allocated with BufferUtils.

createback to summary
public static VkDispatchIndirectCommand create(long address)

Returns a new VkDispatchIndirectCommand instance for the specified memory address.

createback to summary
public static VkDispatchIndirectCommand.Buffer create(int capacity)

Returns a new VkDispatchIndirectCommand.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkDispatchIndirectCommand.Buffer create(long address, int capacity)

Create a VkDispatchIndirectCommand.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDispatchIndirectCommand createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkDispatchIndirectCommand.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkDispatchIndirectCommand malloc()

Returns a new VkDispatchIndirectCommand instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkDispatchIndirectCommand.Buffer malloc(int capacity)

Returns a new VkDispatchIndirectCommand.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDispatchIndirectCommand malloc(MemoryStack stack)

Returns a new VkDispatchIndirectCommand instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkDispatchIndirectCommand.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkDispatchIndirectCommand.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkDispatchIndirectCommand mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkDispatchIndirectCommand mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkDispatchIndirectCommand.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkDispatchIndirectCommand.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nxback to summary
public static int nx(long struct)

Unsafe version of x.

nxback to summary
public static void nx(long struct, int value)

Unsafe version of x.

nyback to summary
public static int ny(long struct)

Unsafe version of y.

nyback to summary
public static void ny(long struct, int value)

Unsafe version of y.

nzback to summary
public static int nz(long struct)

Unsafe version of z.

nzback to summary
public static void nz(long struct, int value)

Unsafe version of z.

setback to summary
public VkDispatchIndirectCommand set(int x, int y, int z)

Initializes this struct with the specified values.

setback to summary
public VkDispatchIndirectCommand set(VkDispatchIndirectCommand src)

Copies the specified struct data to this struct.

Parameters
src:VkDispatchIndirectCommand

the source struct

Returns:VkDispatchIndirectCommand

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
xback to summary
public int x()

the number of local workgroups to dispatch in the X dimension.

Annotations
@NativeType:uint32_t
xback to summary
public VkDispatchIndirectCommand x(int value)

Sets the specified value to the x field.

yback to summary
public int y()

the number of local workgroups to dispatch in the Y dimension.

Annotations
@NativeType:uint32_t
yback to summary
public VkDispatchIndirectCommand y(int value)

Sets the specified value to the y field.

zback to summary
public int z()

the number of local workgroups to dispatch in the Z dimension.

Annotations
@NativeType:uint32_t
zback to summary
public VkDispatchIndirectCommand z(int value)

Sets the specified value to the z field.

org.lwjgl.vulkan back to summary

public Class VkDispatchIndirectCommand.Buffer

extends StructBuffer<VkDispatchIndirectCommand, VkDispatchIndirectCommand.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkDispatchIndirectCommand structs.

Field Summary

Modifier and TypeField and Description
private static final VkDispatchIndirectCommand
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDispatchIndirectCommand.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
protected VkDispatchIndirectCommand
getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

protected VkDispatchIndirectCommand.Buffer
self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

public int

Returns:

the value of the VkDispatchIndirectCommand#x field.
x()

public VkDispatchIndirectCommand.Buffer
x(int value)

Sets the specified value to the VkDispatchIndirectCommand#x field.

public int

Returns:

the value of the VkDispatchIndirectCommand#y field.
y()

public VkDispatchIndirectCommand.Buffer
y(int value)

Sets the specified value to the VkDispatchIndirectCommand#y field.

public int

Returns:

the value of the VkDispatchIndirectCommand#z field.
z()

public VkDispatchIndirectCommand.Buffer
z(int value)

Sets the specified value to the VkDispatchIndirectCommand#z field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDispatchIndirectCommand ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDispatchIndirectCommand.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkDispatchIndirectCommand#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

getElementFactoryback to summary
protected VkDispatchIndirectCommand getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
selfback to summary
protected VkDispatchIndirectCommand.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
xback to summary
public int x()
Returns:int

the value of the VkDispatchIndirectCommand#x field.

Annotations
@NativeType:uint32_t
xback to summary
public VkDispatchIndirectCommand.Buffer x(int value)

Sets the specified value to the VkDispatchIndirectCommand#x field.

yback to summary
public int y()
Returns:int

the value of the VkDispatchIndirectCommand#y field.

Annotations
@NativeType:uint32_t
yback to summary
public VkDispatchIndirectCommand.Buffer y(int value)

Sets the specified value to the VkDispatchIndirectCommand#y field.

zback to summary
public int z()
Returns:int

the value of the VkDispatchIndirectCommand#z field.

Annotations
@NativeType:uint32_t
zback to summary
public VkDispatchIndirectCommand.Buffer z(int value)

Sets the specified value to the VkDispatchIndirectCommand#z field.