Record Class StdVideoAV1Segmentation

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

Represents a pointer to a StdVideoAV1Segmentation structure in native memory.

Structure

typedef struct StdVideoAV1Segmentation {
    uint8_t[STD_VIDEO_AV1_MAX_SEGMENTS] FeatureEnabled;
    int16_t[STD_VIDEO_AV1_SEG_LVL_MAX][STD_VIDEO_AV1_MAX_SEGMENTS] FeatureData;
} StdVideoAV1Segmentation;

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

      public static final MemoryLayout.PathElement PATH$FeatureEnabled

    • PATH$FeatureData

      public static final MemoryLayout.PathElement PATH$FeatureData

    • LAYOUT$FeatureEnabled

      public static final SequenceLayout LAYOUT$FeatureEnabled

    • LAYOUT$FeatureData

      public static final SequenceLayout LAYOUT$FeatureData

    • SIZE$FeatureEnabled

      public static final long SIZE$FeatureEnabled

    • SIZE$FeatureData

      public static final long SIZE$FeatureData

    • OFFSET$FeatureEnabled

      public static final long OFFSET$FeatureEnabled

    • OFFSET$FeatureData

      public static final long OFFSET$FeatureData

  • Constructor Details

    • StdVideoAV1Segmentation

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

  • Method Details

    • allocate

      public static StdVideoAV1Segmentation allocate(Arena arena)

    • allocate

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

    • clone

      public static StdVideoAV1Segmentation clone(Arena arena, StdVideoAV1Segmentation src)

    • FeatureEnabled

      @Unsigned public BytePtr FeatureEnabled()

    • FeatureEnabled

      public StdVideoAV1Segmentation FeatureEnabled(@NotNull @NotNull Consumer<BytePtr> consumer)

    • FeatureEnabled

      public StdVideoAV1Segmentation FeatureEnabled(@Unsigned BytePtr value)

    • FeatureEnabledRaw

      @NotNull public @NotNull MemorySegment FeatureEnabledRaw()

    • FeatureData

      public ShortPtr FeatureData()

    • FeatureData

      public StdVideoAV1Segmentation FeatureData(@NotNull @NotNull Consumer<ShortPtr> consumer)

    • FeatureData

      public StdVideoAV1Segmentation FeatureData(ShortPtr value)

    • FeatureDataRaw

      @NotNull public @NotNull MemorySegment FeatureDataRaw()

    • 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