Record Class WGPUPushConstantRange

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

Represents a pointer to a WGPUPushConstantRange structure in native memory.

Structure

typedef struct WGPUPushConstantRange {
    WGPUShaderStage stages;
    uint32_t start;
    uint32_t end;
} WGPUPushConstantRange;

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

      public static final MemoryLayout.PathElement PATH$stages

    • PATH$start

      public static final MemoryLayout.PathElement PATH$start

    • PATH$end

      public static final MemoryLayout.PathElement PATH$end

    • LAYOUT$stages

      public static final ValueLayout.OfLong LAYOUT$stages

    • LAYOUT$start

      public static final ValueLayout.OfInt LAYOUT$start

    • LAYOUT$end

      public static final ValueLayout.OfInt LAYOUT$end

    • SIZE$stages

      public static final long SIZE$stages

    • SIZE$start

      public static final long SIZE$start

    • SIZE$end

      public static final long SIZE$end

    • OFFSET$stages

      public static final long OFFSET$stages

    • OFFSET$start

      public static final long OFFSET$start

    • OFFSET$end

      public static final long OFFSET$end

  • Constructor Details

    • WGPUPushConstantRange

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

  • Method Details

    • allocate

      public static WGPUPushConstantRange allocate(Arena arena)

    • allocate

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

    • clone

      public static WGPUPushConstantRange clone(Arena arena, WGPUPushConstantRange src)

    • stages

      @Bitmask(WGPUShaderStage.class) public long stages()

    • stages

      public WGPUPushConstantRange stages(@Bitmask(WGPUShaderStage.class) long value)

    • start

      @Unsigned public int start()

    • start

      public WGPUPushConstantRange start(@Unsigned int value)

    • end

      @Unsigned public int end()

    • end

      public WGPUPushConstantRange end(@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