Record Class VkVideoEncodeAV1FrameSizeKHR

java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkVideoEncodeAV1FrameSizeKHR
All Implemented Interfaces:
IPointer, IVkVideoEncodeAV1FrameSizeKHR

@ValueBasedCandidate @UnsafeConstructor public record VkVideoEncodeAV1FrameSizeKHR(@NotNull MemorySegment segment) extends Record implements IVkVideoEncodeAV1FrameSizeKHR

Represents a pointer to a VkVideoEncodeAV1FrameSizeKHR structure in native memory.

Structure

typedef struct VkVideoEncodeAV1FrameSizeKHR {
    uint32_t intraFrameSize;
    uint32_t predictiveFrameSize;
    uint32_t bipredictiveFrameSize;
} VkVideoEncodeAV1FrameSizeKHR;

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

      public static final MemoryLayout.PathElement PATH$intraFrameSize
    • PATH$predictiveFrameSize

      public static final MemoryLayout.PathElement PATH$predictiveFrameSize
    • PATH$bipredictiveFrameSize

      public static final MemoryLayout.PathElement PATH$bipredictiveFrameSize
    • LAYOUT$intraFrameSize

      public static final ValueLayout.OfInt LAYOUT$intraFrameSize
    • LAYOUT$predictiveFrameSize

      public static final ValueLayout.OfInt LAYOUT$predictiveFrameSize
    • LAYOUT$bipredictiveFrameSize

      public static final ValueLayout.OfInt LAYOUT$bipredictiveFrameSize
    • SIZE$intraFrameSize

      public static final long SIZE$intraFrameSize
    • SIZE$predictiveFrameSize

      public static final long SIZE$predictiveFrameSize
    • SIZE$bipredictiveFrameSize

      public static final long SIZE$bipredictiveFrameSize
    • OFFSET$intraFrameSize

      public static final long OFFSET$intraFrameSize
    • OFFSET$predictiveFrameSize

      public static final long OFFSET$predictiveFrameSize
    • OFFSET$bipredictiveFrameSize

      public static final long OFFSET$bipredictiveFrameSize
  • Constructor Details

    • VkVideoEncodeAV1FrameSizeKHR

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

    • allocate

      public static VkVideoEncodeAV1FrameSizeKHR allocate(Arena arena)
    • allocate

      public static VkVideoEncodeAV1FrameSizeKHR.Ptr allocate(Arena arena, long count)
    • clone

    • intraFrameSize

      @Unsigned public int intraFrameSize()
    • intraFrameSize

      public VkVideoEncodeAV1FrameSizeKHR intraFrameSize(@Unsigned int value)
    • predictiveFrameSize

      @Unsigned public int predictiveFrameSize()
    • predictiveFrameSize

      public VkVideoEncodeAV1FrameSizeKHR predictiveFrameSize(@Unsigned int value)
    • bipredictiveFrameSize

      @Unsigned public int bipredictiveFrameSize()
    • bipredictiveFrameSize

      public VkVideoEncodeAV1FrameSizeKHR bipredictiveFrameSize(@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