Record Class SDL_Color

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

A structure that represents a color as RGBA components.

The bits of this structure can be directly reinterpreted as an integer-packed color which uses the SDL_PIXELFORMAT_RGBA32 format (SDL_PIXELFORMAT_ABGR8888 on little-endian systems and SDL_PIXELFORMAT_RGBA8888 on big-endian systems).

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_Color {
    Uint8 r;
    Uint8 g;
    Uint8 b;
    Uint8 a;
} SDL_Color;

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

      public static final MemoryLayout.PathElement PATH$r

    • PATH$g

      public static final MemoryLayout.PathElement PATH$g

    • PATH$b

      public static final MemoryLayout.PathElement PATH$b

    • PATH$a

      public static final MemoryLayout.PathElement PATH$a

    • LAYOUT$r

      public static final ValueLayout.OfByte LAYOUT$r

    • LAYOUT$g

      public static final ValueLayout.OfByte LAYOUT$g

    • LAYOUT$b

      public static final ValueLayout.OfByte LAYOUT$b

    • LAYOUT$a

      public static final ValueLayout.OfByte LAYOUT$a

    • SIZE$r

      public static final long SIZE$r

    • SIZE$g

      public static final long SIZE$g

    • SIZE$b

      public static final long SIZE$b

    • SIZE$a

      public static final long SIZE$a

    • OFFSET$r

      public static final long OFFSET$r

    • OFFSET$g

      public static final long OFFSET$g

    • OFFSET$b

      public static final long OFFSET$b

    • OFFSET$a

      public static final long OFFSET$a

  • Constructor Details

    • SDL_Color

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

  • Method Details

    • allocate

      public static SDL_Color allocate(Arena arena)

    • allocate

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

    • clone

      public static SDL_Color clone(Arena arena, SDL_Color src)

    • r

      @NativeType("Uint8") @Unsigned public byte r()

    • r

      public SDL_Color r(@NativeType("Uint8") @Unsigned byte value)

    • g

      @NativeType("Uint8") @Unsigned public byte g()

    • g

      public SDL_Color g(@NativeType("Uint8") @Unsigned byte value)

    • b

      @NativeType("Uint8") @Unsigned public byte b()

    • b

      public SDL_Color b(@NativeType("Uint8") @Unsigned byte value)

    • a

      @NativeType("Uint8") @Unsigned public byte a()

    • a

      public SDL_Color a(@NativeType("Uint8") @Unsigned byte 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