Record Class VkVideoEncodeAV1QIndexKHR

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

Represents a pointer to a VkVideoEncodeAV1QIndexKHR structure in native memory.

Structure

typedef struct VkVideoEncodeAV1QIndexKHR {
    uint32_t intraQIndex;
    uint32_t predictiveQIndex;
    uint32_t bipredictiveQIndex;
} VkVideoEncodeAV1QIndexKHR;

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.

See Also:

  • Field Details

    • LAYOUT

      public static final StructLayout LAYOUT

    • BYTES

      public static final long BYTES

    • PATH$intraQIndex

      public static final MemoryLayout.PathElement PATH$intraQIndex

    • PATH$predictiveQIndex

      public static final MemoryLayout.PathElement PATH$predictiveQIndex

    • PATH$bipredictiveQIndex

      public static final MemoryLayout.PathElement PATH$bipredictiveQIndex

    • LAYOUT$intraQIndex

      public static final ValueLayout.OfInt LAYOUT$intraQIndex

    • LAYOUT$predictiveQIndex

      public static final ValueLayout.OfInt LAYOUT$predictiveQIndex

    • LAYOUT$bipredictiveQIndex

      public static final ValueLayout.OfInt LAYOUT$bipredictiveQIndex

    • SIZE$intraQIndex

      public static final long SIZE$intraQIndex

    • SIZE$predictiveQIndex

      public static final long SIZE$predictiveQIndex

    • SIZE$bipredictiveQIndex

      public static final long SIZE$bipredictiveQIndex

    • OFFSET$intraQIndex

      public static final long OFFSET$intraQIndex

    • OFFSET$predictiveQIndex

      public static final long OFFSET$predictiveQIndex

    • OFFSET$bipredictiveQIndex

      public static final long OFFSET$bipredictiveQIndex

  • Constructor Details

    • VkVideoEncodeAV1QIndexKHR

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

  • Method Details

    • allocate

      public static VkVideoEncodeAV1QIndexKHR allocate(Arena arena)

    • allocate

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

    • clone

      public static VkVideoEncodeAV1QIndexKHR clone(Arena arena, VkVideoEncodeAV1QIndexKHR src)

    • intraQIndex

      @Unsigned public int intraQIndex()

    • intraQIndex

      public VkVideoEncodeAV1QIndexKHR intraQIndex(@Unsigned int value)

    • predictiveQIndex

      @Unsigned public int predictiveQIndex()

    • predictiveQIndex

      public VkVideoEncodeAV1QIndexKHR predictiveQIndex(@Unsigned int value)

    • bipredictiveQIndex

      @Unsigned public int bipredictiveQIndex()

    • bipredictiveQIndex

      public VkVideoEncodeAV1QIndexKHR bipredictiveQIndex(@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