Record Class SDL_Palette

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

A set of indexed colors representing a palette.

Since: This struct is available since SDL 3.2.0.

See also:

  • SDL_SetPaletteColors

Structure

typedef struct SDL_Palette {
    int ncolors;
    SDL_Color* colors;
    Uint32 version;
    int refcount;
} SDL_Palette;

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.

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$ncolors

      public static final MemoryLayout.PathElement PATH$ncolors

    • PATH$colors

      public static final MemoryLayout.PathElement PATH$colors

    • PATH$version

      public static final MemoryLayout.PathElement PATH$version

    • PATH$refcount

      public static final MemoryLayout.PathElement PATH$refcount

    • LAYOUT$ncolors

      public static final ValueLayout.OfInt LAYOUT$ncolors

    • LAYOUT$colors

      public static final AddressLayout LAYOUT$colors

    • LAYOUT$version

      public static final ValueLayout.OfInt LAYOUT$version

    • LAYOUT$refcount

      public static final ValueLayout.OfInt LAYOUT$refcount

    • SIZE$ncolors

      public static final long SIZE$ncolors

    • SIZE$colors

      public static final long SIZE$colors

    • SIZE$version

      public static final long SIZE$version

    • SIZE$refcount

      public static final long SIZE$refcount

    • OFFSET$ncolors

      public static final long OFFSET$ncolors

    • OFFSET$colors

      public static final long OFFSET$colors

    • OFFSET$version

      public static final long OFFSET$version

    • OFFSET$refcount

      public static final long OFFSET$refcount

  • Constructor Details

    • SDL_Palette

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

  • Method Details

    • allocate

      public static SDL_Palette allocate(Arena arena)

    • allocate

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

    • clone

      public static SDL_Palette clone(Arena arena, SDL_Palette src)

    • ncolors

      public int ncolors()

    • ncolors

      public SDL_Palette ncolors(int value)

    • colors

      public SDL_Palette colors(@Nullable @Nullable ISDL_Color value)

    • colors

      @Unsafe @Nullable public SDL_Color.Ptr colors(int assumedCount)

    • colors

      @Nullable public @Nullable SDL_Color colors()

    • colorsRaw

      @Pointer(target=SDL_Color.class) public MemorySegment colorsRaw()

    • colorsRaw

      public void colorsRaw(@Pointer(target=SDL_Color.class) MemorySegment value)

    • version

      @NativeType("Uint32") @Unsigned public int version()

    • version

      public SDL_Palette version(@NativeType("Uint32") @Unsigned int value)

    • refcount

      public int refcount()

    • refcount

      public SDL_Palette refcount(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