Record Class SDL_GPUBufferRegion

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

A structure specifying a region of a buffer.

Used when transferring data to or from buffers.

Since: This struct is available since SDL 3.2.0.

See also:

  • SDL_UploadToGPUBuffer
  • SDL_DownloadFromGPUBuffer

Structure

typedef struct SDL_GPUBufferRegion {
    SDL_GPUBuffer* buffer;
    Uint32 offset;
    Uint32 size;
} SDL_GPUBufferRegion;

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

      public static final MemoryLayout.PathElement PATH$buffer

    • PATH$offset

      public static final MemoryLayout.PathElement PATH$offset

    • PATH$size

      public static final MemoryLayout.PathElement PATH$size

    • LAYOUT$buffer

      public static final AddressLayout LAYOUT$buffer

    • LAYOUT$offset

      public static final ValueLayout.OfInt LAYOUT$offset

    • LAYOUT$size

      public static final ValueLayout.OfInt LAYOUT$size

    • SIZE$buffer

      public static final long SIZE$buffer

    • SIZE$offset

      public static final long SIZE$offset

    • SIZE$size

      public static final long SIZE$size

    • OFFSET$buffer

      public static final long OFFSET$buffer

    • OFFSET$offset

      public static final long OFFSET$offset

    • OFFSET$size

      public static final long OFFSET$size

  • Constructor Details

    • SDL_GPUBufferRegion

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

  • Method Details

    • allocate

      public static SDL_GPUBufferRegion allocate(Arena arena)

    • allocate

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

    • clone

      public static SDL_GPUBufferRegion clone(Arena arena, SDL_GPUBufferRegion src)

    • buffer

      @Nullable public @Nullable SDL_GPUBuffer buffer()

    • buffer

      public SDL_GPUBufferRegion buffer(@Nullable @Nullable SDL_GPUBuffer value)

    • offset

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

    • offset

      public SDL_GPUBufferRegion offset(@NativeType("Uint32") @Unsigned int value)

    • size

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

    • size

      public SDL_GPUBufferRegion size(@NativeType("Uint32") @Unsigned 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