Record Class SDL_Locale

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

A struct to provide locale data.

Locale data is split into a spoken language, like English, and an optional country, like Canada. The language will be in ISO-639 format (so English would be "en"), and the country, if not NULL, will be an ISO-3166 country code (so Canada would be "CA").

Since: This function is available since SDL 3.2.0.

See also:

  • SDL_GetPreferredLocales

Structure

typedef struct SDL_Locale {
    char const* language;
    char const* country;
} SDL_Locale;

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

      public static final MemoryLayout.PathElement PATH$language

    • PATH$country

      public static final MemoryLayout.PathElement PATH$country

    • LAYOUT$language

      public static final AddressLayout LAYOUT$language

    • LAYOUT$country

      public static final AddressLayout LAYOUT$country

    • SIZE$language

      public static final long SIZE$language

    • SIZE$country

      public static final long SIZE$country

    • OFFSET$language

      public static final long OFFSET$language

    • OFFSET$country

      public static final long OFFSET$country

  • Constructor Details

    • SDL_Locale

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

  • Method Details

    • allocate

      public static SDL_Locale allocate(Arena arena)

    • allocate

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

    • clone

      public static SDL_Locale clone(Arena arena, SDL_Locale src)

    • language

      @Nullable public @Nullable BytePtr language()
      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.

    • language

      public SDL_Locale language(@Nullable @Nullable BytePtr value)

    • languageRaw

      @Pointer(comment="int8_t*") public MemorySegment languageRaw()

    • languageRaw

      public void languageRaw(@Pointer(comment="int8_t*") MemorySegment value)

    • country

      @Nullable public @Nullable BytePtr country()
      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.

    • country

      public SDL_Locale country(@Nullable @Nullable BytePtr value)

    • countryRaw

      @Pointer(comment="int8_t*") public MemorySegment countryRaw()

    • countryRaw

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