Module club.doki7.opencl

Package club.doki7.opencl.datatype

Record Class CLBufferRegion.Ptr

java.lang.Object

java.lang.Record

club.doki7.opencl.datatype.CLBufferRegion.Ptr

All Implemented Interfaces:

club.doki7.ffm.IPointer, ICLBufferRegion, Iterable<CLBufferRegion>

Enclosing class:

CLBufferRegion

@ValueBasedCandidate
@UnsafeConstructor
public static record CLBufferRegion.Ptr(@NotNull MemorySegment segment)
extends Record
implements ICLBufferRegion, Iterable<CLBufferRegion>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NotNull CLBufferRegion	at(long index)
CLBufferRegion.Ptr	at(long index, @NotNull Consumer<@NotNull CLBufferRegion> consumer)
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<CLBufferRegion>	iterator()
@NotNull CLBufferRegion.Ptr	offset(long offset)
@NotNull CLBufferRegion.Ptr	reinterpret(long newSize)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
CLBufferRegion.Ptr	slice(long end)
@NotNull CLBufferRegion.Ptr	slice(long start, long end)
CLBufferRegion[]	toArray()
final String	toString()	Returns a string representation of this record class.
void	write(long index, @NotNull CLBufferRegion value)

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()

at

@NotNull
public @NotNull CLBufferRegion at(long index)

at

public CLBufferRegion.Ptr at(long index,
 @NotNull
 @NotNull Consumer<@NotNull CLBufferRegion> consumer)

write

public void write(long index,
 @NotNull
 @NotNull CLBufferRegion value)

reinterpret

@Unsafe
@NotNull
public @NotNull CLBufferRegion.Ptr reinterpret(long newSize)

offset

@NotNull
public @NotNull CLBufferRegion.Ptr offset(long offset)

slice

@NotNull
public @NotNull CLBufferRegion.Ptr slice(long start,
 long end)

slice

public CLBufferRegion.Ptr slice(long end)

toArray

public CLBufferRegion[] toArray()

iterator

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

Specified by:

iterator in interface Iterable<CLBufferRegion>

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