Record Class CLMutableDispatchArgKhr

java.lang.Object

java.lang.Record

club.doki7.opencl.datatype.CLMutableDispatchArgKhr

All Implemented Interfaces:

IPointer, ICLMutableDispatchArgKhr

@ValueBasedCandidate
@UnsafeConstructor
public record CLMutableDispatchArgKhr(@NotNull MemorySegment segment)
extends Record
implements ICLMutableDispatchArgKhr

Represents a pointer to a cl_mutable_dispatch_arg_khr structure in native memory.

Structure

typedef struct cl_mutable_dispatch_arg_khr {
    cl_uint argIndex;
    size_t argSize;
    void const* argValue;
} cl_mutable_dispatch_arg_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_arg_khr

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CLMutableDispatchArgKhr.Ptr	Represents a pointer to / an array of cl_mutable_dispatch_arg_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$argIndex
static final AddressLayout	LAYOUT$argValue
static final long	OFFSET$argIndex
static final long	OFFSET$argSize
static final long	OFFSET$argValue
static final MemoryLayout.PathElement	PATH$argIndex
static final MemoryLayout.PathElement	PATH$argSize
static final MemoryLayout.PathElement	PATH$argValue
static final long	SIZE$argIndex
static final long	SIZE$argSize
static final long	SIZE$argValue

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CLMutableDispatchArgKhr	allocate(Arena arena)
static CLMutableDispatchArgKhr.Ptr	allocate(Arena arena, long count)
int	argIndex()
CLMutableDispatchArgKhr	argIndex(int value)
long	argSize()
CLMutableDispatchArgKhr	argSize(long value)
@NotNull MemorySegment	argValue()
CLMutableDispatchArgKhr	argValue(@Nullable IPointer pointer)
CLMutableDispatchArgKhr	argValue(@NotNull MemorySegment value)
static CLMutableDispatchArgKhr	clone(Arena arena, CLMutableDispatchArgKhr 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.
@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$argIndex

public static final MemoryLayout.PathElement PATH$argIndex

PATH$argSize

public static final MemoryLayout.PathElement PATH$argSize

PATH$argValue

public static final MemoryLayout.PathElement PATH$argValue

LAYOUT$argIndex

public static final ValueLayout.OfInt LAYOUT$argIndex

LAYOUT$argValue

public static final AddressLayout LAYOUT$argValue

SIZE$argIndex

public static final long SIZE$argIndex

SIZE$argSize

public static final long SIZE$argSize

SIZE$argValue

public static final long SIZE$argValue

OFFSET$argIndex

public static final long OFFSET$argIndex

OFFSET$argSize

public static final long OFFSET$argSize

OFFSET$argValue

public static final long OFFSET$argValue

Constructor Details

CLMutableDispatchArgKhr

public CLMutableDispatchArgKhr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a CLMutableDispatchArgKhr record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static CLMutableDispatchArgKhr allocate(Arena arena)

allocate

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

clone

public static CLMutableDispatchArgKhr clone(Arena arena,
 CLMutableDispatchArgKhr src)

argIndex

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

argIndex

public CLMutableDispatchArgKhr argIndex(@NativeType("cl_uint") @Unsigned
 int value)

argSize

@Unsigned
public long argSize()

argSize

public CLMutableDispatchArgKhr argSize(@Unsigned
 long value)

argValue

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

argValue

public CLMutableDispatchArgKhr argValue(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

argValue

public CLMutableDispatchArgKhr argValue(@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