Module club.doki7.opencl

Package club.doki7.opencl.datatype

Record Class CLBufferRegion

java.lang.Object

java.lang.Record

club.doki7.opencl.datatype.CLBufferRegion

All Implemented Interfaces:

club.doki7.ffm.IPointer, ICLBufferRegion

@ValueBasedCandidate
@UnsafeConstructor
public record CLBufferRegion(@NotNull MemorySegment segment)
extends Record
implements ICLBufferRegion

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CLBufferRegion.Ptr

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final long	OFFSET$origin
static final long	OFFSET$size
static final MemoryLayout.PathElement	PATH$origin
static final MemoryLayout.PathElement	PATH$size
static final long	SIZE$origin
static final long	SIZE$size

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CLBufferRegion	allocate(Arena arena)
static CLBufferRegion.Ptr	allocate(Arena arena, long count)
static CLBufferRegion	clone(Arena arena, CLBufferRegion 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.
long	origin()
CLBufferRegion	origin(long value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
CLBufferRegion	size(long value)
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$origin

public static final MemoryLayout.PathElement PATH$origin

PATH$size

public static final MemoryLayout.PathElement PATH$size

SIZE$origin

public static final long SIZE$origin

SIZE$size

public static final long SIZE$size

OFFSET$origin

public static final long OFFSET$origin

OFFSET$size

public static final long OFFSET$size

Constructor Details

CLBufferRegion

public CLBufferRegion(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a CLBufferRegion record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static CLBufferRegion allocate(Arena arena)

allocate

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

clone

public static CLBufferRegion clone(Arena arena,
 CLBufferRegion src)

origin

@Unsigned
public long origin()

origin

public CLBufferRegion origin(@Unsigned
 long value)

size

@Unsigned
public long size()

size

public CLBufferRegion size(@Unsigned
 long value)

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