Class CLMutableDispatchConfigKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<CLMutableDispatchConfigKHR>

org.lwjgl.opencl.CLMutableDispatchConfigKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

@NativeType("struct cl_mutable_dispatch_config_khr")
public class CLMutableDispatchConfigKHR
extends Struct<CLMutableDispatchConfigKHR>
implements NativeResource

struct cl_mutable_dispatch_config_khr {
    cl_mutable_command_khr command;
    cl_uint num_args;
    cl_uint num_svm_args;
    cl_uint num_exec_infos;
    cl_uint work_dim;
    cl_mutable_dispatch_arg_khr const * arg_list;
    cl_mutable_dispatch_arg_khr const * arg_svm_list;
    cl_mutable_dispatch_exec_info_khr const * exec_info_list;
    size_t const * global_work_offset;
    size_t const * global_work_size;
    size_t const * local_work_size;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CLMutableDispatchConfigKHR.Buffer	An array of CLMutableDispatchConfigKHR 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	ARG_LIST	The struct member offsets.
static final int	ARG_SVM_LIST	The struct member offsets.
static final int	COMMAND	The struct member offsets.
static final int	EXEC_INFO_LIST	The struct member offsets.
static final int	GLOBAL_WORK_OFFSET	The struct member offsets.
static final int	GLOBAL_WORK_SIZE	The struct member offsets.
static final int	LOCAL_WORK_SIZE	The struct member offsets.
static final int	NUM_ARGS	The struct member offsets.
static final int	NUM_EXEC_INFOS	The struct member offsets.
static final int	NUM_SVM_ARGS	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	WORK_DIM	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@Nullable CLMutableDispatchArgKHR.Buffer	arg_list()
CLMutableDispatchConfigKHR	arg_list(@Nullable CLMutableDispatchArgKHR.Buffer value)	Sets the address of the specified CLMutableDispatchArgKHR.Buffer to the arg_list field.
@Nullable CLMutableDispatchArgKHR.Buffer	arg_svm_list()
CLMutableDispatchConfigKHR	arg_svm_list(@Nullable CLMutableDispatchArgKHR.Buffer value)	Sets the address of the specified CLMutableDispatchArgKHR.Buffer to the arg_svm_list field.
static CLMutableDispatchConfigKHR	calloc()	Returns a new CLMutableDispatchConfigKHR instance allocated with memCalloc.
static CLMutableDispatchConfigKHR.Buffer	calloc(int capacity)	Returns a new CLMutableDispatchConfigKHR.Buffer instance allocated with memCalloc.
static CLMutableDispatchConfigKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new CLMutableDispatchConfigKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static CLMutableDispatchConfigKHR	calloc(MemoryStack stack)	Returns a new CLMutableDispatchConfigKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
long	command()
CLMutableDispatchConfigKHR	command(long value)	Sets the specified value to the command field.
static CLMutableDispatchConfigKHR	create()	Returns a new CLMutableDispatchConfigKHR instance allocated with BufferUtils.
static CLMutableDispatchConfigKHR.Buffer	create(int capacity)	Returns a new CLMutableDispatchConfigKHR.Buffer instance allocated with BufferUtils.
static CLMutableDispatchConfigKHR	create(long address)	Returns a new CLMutableDispatchConfigKHR instance for the specified memory address.
static CLMutableDispatchConfigKHR.Buffer	create(long address, int capacity)	Create a CLMutableDispatchConfigKHR.Buffer instance at the specified memory.
static @Nullable CLMutableDispatchConfigKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable CLMutableDispatchConfigKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
@Nullable CLMutableDispatchExecInfoKHR.Buffer	exec_info_list()
CLMutableDispatchConfigKHR	exec_info_list(@Nullable CLMutableDispatchExecInfoKHR.Buffer value)	Sets the address of the specified CLMutableDispatchExecInfoKHR.Buffer to the exec_info_list field.
@Nullable PointerBuffer	global_work_offset()
CLMutableDispatchConfigKHR	global_work_offset(@Nullable PointerBuffer value)	Sets the address of the specified PointerBuffer to the global_work_offset field.
@Nullable PointerBuffer	global_work_size()
CLMutableDispatchConfigKHR	global_work_size(@Nullable PointerBuffer value)	Sets the address of the specified PointerBuffer to the global_work_size field.
@Nullable PointerBuffer	local_work_size()
CLMutableDispatchConfigKHR	local_work_size(@Nullable PointerBuffer value)	Sets the address of the specified PointerBuffer to the local_work_size field.
static CLMutableDispatchConfigKHR	malloc()	Returns a new CLMutableDispatchConfigKHR instance allocated with memAlloc.
static CLMutableDispatchConfigKHR.Buffer	malloc(int capacity)	Returns a new CLMutableDispatchConfigKHR.Buffer instance allocated with memAlloc.
static CLMutableDispatchConfigKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new CLMutableDispatchConfigKHR.Buffer instance allocated on the specified MemoryStack.
static CLMutableDispatchConfigKHR	malloc(MemoryStack stack)	Returns a new CLMutableDispatchConfigKHR instance allocated on the specified MemoryStack.
static @Nullable CLMutableDispatchArgKHR.Buffer	narg_list(long struct)	Unsafe version of arg_list().
static void	narg_list(long struct, @Nullable CLMutableDispatchArgKHR.Buffer value)	Unsafe version of arg_list.
static @Nullable CLMutableDispatchArgKHR.Buffer	narg_svm_list(long struct)	Unsafe version of arg_svm_list().
static void	narg_svm_list(long struct, @Nullable CLMutableDispatchArgKHR.Buffer value)	Unsafe version of arg_svm_list.
static long	ncommand(long struct)	Unsafe version of command().
static void	ncommand(long struct, long value)	Unsafe version of command.
static @Nullable CLMutableDispatchExecInfoKHR.Buffer	nexec_info_list(long struct)	Unsafe version of exec_info_list().
static void	nexec_info_list(long struct, @Nullable CLMutableDispatchExecInfoKHR.Buffer value)	Unsafe version of exec_info_list.
static @Nullable PointerBuffer	nglobal_work_offset(long struct)	Unsafe version of global_work_offset.
static void	nglobal_work_offset(long struct, @Nullable PointerBuffer value)	Unsafe version of global_work_offset.
static @Nullable PointerBuffer	nglobal_work_size(long struct)	Unsafe version of global_work_size.
static void	nglobal_work_size(long struct, @Nullable PointerBuffer value)	Unsafe version of global_work_size.
static @Nullable PointerBuffer	nlocal_work_size(long struct)	Unsafe version of local_work_size.
static void	nlocal_work_size(long struct, @Nullable PointerBuffer value)	Unsafe version of local_work_size.
static int	nnum_args(long struct)	Unsafe version of num_args().
static void	nnum_args(long struct, int value)	Sets the specified value to the num_args field of the specified struct.
static int	nnum_exec_infos(long struct)	Unsafe version of num_exec_infos().
static void	nnum_exec_infos(long struct, int value)	Sets the specified value to the num_exec_infos field of the specified struct.
static int	nnum_svm_args(long struct)	Unsafe version of num_svm_args().
static void	nnum_svm_args(long struct, int value)	Sets the specified value to the num_svm_args field of the specified struct.
int	num_args()
CLMutableDispatchConfigKHR	num_args(int value)	Sets the specified value to the num_args field.
int	num_exec_infos()
CLMutableDispatchConfigKHR	num_exec_infos(int value)	Sets the specified value to the num_exec_infos field.
int	num_svm_args()
CLMutableDispatchConfigKHR	num_svm_args(int value)	Sets the specified value to the num_svm_args field.
static int	nwork_dim(long struct)	Unsafe version of work_dim().
static void	nwork_dim(long struct, int value)	Unsafe version of work_dim.
CLMutableDispatchConfigKHR	set(long command, int num_args, int num_svm_args, int num_exec_infos, int work_dim, @Nullable CLMutableDispatchArgKHR.Buffer arg_list, @Nullable CLMutableDispatchArgKHR.Buffer arg_svm_list, @Nullable CLMutableDispatchExecInfoKHR.Buffer exec_info_list, @Nullable PointerBuffer global_work_offset, @Nullable PointerBuffer global_work_size, @Nullable PointerBuffer local_work_size)	Initializes this struct with the specified values.
CLMutableDispatchConfigKHR	set(CLMutableDispatchConfigKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.
int	work_dim()
CLMutableDispatchConfigKHR	work_dim(int value)	Sets the specified value to the work_dim 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.

COMMAND

public static final int COMMAND

The struct member offsets.

NUM_ARGS

public static final int NUM_ARGS

The struct member offsets.

NUM_SVM_ARGS

public static final int NUM_SVM_ARGS

The struct member offsets.

NUM_EXEC_INFOS

public static final int NUM_EXEC_INFOS

The struct member offsets.

WORK_DIM

public static final int WORK_DIM

The struct member offsets.

ARG_LIST

public static final int ARG_LIST

The struct member offsets.

ARG_SVM_LIST

public static final int ARG_SVM_LIST

The struct member offsets.

EXEC_INFO_LIST

public static final int EXEC_INFO_LIST

The struct member offsets.

GLOBAL_WORK_OFFSET

public static final int GLOBAL_WORK_OFFSET

The struct member offsets.

GLOBAL_WORK_SIZE

public static final int GLOBAL_WORK_SIZE

The struct member offsets.

LOCAL_WORK_SIZE

public static final int LOCAL_WORK_SIZE

The struct member offsets.

Constructor Details

CLMutableDispatchConfigKHR

public CLMutableDispatchConfigKHR(ByteBuffer container)

Creates a CLMutableDispatchConfigKHR 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<CLMutableDispatchConfigKHR>

command

@NativeType("cl_mutable_command_khr")
public long command()

Returns:

the value of the command field.

num_args

@NativeType("cl_uint")
public int num_args()

Returns:

the value of the num_args field.

num_svm_args

@NativeType("cl_uint")
public int num_svm_args()

Returns:

the value of the num_svm_args field.

num_exec_infos

@NativeType("cl_uint")
public int num_exec_infos()

Returns:

the value of the num_exec_infos field.

work_dim

@NativeType("cl_uint")
public int work_dim()

Returns:

the value of the work_dim field.

arg_list

@NativeType("cl_mutable_dispatch_arg_khr const *")
public @Nullable CLMutableDispatchArgKHR.Buffer arg_list()

Returns:

a CLMutableDispatchArgKHR.Buffer view of the struct array pointed to by the arg_list field.

arg_svm_list

@NativeType("cl_mutable_dispatch_arg_khr const *")
public @Nullable CLMutableDispatchArgKHR.Buffer arg_svm_list()

Returns:

a CLMutableDispatchArgKHR.Buffer view of the struct array pointed to by the arg_svm_list field.

exec_info_list

@NativeType("cl_mutable_dispatch_exec_info_khr const *")
public @Nullable CLMutableDispatchExecInfoKHR.Buffer exec_info_list()

Returns:

a CLMutableDispatchExecInfoKHR.Buffer view of the struct array pointed to by the exec_info_list field.

global_work_offset

@NativeType("size_t const *")
public @Nullable PointerBuffer global_work_offset()

Returns:

a PointerBuffer view of the data pointed to by the global_work_offset field.

global_work_size

@NativeType("size_t const *")
public @Nullable PointerBuffer global_work_size()

Returns:

a PointerBuffer view of the data pointed to by the global_work_size field.

local_work_size

@NativeType("size_t const *")
public @Nullable PointerBuffer local_work_size()

Returns:

a PointerBuffer view of the data pointed to by the local_work_size field.

command

public CLMutableDispatchConfigKHR command(@NativeType("cl_mutable_command_khr")
 long value)

Sets the specified value to the command field.

num_args

public CLMutableDispatchConfigKHR num_args(@NativeType("cl_uint")
 int value)

Sets the specified value to the num_args field.

num_svm_args

public CLMutableDispatchConfigKHR num_svm_args(@NativeType("cl_uint")
 int value)

Sets the specified value to the num_svm_args field.

num_exec_infos

public CLMutableDispatchConfigKHR num_exec_infos(@NativeType("cl_uint")
 int value)

Sets the specified value to the num_exec_infos field.

work_dim

public CLMutableDispatchConfigKHR work_dim(@NativeType("cl_uint")
 int value)

Sets the specified value to the work_dim field.

arg_list

public CLMutableDispatchConfigKHR arg_list(@NativeType("cl_mutable_dispatch_arg_khr const *")
 @Nullable CLMutableDispatchArgKHR.Buffer value)

Sets the address of the specified CLMutableDispatchArgKHR.Buffer to the arg_list field.

arg_svm_list

public CLMutableDispatchConfigKHR arg_svm_list(@NativeType("cl_mutable_dispatch_arg_khr const *")
 @Nullable CLMutableDispatchArgKHR.Buffer value)

Sets the address of the specified CLMutableDispatchArgKHR.Buffer to the arg_svm_list field.

exec_info_list

public CLMutableDispatchConfigKHR exec_info_list(@NativeType("cl_mutable_dispatch_exec_info_khr const *")
 @Nullable CLMutableDispatchExecInfoKHR.Buffer value)

Sets the address of the specified CLMutableDispatchExecInfoKHR.Buffer to the exec_info_list field.

global_work_offset

public CLMutableDispatchConfigKHR global_work_offset(@NativeType("size_t const *")
 @Nullable PointerBuffer value)

Sets the address of the specified PointerBuffer to the global_work_offset field.

global_work_size

public CLMutableDispatchConfigKHR global_work_size(@NativeType("size_t const *")
 @Nullable PointerBuffer value)

Sets the address of the specified PointerBuffer to the global_work_size field.

local_work_size

public CLMutableDispatchConfigKHR local_work_size(@NativeType("size_t const *")
 @Nullable PointerBuffer value)

Sets the address of the specified PointerBuffer to the local_work_size field.

set

public CLMutableDispatchConfigKHR set(long command,
 int num_args,
 int num_svm_args,
 int num_exec_infos,
 int work_dim,
 @Nullable CLMutableDispatchArgKHR.Buffer arg_list,
 @Nullable CLMutableDispatchArgKHR.Buffer arg_svm_list,
 @Nullable CLMutableDispatchExecInfoKHR.Buffer exec_info_list,
 @Nullable PointerBuffer global_work_offset,
 @Nullable PointerBuffer global_work_size,
 @Nullable PointerBuffer local_work_size)

Initializes this struct with the specified values.

set

public CLMutableDispatchConfigKHR set(CLMutableDispatchConfigKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static CLMutableDispatchConfigKHR malloc()

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

calloc

public static CLMutableDispatchConfigKHR calloc()

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

create

public static CLMutableDispatchConfigKHR create()

Returns a new CLMutableDispatchConfigKHR instance allocated with BufferUtils.

create

public static CLMutableDispatchConfigKHR create(long address)

Returns a new CLMutableDispatchConfigKHR instance for the specified memory address.

createSafe

public static @Nullable CLMutableDispatchConfigKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static CLMutableDispatchConfigKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static CLMutableDispatchConfigKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static CLMutableDispatchConfigKHR.Buffer create(int capacity)

Returns a new CLMutableDispatchConfigKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a CLMutableDispatchConfigKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static CLMutableDispatchConfigKHR malloc(MemoryStack stack)

Returns a new CLMutableDispatchConfigKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static CLMutableDispatchConfigKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ncommand

public static long ncommand(long struct)

Unsafe version of command().

nnum_args

public static int nnum_args(long struct)

Unsafe version of num_args().

nnum_svm_args

public static int nnum_svm_args(long struct)

Unsafe version of num_svm_args().

nnum_exec_infos

public static int nnum_exec_infos(long struct)

Unsafe version of num_exec_infos().

nwork_dim

public static int nwork_dim(long struct)

Unsafe version of work_dim().

narg_list

public static @Nullable CLMutableDispatchArgKHR.Buffer narg_list(long struct)

Unsafe version of arg_list().

narg_svm_list

public static @Nullable CLMutableDispatchArgKHR.Buffer narg_svm_list(long struct)

Unsafe version of arg_svm_list().

nexec_info_list

public static @Nullable CLMutableDispatchExecInfoKHR.Buffer nexec_info_list(long struct)

Unsafe version of exec_info_list().

nglobal_work_offset

public static @Nullable PointerBuffer nglobal_work_offset(long struct)

Unsafe version of global_work_offset.

nglobal_work_size

public static @Nullable PointerBuffer nglobal_work_size(long struct)

Unsafe version of global_work_size.

nlocal_work_size

public static @Nullable PointerBuffer nlocal_work_size(long struct)

Unsafe version of local_work_size.

ncommand

public static void ncommand(long struct,
 long value)

Unsafe version of command.

nnum_args

public static void nnum_args(long struct,
 int value)

Sets the specified value to the num_args field of the specified struct.

nnum_svm_args

public static void nnum_svm_args(long struct,
 int value)

Sets the specified value to the num_svm_args field of the specified struct.

nnum_exec_infos

public static void nnum_exec_infos(long struct,
 int value)

Sets the specified value to the num_exec_infos field of the specified struct.

nwork_dim

public static void nwork_dim(long struct,
 int value)

Unsafe version of work_dim.

narg_list

public static void narg_list(long struct,
 @Nullable CLMutableDispatchArgKHR.Buffer value)

Unsafe version of arg_list.

narg_svm_list

public static void narg_svm_list(long struct,
 @Nullable CLMutableDispatchArgKHR.Buffer value)

Unsafe version of arg_svm_list.

nexec_info_list

public static void nexec_info_list(long struct,
 @Nullable CLMutableDispatchExecInfoKHR.Buffer value)

Unsafe version of exec_info_list.

nglobal_work_offset

public static void nglobal_work_offset(long struct,
 @Nullable PointerBuffer value)

Unsafe version of global_work_offset.

nglobal_work_size

public static void nglobal_work_size(long struct,
 @Nullable PointerBuffer value)

Unsafe version of global_work_size.

nlocal_work_size

public static void nlocal_work_size(long struct,
 @Nullable PointerBuffer value)

Unsafe version of local_work_size.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate