Record Class CLCommandBufferKhr.Ptr

java.lang.Object

java.lang.Record

club.doki7.opencl.handle.CLCommandBufferKhr.Ptr

All Implemented Interfaces:

IPointer, Iterable<CLCommandBufferKhr>

Enclosing class:

CLCommandBufferKhr

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

Represents a pointer to cl_command_buffer_khr handle(s) in native memory.

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to MemoryLayout.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.

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 CLCommandBufferKhr.Ptr	allocate(Arena arena)
static CLCommandBufferKhr.Ptr	allocate(Arena arena, long size)
static CLCommandBufferKhr.Ptr	allocate(Arena arena, @Nullable CLCommandBufferKhr @NotNull [] values)
static CLCommandBufferKhr.Ptr	allocate(Arena arena, @NotNull Collection<@Nullable CLCommandBufferKhr> values)
static CLCommandBufferKhr.Ptr	allocateV(Arena arena, @Nullable CLCommandBufferKhr value0, @Nullable CLCommandBufferKhr... 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<CLCommandBufferKhr>	iterator()
CLCommandBufferKhr.Ptr	offset(long offset)
@Nullable CLCommandBufferKhr	read()
@Nullable CLCommandBufferKhr	read(long index)
@NotNull MemorySegment	readRaw()
@NotNull MemorySegment	readRaw(long index)
CLCommandBufferKhr.Ptr	reinterpret(long newSize)	Assume the CLCommandBufferKhr.Ptr is capable of holding at least newSize handles, create a new view CLCommandBufferKhr.Ptr that uses the same backing storage as this CLCommandBufferKhr.Ptr, but with the new size.
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
CLCommandBufferKhr.Ptr	slice(long end)
CLCommandBufferKhr.Ptr	slice(long start, long end)	Note that this function uses the List.subList(int, int) semantics (left inclusive, right exclusive interval), not MemorySegment.asSlice(long, long) semantics (offset + newSize).
final String	toString()	Returns a string representation of this record class.
void	write(long index, @Nullable CLCommandBufferKhr value)
void	write(@Nullable CLCommandBufferKhr value)
void	write(@Nullable CLCommandBufferKhr[] values)
void	writeRaw(long index, @NotNull MemorySegment value)
void	writeRaw(@NotNull MemorySegment value)
void	writeV(@Nullable CLCommandBufferKhr value0, @Nullable CLCommandBufferKhr... 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 CLCommandBufferKhr read()

write

public void write(@Nullable
 @Nullable CLCommandBufferKhr value)

read

@Nullable
public @Nullable CLCommandBufferKhr read(long index)

write

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

write

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

writeV

public void writeV(@Nullable
 @Nullable CLCommandBufferKhr value0,
 @Nullable
 @Nullable CLCommandBufferKhr... 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 CLCommandBufferKhr.Ptr reinterpret(long newSize)

Assume the CLCommandBufferKhr.Ptr is capable of holding at least newSize handles, create a new view CLCommandBufferKhr.Ptr that uses the same backing storage as this CLCommandBufferKhr.Ptr, but with the new size. Since there is actually no way to really check whether the new size is valid, while buffer overflow is undefined behavior, this method is marked as Unsafe.

This method could be useful when handling data returned from some C API, where the size of the data is not known in advance.

If the size of the underlying segment is actually known in advance and correctly set, and you want to create a shrunk view, you may use slice(long) (with validation) instead.

offset

public CLCommandBufferKhr.Ptr offset(long offset)

slice

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

Note that this function uses the List.subList(int, int) semantics (left inclusive, right exclusive interval), not MemorySegment.asSlice(long, long) semantics (offset + newSize). Be careful with the difference

slice

public CLCommandBufferKhr.Ptr slice(long end)

allocate

public static CLCommandBufferKhr.Ptr allocate(Arena arena)

allocate

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

allocate

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

allocate

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

allocateV

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

iterator

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

Specified by:

iterator in interface Iterable<CLCommandBufferKhr>

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