Record Class GLFWimage

java.lang.Object
java.lang.Record
club.doki7.glfw.datatype.GLFWimage
All Implemented Interfaces:
IPointer, IGLFWimage
@ValueBasedCandidate @UnsafeConstructor public record GLFWimage(@NotNull MemorySegment segment) extends Record implements IGLFWimage
Since:
Added in version 2.1.

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$width

      public static final MemoryLayout.PathElement PATH$width

    • PATH$height

      public static final MemoryLayout.PathElement PATH$height

    • PATH$pixels

      public static final MemoryLayout.PathElement PATH$pixels

    • LAYOUT$width

      public static final ValueLayout.OfInt LAYOUT$width

    • LAYOUT$height

      public static final ValueLayout.OfInt LAYOUT$height

    • LAYOUT$pixels

      public static final AddressLayout LAYOUT$pixels

    • SIZE$width

      public static final long SIZE$width

    • SIZE$height

      public static final long SIZE$height

    • SIZE$pixels

      public static final long SIZE$pixels

    • OFFSET$width

      public static final long OFFSET$width

    • OFFSET$height

      public static final long OFFSET$height

    • OFFSET$pixels

      public static final long OFFSET$pixels

  • Constructor Details

    • GLFWimage

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

  • Method Details

    • allocate

      public static GLFWimage allocate(Arena arena)

    • allocate

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

    • clone

      public static GLFWimage clone(Arena arena, GLFWimage src)

    • width

      public int width()

    • width

      public GLFWimage width(int value)

    • height

      public int height()

    • height

      public GLFWimage height(int value)

    • pixels

      @Nullable public @Nullable BytePtr pixels()
      Note: the returned BytePtr does not have correct BytePtr.size() property. It's up to user to track the size of the buffer, and use BytePtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

    • pixels

      public GLFWimage pixels(@Nullable @Nullable BytePtr value)

    • pixelsRaw

      @Pointer(comment="int8_t*") @NotNull public @NotNull MemorySegment pixelsRaw()

    • pixelsRaw

      public void pixelsRaw(@Pointer(comment="int8_t*") @NotNull @NotNull MemorySegment 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