Record Class StdVideoDecodeH264ReferenceInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.StdVideoDecodeH264ReferenceInfo

All Implemented Interfaces:

IPointer, IStdVideoDecodeH264ReferenceInfo

@ValueBasedCandidate
@UnsafeConstructor
public record StdVideoDecodeH264ReferenceInfo(@NotNull MemorySegment segment)
extends Record
implements IStdVideoDecodeH264ReferenceInfo

Represents a pointer to a StdVideoDecodeH264ReferenceInfo structure in native memory.

Structure

typedef struct StdVideoDecodeH264ReferenceInfo {
    StdVideoDecodeH264ReferenceInfoFlags flags;
    uint16_t FrameNum;
    uint16_t reserved;
    int32_t[STD_VIDEO_DECODE_H264_FIELD_ORDER_COUNT_LIST_SIZE] PicOrderCnt;
} StdVideoDecodeH264ReferenceInfo;

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	StdVideoDecodeH264ReferenceInfo.Ptr	Represents a pointer to / an array of null structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final StructLayout	LAYOUT$flags
static final ValueLayout.OfShort	LAYOUT$FrameNum
static final SequenceLayout	LAYOUT$PicOrderCnt
static final long	OFFSET$flags
static final long	OFFSET$FrameNum
static final long	OFFSET$PicOrderCnt
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$FrameNum
static final MemoryLayout.PathElement	PATH$PicOrderCnt
static final long	SIZE$flags
static final long	SIZE$FrameNum
static final long	SIZE$PicOrderCnt

Constructor Summary

Constructors

Constructor	Description
StdVideoDecodeH264ReferenceInfo(@NotNull MemorySegment segment)	Creates an instance of a StdVideoDecodeH264ReferenceInfo record class.

Method Summary

Modifier and Type	Method	Description
static StdVideoDecodeH264ReferenceInfo	allocate(Arena arena)
static StdVideoDecodeH264ReferenceInfo.Ptr	allocate(Arena arena, long count)
static StdVideoDecodeH264ReferenceInfo	clone(Arena arena, StdVideoDecodeH264ReferenceInfo src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull StdVideoDecodeH264ReferenceInfoFlags	flags()
StdVideoDecodeH264ReferenceInfo	flags(@NotNull StdVideoDecodeH264ReferenceInfoFlags value)
StdVideoDecodeH264ReferenceInfo	flags(Consumer<@NotNull StdVideoDecodeH264ReferenceInfoFlags> consumer)
short	FrameNum()
StdVideoDecodeH264ReferenceInfo	FrameNum(short value)
final int	hashCode()	Returns a hash code value for this object.
IntPtr	PicOrderCnt()
StdVideoDecodeH264ReferenceInfo	PicOrderCnt(IntPtr value)
MemorySegment	PicOrderCntRaw()
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LAYOUT

public static final StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$flags

public static final MemoryLayout.PathElement PATH$flags

PATH$FrameNum

public static final MemoryLayout.PathElement PATH$FrameNum

PATH$PicOrderCnt

public static final MemoryLayout.PathElement PATH$PicOrderCnt

LAYOUT$flags

public static final StructLayout LAYOUT$flags

LAYOUT$FrameNum

public static final ValueLayout.OfShort LAYOUT$FrameNum

LAYOUT$PicOrderCnt

public static final SequenceLayout LAYOUT$PicOrderCnt

SIZE$flags

public static final long SIZE$flags

SIZE$FrameNum

public static final long SIZE$FrameNum

SIZE$PicOrderCnt

public static final long SIZE$PicOrderCnt

OFFSET$flags

public static final long OFFSET$flags

OFFSET$FrameNum

public static final long OFFSET$FrameNum

OFFSET$PicOrderCnt

public static final long OFFSET$PicOrderCnt

Constructor Details

StdVideoDecodeH264ReferenceInfo

public StdVideoDecodeH264ReferenceInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a StdVideoDecodeH264ReferenceInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static StdVideoDecodeH264ReferenceInfo allocate(Arena arena)

allocate

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

clone

public static StdVideoDecodeH264ReferenceInfo clone(Arena arena,
 StdVideoDecodeH264ReferenceInfo src)

flags

@NotNull
public @NotNull StdVideoDecodeH264ReferenceInfoFlags flags()

flags

public StdVideoDecodeH264ReferenceInfo flags(@NotNull
 @NotNull StdVideoDecodeH264ReferenceInfoFlags value)

flags

public StdVideoDecodeH264ReferenceInfo flags(Consumer<@NotNull StdVideoDecodeH264ReferenceInfoFlags> consumer)

FrameNum

@Unsigned
public short FrameNum()

FrameNum

public StdVideoDecodeH264ReferenceInfo FrameNum(@Unsigned
 short value)

PicOrderCnt

public IntPtr PicOrderCnt()

PicOrderCnt

public StdVideoDecodeH264ReferenceInfo PicOrderCnt(IntPtr value)

PicOrderCntRaw

public MemorySegment PicOrderCntRaw()

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