Record Class CLMem.Ptr

java.lang.Object
java.lang.Record
club.doki7.opencl.handle.CLMem.Ptr
All Implemented Interfaces:
IPointer, Iterable<CLMem>
Enclosing class:
CLMem
@ValueBasedCandidate @UnsafeConstructor public static record CLMem.Ptr(@NotNull MemorySegment segment) extends Record implements IPointer, Iterable<CLMem>

Represents a pointer to cl_mem 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 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)

      Assume the CLMem.Ptr is capable of holding at least newSize handles, create a new view CLMem.Ptr that uses the same backing storage as this CLMem.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 CLMem.Ptr offset(long offset)

    • slice

      public CLMem.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 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 IPointer
      Returns:
      the value of the segment record component