Module club.doki7.opencl

Package club.doki7.opencl.handle

Record Class CLMem.Ptr

java.lang.Object

java.lang.Record

club.doki7.opencl.handle.CLMem.Ptr

All Implemented Interfaces:

club.doki7.ffm.IPointer, Iterable<CLMem>

Enclosing class:

CLMem

@ValueBasedCandidate
@UnsafeConstructor
public static record CLMem.Ptr(@NotNull MemorySegment segment)
extends Record
implements club.doki7.ffm.IPointer, Iterable<CLMem>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CLMem.Ptr	allocate(Arena arena)
static CLMem.Ptr	allocate(Arena arena, long size)
static CLMem.Ptr	allocate(Arena arena, @Nullable CLMem @NotNull [] values)
static CLMem.Ptr	allocate(Arena arena, @NotNull Collection<@Nullable CLMem> values)
static CLMem.Ptr	allocateV(Arena arena, @Nullable CLMem value0, @Nullable CLMem... values)
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 Iterator<CLMem>	iterator()
CLMem.Ptr	offset(long offset)
@Nullable CLMem	read()
@Nullable CLMem	read(long index)
@NotNull MemorySegment	readRaw()
@NotNull MemorySegment	readRaw(long index)
CLMem.Ptr	reinterpret(long newSize)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
CLMem.Ptr	slice(long end)
CLMem.Ptr	slice(long start, long end)
final String	toString()	Returns a string representation of this record class.
void	write(long index, @Nullable CLMem value)
void	write(@Nullable CLMem value)
void	write(@Nullable CLMem[] values)
void	writeRaw(long index, @NotNull MemorySegment value)
void	writeRaw(@NotNull MemorySegment value)
void	writeV(@Nullable CLMem value0, @Nullable CLMem... values)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

Ptr

public Ptr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a Ptr record class.

Parameters:

segment - the value for the segment record component

Method Details

size

public long size()

read

@Nullable
public @Nullable CLMem read()

write

public void write(@Nullable
 @Nullable CLMem value)

read

@Nullable
public @Nullable CLMem read(long index)

write

public void write(long index,
 @Nullable
 @Nullable CLMem value)

write

public void write(@Nullable
 @Nullable CLMem[] values)

writeV

public void writeV(@Nullable
 @Nullable CLMem value0,
 @Nullable
 @Nullable CLMem... values)

readRaw

@NotNull
public @NotNull MemorySegment readRaw()

readRaw

@NotNull
public @NotNull MemorySegment readRaw(long index)

writeRaw

public void writeRaw(@NotNull
 @NotNull MemorySegment value)

writeRaw

public void writeRaw(long index,
 @NotNull
 @NotNull MemorySegment value)

reinterpret

@Unsafe
public CLMem.Ptr reinterpret(long newSize)

offset

public CLMem.Ptr offset(long offset)

slice

public CLMem.Ptr slice(long start,
 long end)

slice

public CLMem.Ptr slice(long end)

allocate

public static CLMem.Ptr allocate(Arena arena)

allocate

public static CLMem.Ptr allocate(Arena arena,
 long size)

allocate

public static CLMem.Ptr allocate(Arena arena,
 @Nullable
 @Nullable CLMem @NotNull [] values)

allocate

public static CLMem.Ptr allocate(Arena arena,
 @NotNull
 @NotNull Collection<@Nullable CLMem> values)

allocateV

public static CLMem.Ptr allocateV(Arena arena,
 @Nullable
 @Nullable CLMem value0,
 @Nullable
 @Nullable CLMem... values)

iterator

@NotNull
public @NotNull Iterator<CLMem> iterator()

Specified by:

iterator in interface Iterable<CLMem>

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 club.doki7.ffm.IPointer

Returns:

the value of the segment record component