Record Class CLMutableDispatchExecInfoKhr

java.lang.Object

java.lang.Record

club.doki7.opencl.datatype.CLMutableDispatchExecInfoKhr

All Implemented Interfaces:

IPointer, ICLMutableDispatchExecInfoKhr

@ValueBasedCandidate
@UnsafeConstructor
public record CLMutableDispatchExecInfoKhr(@NotNull MemorySegment segment)
extends Record
implements ICLMutableDispatchExecInfoKhr

Represents a pointer to a cl_mutable_dispatch_exec_info_khr structure in native memory.

Structure

typedef struct cl_mutable_dispatch_exec_info_khr {
    cl_uint paramName;
    size_t paramValueSize;
    void const* paramValue;
} cl_mutable_dispatch_exec_info_khr;

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

See Also:

• cl_mutable_dispatch_exec_info_khr

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CLMutableDispatchExecInfoKhr.Ptr	Represents a pointer to / an array of cl_mutable_dispatch_exec_info_khr structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$paramName
static final AddressLayout	LAYOUT$paramValue
static final long	OFFSET$paramName
static final long	OFFSET$paramValue
static final long	OFFSET$paramValueSize
static final MemoryLayout.PathElement	PATH$paramName
static final MemoryLayout.PathElement	PATH$paramValue
static final MemoryLayout.PathElement	PATH$paramValueSize
static final long	SIZE$paramName
static final long	SIZE$paramValue
static final long	SIZE$paramValueSize

Constructor Summary

Constructors

Constructor	Description
CLMutableDispatchExecInfoKhr(@NotNull MemorySegment segment)	Creates an instance of a CLMutableDispatchExecInfoKhr record class.

Method Summary

Modifier and Type	Method	Description
static CLMutableDispatchExecInfoKhr	allocate(Arena arena)
static CLMutableDispatchExecInfoKhr.Ptr	allocate(Arena arena, long count)
static CLMutableDispatchExecInfoKhr	clone(Arena arena, CLMutableDispatchExecInfoKhr src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	paramName()
CLMutableDispatchExecInfoKhr	paramName(int value)
@NotNull MemorySegment	paramValue()
CLMutableDispatchExecInfoKhr	paramValue(@Nullable IPointer pointer)
CLMutableDispatchExecInfoKhr	paramValue(@NotNull MemorySegment value)
long	paramValueSize()
CLMutableDispatchExecInfoKhr	paramValueSize(long value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LAYOUT

public static final StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$paramName

public static final MemoryLayout.PathElement PATH$paramName

PATH$paramValueSize

public static final MemoryLayout.PathElement PATH$paramValueSize

PATH$paramValue

public static final MemoryLayout.PathElement PATH$paramValue

LAYOUT$paramName

public static final ValueLayout.OfInt LAYOUT$paramName

LAYOUT$paramValue

public static final AddressLayout LAYOUT$paramValue

SIZE$paramName

public static final long SIZE$paramName

SIZE$paramValueSize

public static final long SIZE$paramValueSize

SIZE$paramValue

public static final long SIZE$paramValue

OFFSET$paramName

public static final long OFFSET$paramName

OFFSET$paramValueSize

public static final long OFFSET$paramValueSize

OFFSET$paramValue

public static final long OFFSET$paramValue

Constructor Details

CLMutableDispatchExecInfoKhr

public CLMutableDispatchExecInfoKhr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a CLMutableDispatchExecInfoKhr record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static CLMutableDispatchExecInfoKhr allocate(Arena arena)

allocate

public static CLMutableDispatchExecInfoKhr.Ptr allocate(Arena arena,
 long count)

clone

public static CLMutableDispatchExecInfoKhr clone(Arena arena,
 CLMutableDispatchExecInfoKhr src)

paramName

@NativeType("cl_uint")
@Unsigned
public int paramName()

paramName

public CLMutableDispatchExecInfoKhr paramName(@NativeType("cl_uint") @Unsigned
 int value)

paramValueSize

@Unsigned
public long paramValueSize()

paramValueSize

public CLMutableDispatchExecInfoKhr paramValueSize(@Unsigned
 long value)

paramValue

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment paramValue()

paramValue

public CLMutableDispatchExecInfoKhr paramValue(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

paramValue

public CLMutableDispatchExecInfoKhr paramValue(@Nullable
 @Nullable IPointer pointer)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

segment

@NotNull
public @NotNull MemorySegment segment()

Returns the value of the segment record component.

Specified by:

segment in interface IPointer

Returns:

the value of the segment record component