Record Class StdVideoAV1FilmGrainFlags

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

Represents a pointer to a StdVideoAV1FilmGrainFlags structure in native memory.

Structure

typedef struct StdVideoAV1FilmGrainFlags {
    uint32_t chroma_scaling_from_luma : 1;
    uint32_t overlap_flag : 1;
    uint32_t clip_to_restricted_range : 1;
    uint32_t update_grain : 1;
    uint32_t reserved : 28;
} StdVideoAV1FilmGrainFlags;

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$bitfield$chroma_scaling_from_luma$reserved

      public static final MemoryLayout.PathElement PATH$bitfield$chroma_scaling_from_luma$reserved

    • LAYOUT$bitfield$chroma_scaling_from_luma$reserved

      public static final ValueLayout.OfInt LAYOUT$bitfield$chroma_scaling_from_luma$reserved

    • OFFSET$bitfield$chroma_scaling_from_luma$reserved

      public static final long OFFSET$bitfield$chroma_scaling_from_luma$reserved

  • Constructor Details

    • StdVideoAV1FilmGrainFlags

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

  • Method Details

    • allocate

      public static StdVideoAV1FilmGrainFlags allocate(Arena arena)

    • allocate

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

    • clone

      public static StdVideoAV1FilmGrainFlags clone(Arena arena, StdVideoAV1FilmGrainFlags src)

    • chroma_scaling_from_luma

      public boolean chroma_scaling_from_luma()

    • chroma_scaling_from_luma

      public StdVideoAV1FilmGrainFlags chroma_scaling_from_luma(boolean value)

    • overlap_flag

      public boolean overlap_flag()

    • overlap_flag

      public StdVideoAV1FilmGrainFlags overlap_flag(boolean value)

    • clip_to_restricted_range

      public boolean clip_to_restricted_range()

    • clip_to_restricted_range

      public StdVideoAV1FilmGrainFlags clip_to_restricted_range(boolean value)

    • update_grain

      public boolean update_grain()

    • update_grain

      public StdVideoAV1FilmGrainFlags update_grain(boolean 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