Class VkDispatchParametersARM

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDispatchParametersARM>

org.lwjgl.vulkan.VkDispatchParametersARM

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDispatchParametersARM
extends Struct<VkDispatchParametersARM>
implements NativeResource

struct VkDispatchParametersARM {
    VkStructureType sType;
    void * pNext;
    uint32_t workGroupBatchSize;
    uint32_t maxQueuedWorkGroupBatches;
    uint32_t maxWarpsPerShaderCore;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDispatchParametersARM.Buffer	An array of VkDispatchParametersARM structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	MAXQUEUEDWORKGROUPBATCHES	The struct member offsets.
static final int	MAXWARPSPERSHADERCORE	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	WORKGROUPBATCHSIZE	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDispatchParametersARM	calloc()	Returns a new VkDispatchParametersARM instance allocated with memCalloc.
static VkDispatchParametersARM.Buffer	calloc(int capacity)	Returns a new VkDispatchParametersARM.Buffer instance allocated with memCalloc.
static VkDispatchParametersARM.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDispatchParametersARM.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDispatchParametersARM	calloc(MemoryStack stack)	Returns a new VkDispatchParametersARM instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDispatchParametersARM	create()	Returns a new VkDispatchParametersARM instance allocated with BufferUtils.
static VkDispatchParametersARM.Buffer	create(int capacity)	Returns a new VkDispatchParametersARM.Buffer instance allocated with BufferUtils.
static VkDispatchParametersARM	create(long address)	Returns a new VkDispatchParametersARM instance for the specified memory address.
static VkDispatchParametersARM.Buffer	create(long address, int capacity)	Create a VkDispatchParametersARM.Buffer instance at the specified memory.
static @Nullable VkDispatchParametersARM	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDispatchParametersARM.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDispatchParametersARM	malloc()	Returns a new VkDispatchParametersARM instance allocated with memAlloc.
static VkDispatchParametersARM.Buffer	malloc(int capacity)	Returns a new VkDispatchParametersARM.Buffer instance allocated with memAlloc.
static VkDispatchParametersARM.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDispatchParametersARM.Buffer instance allocated on the specified MemoryStack.
static VkDispatchParametersARM	malloc(MemoryStack stack)	Returns a new VkDispatchParametersARM instance allocated on the specified MemoryStack.
int	maxQueuedWorkGroupBatches()
VkDispatchParametersARM	maxQueuedWorkGroupBatches(int value)	Sets the specified value to the maxQueuedWorkGroupBatches field.
int	maxWarpsPerShaderCore()
VkDispatchParametersARM	maxWarpsPerShaderCore(int value)	Sets the specified value to the maxWarpsPerShaderCore field.
static int	nmaxQueuedWorkGroupBatches(long struct)	Unsafe version of maxQueuedWorkGroupBatches().
static void	nmaxQueuedWorkGroupBatches(long struct, int value)	Unsafe version of maxQueuedWorkGroupBatches.
static int	nmaxWarpsPerShaderCore(long struct)	Unsafe version of maxWarpsPerShaderCore().
static void	nmaxWarpsPerShaderCore(long struct, int value)	Unsafe version of maxWarpsPerShaderCore.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	nworkGroupBatchSize(long struct)	Unsafe version of workGroupBatchSize().
static void	nworkGroupBatchSize(long struct, int value)	Unsafe version of workGroupBatchSize.
long	pNext()
VkDispatchParametersARM	pNext(long value)	Sets the specified value to the pNext field.
VkDispatchParametersARM	set(int sType, long pNext, int workGroupBatchSize, int maxQueuedWorkGroupBatches, int maxWarpsPerShaderCore)	Initializes this struct with the specified values.
VkDispatchParametersARM	set(VkDispatchParametersARM src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkDispatchParametersARM	sType(int value)	Sets the specified value to the sType field.
VkDispatchParametersARM	sType$Default()	Sets the STRUCTURE_TYPE_DISPATCH_PARAMETERS_ARM value to the sType field.
int	workGroupBatchSize()
VkDispatchParametersARM	workGroupBatchSize(int value)	Sets the specified value to the workGroupBatchSize field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

WORKGROUPBATCHSIZE

public static final int WORKGROUPBATCHSIZE

The struct member offsets.

MAXQUEUEDWORKGROUPBATCHES

public static final int MAXQUEUEDWORKGROUPBATCHES

The struct member offsets.

MAXWARPSPERSHADERCORE

public static final int MAXWARPSPERSHADERCORE

The struct member offsets.

Constructor Details

VkDispatchParametersARM

public VkDispatchParametersARM(ByteBuffer container)

Creates a VkDispatchParametersARM 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkDispatchParametersARM>

sType

@NativeType("VkStructureType")
public int sType()

Returns:

the value of the sType field.

pNext

@NativeType("void *")
public long pNext()

Returns:

the value of the pNext field.

workGroupBatchSize

@NativeType("uint32_t")
public int workGroupBatchSize()

Returns:

the value of the workGroupBatchSize field.

maxQueuedWorkGroupBatches

@NativeType("uint32_t")
public int maxQueuedWorkGroupBatches()

Returns:

the value of the maxQueuedWorkGroupBatches field.

maxWarpsPerShaderCore

@NativeType("uint32_t")
public int maxWarpsPerShaderCore()

Returns:

the value of the maxWarpsPerShaderCore field.

sType

public VkDispatchParametersARM sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkDispatchParametersARM sType$Default()

Sets the STRUCTURE_TYPE_DISPATCH_PARAMETERS_ARM value to the sType field.

pNext

public VkDispatchParametersARM pNext(@NativeType("void *")
 long value)

Sets the specified value to the pNext field.

workGroupBatchSize

public VkDispatchParametersARM workGroupBatchSize(@NativeType("uint32_t")
 int value)

Sets the specified value to the workGroupBatchSize field.

maxQueuedWorkGroupBatches

public VkDispatchParametersARM maxQueuedWorkGroupBatches(@NativeType("uint32_t")
 int value)

Sets the specified value to the maxQueuedWorkGroupBatches field.

maxWarpsPerShaderCore

public VkDispatchParametersARM maxWarpsPerShaderCore(@NativeType("uint32_t")
 int value)

Sets the specified value to the maxWarpsPerShaderCore field.

set

public VkDispatchParametersARM set(int sType,
 long pNext,
 int workGroupBatchSize,
 int maxQueuedWorkGroupBatches,
 int maxWarpsPerShaderCore)

Initializes this struct with the specified values.

set

public VkDispatchParametersARM set(VkDispatchParametersARM src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDispatchParametersARM malloc()

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

calloc

public static VkDispatchParametersARM calloc()

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

create

public static VkDispatchParametersARM create()

Returns a new VkDispatchParametersARM instance allocated with BufferUtils.

create

public static VkDispatchParametersARM create(long address)

Returns a new VkDispatchParametersARM instance for the specified memory address.

createSafe

public static @Nullable VkDispatchParametersARM createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDispatchParametersARM.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDispatchParametersARM.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDispatchParametersARM.Buffer create(int capacity)

Returns a new VkDispatchParametersARM.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDispatchParametersARM.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkDispatchParametersARM malloc(MemoryStack stack)

Returns a new VkDispatchParametersARM instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDispatchParametersARM calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkDispatchParametersARM.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDispatchParametersARM.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkDispatchParametersARM.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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nworkGroupBatchSize

public static int nworkGroupBatchSize(long struct)

Unsafe version of workGroupBatchSize().

nmaxQueuedWorkGroupBatches

public static int nmaxQueuedWorkGroupBatches(long struct)

Unsafe version of maxQueuedWorkGroupBatches().

nmaxWarpsPerShaderCore

public static int nmaxWarpsPerShaderCore(long struct)

Unsafe version of maxWarpsPerShaderCore().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nworkGroupBatchSize

public static void nworkGroupBatchSize(long struct,
 int value)

Unsafe version of workGroupBatchSize.

nmaxQueuedWorkGroupBatches

public static void nmaxQueuedWorkGroupBatches(long struct,
 int value)

Unsafe version of maxQueuedWorkGroupBatches.

nmaxWarpsPerShaderCore

public static void nmaxWarpsPerShaderCore(long struct,
 int value)

Unsafe version of maxWarpsPerShaderCore.