Package org.lwjgl.vulkan

Class VkDispatchIndirectCommand

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDispatchIndirectCommand>

org.lwjgl.vulkan.VkDispatchIndirectCommand

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkDispatchIndirectCommand
extends org.lwjgl.system.Struct<VkDispatchIndirectCommand>
implements org.lwjgl.system.NativeResource

Structure specifying an indirect dispatching command.

Description

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

Valid Usage

• x must be less than or equal to VkPhysicalDeviceLimits::maxComputeWorkGroupCount[0]
• y must be less than or equal to VkPhysicalDeviceLimits::maxComputeWorkGroupCount[1]
• z must be less than or equal to VkPhysicalDeviceLimits::maxComputeWorkGroupCount[2]

See Also

CmdDispatchIndirect

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 of VkDispatchIndirectCommand structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	SIZEOF	The struct size in bytes.
static final int	X	The struct member offsets.
static final int	Y	The struct member offsets.
static final int	Z	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkDispatchIndirectCommand(ByteBuffer container)	Creates a VkDispatchIndirectCommand instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDispatchIndirectCommand	calloc()	Returns a new VkDispatchIndirectCommand instance allocated with memCalloc.
static VkDispatchIndirectCommand.Buffer	calloc(int capacity)	Returns a new VkDispatchIndirectCommand.Buffer instance allocated with memCalloc.
static VkDispatchIndirectCommand.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDispatchIndirectCommand.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDispatchIndirectCommand	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDispatchIndirectCommand instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDispatchIndirectCommand	callocStack()	Deprecated.
static VkDispatchIndirectCommand.Buffer	callocStack(int capacity)	Deprecated.
static VkDispatchIndirectCommand.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDispatchIndirectCommand	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDispatchIndirectCommand	create()	Returns a new VkDispatchIndirectCommand instance allocated with BufferUtils.
static VkDispatchIndirectCommand.Buffer	create(int capacity)	Returns a new VkDispatchIndirectCommand.Buffer instance allocated with BufferUtils.
static VkDispatchIndirectCommand	create(long address)	Returns a new VkDispatchIndirectCommand instance for the specified memory address.
static VkDispatchIndirectCommand.Buffer	create(long address, int capacity)	Create a VkDispatchIndirectCommand.Buffer instance at the specified memory.
static @Nullable VkDispatchIndirectCommand	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDispatchIndirectCommand.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDispatchIndirectCommand	malloc()	Returns a new VkDispatchIndirectCommand instance allocated with memAlloc.
static VkDispatchIndirectCommand.Buffer	malloc(int capacity)	Returns a new VkDispatchIndirectCommand.Buffer instance allocated with memAlloc.
static VkDispatchIndirectCommand.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDispatchIndirectCommand.Buffer instance allocated on the specified MemoryStack.
static VkDispatchIndirectCommand	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDispatchIndirectCommand instance allocated on the specified MemoryStack.
static VkDispatchIndirectCommand	mallocStack()	Deprecated.
static VkDispatchIndirectCommand.Buffer	mallocStack(int capacity)	Deprecated.
static VkDispatchIndirectCommand.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDispatchIndirectCommand	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	nx(long struct)	Unsafe version of x().
static void	nx(long struct, int value)	Unsafe version of x.
static int	ny(long struct)	Unsafe version of y().
static void	ny(long struct, int value)	Unsafe version of y.
static int	nz(long struct)	Unsafe version of z().
static void	nz(long struct, int value)	Unsafe version of z.
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()	the number of local workgroups to dispatch in the X dimension.
VkDispatchIndirectCommand	x(int value)	Sets the specified value to the x() field.
int	y()	the number of local workgroups to dispatch in the Y dimension.
VkDispatchIndirectCommand	y(int value)	Sets the specified value to the y() field.
int	z()	the number of local workgroups to dispatch in the Z dimension.
VkDispatchIndirectCommand	z(int value)	Sets the specified value to the z() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

X

public static final int X

The struct member offsets.

Y

public static final int Y

The struct member offsets.

Z

public static final int Z

The struct member offsets.

Constructor Details

VkDispatchIndirectCommand

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkDispatchIndirectCommand>

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 the x() field.

y

public VkDispatchIndirectCommand y(int value)

Sets the specified value to the y() field.

z

public VkDispatchIndirectCommand z(int value)

Sets the specified value to the z() 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 new VkDispatchIndirectCommand instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkDispatchIndirectCommand calloc()

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

create

public static VkDispatchIndirectCommand create()

Returns a new VkDispatchIndirectCommand instance allocated with BufferUtils.

create

public static VkDispatchIndirectCommand create(long address)

Returns a new VkDispatchIndirectCommand instance for the specified memory address.

createSafe

public static @Nullable VkDispatchIndirectCommand createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDispatchIndirectCommand.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDispatchIndirectCommand.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDispatchIndirectCommand.Buffer create(int capacity)

Returns a new VkDispatchIndirectCommand.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDispatchIndirectCommand.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDispatchIndirectCommand mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDispatchIndirectCommand callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDispatchIndirectCommand mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDispatchIndirectCommand callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkDispatchIndirectCommand.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkDispatchIndirectCommand.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(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. Use malloc(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. Use calloc(int, MemoryStack) instead.

malloc

public static VkDispatchIndirectCommand malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDispatchIndirectCommand instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDispatchIndirectCommand calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDispatchIndirectCommand instance allocated on the specified MemoryStack and 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 new VkDispatchIndirectCommand.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDispatchIndirectCommand.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nx

public static int nx(long struct)

Unsafe version of x().

ny

public static int ny(long struct)

Unsafe version of y().

nz

public static int nz(long struct)

Unsafe version of z().

nx

public static void nx(long struct,
 int value)

Unsafe version of x.

ny

public static void ny(long struct,
 int value)

Unsafe version of y.

nz

public static void nz(long struct,
 int value)

Unsafe version of z.