Record Class CLMemIonHostPtr

java.lang.Object
java.lang.Record
club.doki7.opencl.datatype.CLMemIonHostPtr
All Implemented Interfaces:
IPointer, ICLMemIonHostPtr
@ValueBasedCandidate @UnsafeConstructor public record CLMemIonHostPtr(@NotNull MemorySegment segment) extends Record implements ICLMemIonHostPtr

Represents a pointer to a cl_mem_ion_host_ptr structure in native memory.

Structure

typedef struct cl_mem_ion_host_ptr {
    cl_mem_ext_host_ptr extHostPtr;
    int ionFiledesc;
    void* ionHostptr;
} cl_mem_ion_host_ptr;

Contracts

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

See Also:

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$extHostPtr

      public static final MemoryLayout.PathElement PATH$extHostPtr

    • PATH$ionFiledesc

      public static final MemoryLayout.PathElement PATH$ionFiledesc

    • PATH$ionHostptr

      public static final MemoryLayout.PathElement PATH$ionHostptr

    • LAYOUT$extHostPtr

      public static final StructLayout LAYOUT$extHostPtr

    • LAYOUT$ionFiledesc

      public static final ValueLayout.OfInt LAYOUT$ionFiledesc

    • LAYOUT$ionHostptr

      public static final AddressLayout LAYOUT$ionHostptr

    • SIZE$extHostPtr

      public static final long SIZE$extHostPtr

    • SIZE$ionFiledesc

      public static final long SIZE$ionFiledesc

    • SIZE$ionHostptr

      public static final long SIZE$ionHostptr

    • OFFSET$extHostPtr

      public static final long OFFSET$extHostPtr

    • OFFSET$ionFiledesc

      public static final long OFFSET$ionFiledesc

    • OFFSET$ionHostptr

      public static final long OFFSET$ionHostptr

  • Constructor Details

    • CLMemIonHostPtr

      public CLMemIonHostPtr(@NotNull @NotNull MemorySegment segment)
      Creates an instance of a CLMemIonHostPtr record class.
      Parameters:
      segment - the value for the segment record component

  • Method Details

    • allocate

      public static CLMemIonHostPtr allocate(Arena arena)

    • allocate

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

    • clone

      public static CLMemIonHostPtr clone(Arena arena, CLMemIonHostPtr src)

    • extHostPtr

      @NotNull public @NotNull CLMemExtHostPtr extHostPtr()

    • extHostPtr

      public CLMemIonHostPtr extHostPtr(@NotNull @NotNull CLMemExtHostPtr value)

    • extHostPtr

      public CLMemIonHostPtr extHostPtr(Consumer<@NotNull CLMemExtHostPtr> consumer)

    • ionFiledesc

      public int ionFiledesc()

    • ionFiledesc

      public CLMemIonHostPtr ionFiledesc(int value)

    • ionHostptr

      @Pointer(comment="void*") @NotNull public @NotNull MemorySegment ionHostptr()

    • ionHostptr

      public CLMemIonHostPtr ionHostptr(@Pointer(comment="void*") @NotNull @NotNull MemorySegment value)

    • ionHostptr

      public CLMemIonHostPtr ionHostptr(@Nullable @Nullable IPointer pointer)

    • 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