Record Class SDL_InitState

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

A structure used for thread-safe initialization and shutdown.

Here is an example of using this:

static SDL_AtomicInitState init;

bool InitSystem(void)
{
if (!SDL_ShouldInit(&init)) {
// The system is initialized
return true;
}

// At this point, you should not leave this function without calling SDL_SetInitialized()

bool initialized = DoInitTasks();
SDL_SetInitialized(&init, initialized);
return initialized;
}

bool UseSubsystem(void)
{
if (SDL_ShouldInit(&init)) {
// Error, the subsystem isn't initialized
SDL_SetInitialized(&init, false);
return false;
}

// Do work using the initialized subsystem

return true;
}

void QuitSystem(void)
{
if (!SDL_ShouldQuit(&init)) {
// The system is not initialized
return;
}

// At this point, you should not leave this function without calling SDL_SetInitialized()

DoQuitTasks();
SDL_SetInitialized(&init, false);
}

Note that this doesn't protect any resources created during initialization, or guarantee that nobody is using those resources during cleanup. You should use other mechanisms to protect those, if that's a concern for your code.

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_InitState {
    SDL_AtomicInt status;
    SDL_ThreadID thread;
    void* reserved;
} SDL_InitState;

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

      public static final MemoryLayout.PathElement PATH$status

    • PATH$thread

      public static final MemoryLayout.PathElement PATH$thread

    • LAYOUT$status

      public static final StructLayout LAYOUT$status

    • LAYOUT$thread

      public static final ValueLayout.OfLong LAYOUT$thread

    • SIZE$status

      public static final long SIZE$status

    • SIZE$thread

      public static final long SIZE$thread

    • OFFSET$status

      public static final long OFFSET$status

    • OFFSET$thread

      public static final long OFFSET$thread

  • Constructor Details

    • SDL_InitState

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

  • Method Details

    • allocate

      public static SDL_InitState allocate(Arena arena)

    • allocate

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

    • clone

      public static SDL_InitState clone(Arena arena, SDL_InitState src)

    • status

      @NotNull public @NotNull SDL_AtomicInt status()

    • status

      public SDL_InitState status(@NotNull @NotNull SDL_AtomicInt value)

    • status

      public SDL_InitState status(Consumer<@NotNull SDL_AtomicInt> consumer)

    • thread

      @NativeType("SDL_ThreadID") @Unsigned public long thread()

    • thread

      public SDL_InitState thread(@NativeType("SDL_ThreadID") @Unsigned long 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