Record Class SDL_AtomicU32.Ptr

java.lang.Object
java.lang.Record
club.doki7.sdl3.datatype.SDL_AtomicU32.Ptr
All Implemented Interfaces:
IPointer, ISDL_AtomicU32, Iterable<SDL_AtomicU32>
Enclosing class:
SDL_AtomicU32

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

Represents a pointer to / an array of null structure(s) in native memory.

Technically speaking, this type has no difference with SDL_AtomicU32. This type is introduced mainly for user to distinguish between a pointer to a single structure and a pointer to (potentially) an array of structure(s). APIs should use interface ISDL_AtomicU32 to handle both types uniformly. See package level documentation for more details.

Contracts Link icon

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

  • Constructor Details Link icon

    • Ptr Link icon

      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 Link icon

    • size Link icon

      public long size()
    • at Link icon

      @NotNull public @NotNull SDL_AtomicU32 at(long index)

      Returns (a pointer to) the structure at the given index.

      Note that unlike read series functions (IntPtr.read() for example), modification on returned structure will be reflected on the original structure array. So this function is called at to explicitly indicate that the returned structure is a view of the original structure.

    • write Link icon

      public void write(long index, @NotNull @NotNull SDL_AtomicU32 value)
    • reinterpret Link icon

      @Unsafe @NotNull public @NotNull SDL_AtomicU32.Ptr reinterpret(long newSize)

      Assume the SDL_AtomicU32.Ptr is capable of holding at least newSize structures, create a new view SDL_AtomicU32.Ptr that uses the same backing storage as this SDL_AtomicU32.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 Link icon

      @NotNull public @NotNull SDL_AtomicU32.Ptr offset(long offset)
    • slice Link icon

      @NotNull public @NotNull SDL_AtomicU32.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 Link icon

      public SDL_AtomicU32.Ptr slice(long end)
    • toArray Link icon

      public SDL_AtomicU32[] toArray()
    • iterator Link icon

      @NotNull public @NotNull Iterator<SDL_AtomicU32> iterator()
      Specified by:
      iterator in interface Iterable<SDL_AtomicU32>
    • toString Link icon

      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 Link icon

      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 Link icon

      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 Link icon

      @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