Record Class CLImageFormat

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

Represents a pointer to a cl_image_format structure in native memory.

Structure

typedef struct cl_image_format {
    cl_channel_order imageChannelOrder;
    cl_channel_type imageChannelDataType;
} cl_image_format;

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$imageChannelOrder

      public static final MemoryLayout.PathElement PATH$imageChannelOrder

    • PATH$imageChannelDataType

      public static final MemoryLayout.PathElement PATH$imageChannelDataType

    • LAYOUT$imageChannelOrder

      public static final ValueLayout.OfInt LAYOUT$imageChannelOrder

    • LAYOUT$imageChannelDataType

      public static final ValueLayout.OfInt LAYOUT$imageChannelDataType

    • SIZE$imageChannelOrder

      public static final long SIZE$imageChannelOrder

    • SIZE$imageChannelDataType

      public static final long SIZE$imageChannelDataType

    • OFFSET$imageChannelOrder

      public static final long OFFSET$imageChannelOrder

    • OFFSET$imageChannelDataType

      public static final long OFFSET$imageChannelDataType

  • Constructor Details

    • CLImageFormat

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

  • Method Details

    • allocate

      public static CLImageFormat allocate(Arena arena)

    • allocate

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

    • clone

      public static CLImageFormat clone(Arena arena, CLImageFormat src)

    • imageChannelOrder

      @NativeType("cl_channel_order") @Unsigned public int imageChannelOrder()

    • imageChannelOrder

      public CLImageFormat imageChannelOrder(@NativeType("cl_channel_order") @Unsigned int value)

    • imageChannelDataType

      @NativeType("cl_channel_type") @Unsigned public int imageChannelDataType()

    • imageChannelDataType

      public CLImageFormat imageChannelDataType(@NativeType("cl_channel_type") @Unsigned int 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 IPointer
      Returns:
      the value of the segment record component