Record Class WGPURegistryReport

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

Represents a pointer to a WGPURegistryReport structure in native memory.

Structure

typedef struct WGPURegistryReport {
    size_t numAllocated;
    size_t numKeptFromUser;
    size_t numReleasedFromUser;
    size_t elementSize;
} WGPURegistryReport;

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

      public static final MemoryLayout.PathElement PATH$numAllocated

    • PATH$numKeptFromUser

      public static final MemoryLayout.PathElement PATH$numKeptFromUser

    • PATH$numReleasedFromUser

      public static final MemoryLayout.PathElement PATH$numReleasedFromUser

    • PATH$elementSize

      public static final MemoryLayout.PathElement PATH$elementSize

    • SIZE$numAllocated

      public static final long SIZE$numAllocated

    • SIZE$numKeptFromUser

      public static final long SIZE$numKeptFromUser

    • SIZE$numReleasedFromUser

      public static final long SIZE$numReleasedFromUser

    • SIZE$elementSize

      public static final long SIZE$elementSize

    • OFFSET$numAllocated

      public static final long OFFSET$numAllocated

    • OFFSET$numKeptFromUser

      public static final long OFFSET$numKeptFromUser

    • OFFSET$numReleasedFromUser

      public static final long OFFSET$numReleasedFromUser

    • OFFSET$elementSize

      public static final long OFFSET$elementSize

  • Constructor Details

    • WGPURegistryReport

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

  • Method Details

    • allocate

      public static WGPURegistryReport allocate(Arena arena)

    • allocate

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

    • clone

      public static WGPURegistryReport clone(Arena arena, WGPURegistryReport src)

    • numAllocated

      @Unsigned public long numAllocated()

    • numAllocated

      public WGPURegistryReport numAllocated(@Unsigned long value)

    • numKeptFromUser

      @Unsigned public long numKeptFromUser()

    • numKeptFromUser

      public WGPURegistryReport numKeptFromUser(@Unsigned long value)

    • numReleasedFromUser

      @Unsigned public long numReleasedFromUser()

    • numReleasedFromUser

      public WGPURegistryReport numReleasedFromUser(@Unsigned long value)

    • elementSize

      @Unsigned public long elementSize()

    • elementSize

      public WGPURegistryReport elementSize(@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