Record Class StdVideoDecodeAV1ReferenceInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.StdVideoDecodeAV1ReferenceInfo

All Implemented Interfaces:

IPointer, IStdVideoDecodeAV1ReferenceInfo

@ValueBasedCandidate
@UnsafeConstructor
public record StdVideoDecodeAV1ReferenceInfo(@NotNull MemorySegment segment)
extends Record
implements IStdVideoDecodeAV1ReferenceInfo

Represents a pointer to a StdVideoDecodeAV1ReferenceInfo structure in native memory.

Structure

typedef struct StdVideoDecodeAV1ReferenceInfo {
    StdVideoDecodeAV1ReferenceInfoFlags flags;
    uint8_t frame_type;
    uint8_t RefFrameSignBias;
    uint8_t OrderHint;
    uint8_t[STD_VIDEO_AV1_NUM_REF_FRAMES] SavedOrderHints;
} StdVideoDecodeAV1ReferenceInfo;

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	StdVideoDecodeAV1ReferenceInfo.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.OfByte	LAYOUT$frame_type
static final ValueLayout.OfByte	LAYOUT$OrderHint
static final ValueLayout.OfByte	LAYOUT$RefFrameSignBias
static final SequenceLayout	LAYOUT$SavedOrderHints
static final long	OFFSET$flags
static final long	OFFSET$frame_type
static final long	OFFSET$OrderHint
static final long	OFFSET$RefFrameSignBias
static final long	OFFSET$SavedOrderHints
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$frame_type
static final MemoryLayout.PathElement	PATH$OrderHint
static final MemoryLayout.PathElement	PATH$RefFrameSignBias
static final MemoryLayout.PathElement	PATH$SavedOrderHints
static final long	SIZE$flags
static final long	SIZE$frame_type
static final long	SIZE$OrderHint
static final long	SIZE$RefFrameSignBias
static final long	SIZE$SavedOrderHints

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static StdVideoDecodeAV1ReferenceInfo	allocate(Arena arena)
static StdVideoDecodeAV1ReferenceInfo.Ptr	allocate(Arena arena, long count)
static StdVideoDecodeAV1ReferenceInfo	clone(Arena arena, StdVideoDecodeAV1ReferenceInfo src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull StdVideoDecodeAV1ReferenceInfoFlags	flags()
StdVideoDecodeAV1ReferenceInfo	flags(@NotNull StdVideoDecodeAV1ReferenceInfoFlags value)
StdVideoDecodeAV1ReferenceInfo	flags(Consumer<@NotNull StdVideoDecodeAV1ReferenceInfoFlags> consumer)
byte	frame_type()
StdVideoDecodeAV1ReferenceInfo	frame_type(byte value)
final int	hashCode()	Returns a hash code value for this object.
byte	OrderHint()
StdVideoDecodeAV1ReferenceInfo	OrderHint(byte value)
byte	RefFrameSignBias()
StdVideoDecodeAV1ReferenceInfo	RefFrameSignBias(byte value)
BytePtr	SavedOrderHints()
StdVideoDecodeAV1ReferenceInfo	SavedOrderHints(BytePtr value)
MemorySegment	SavedOrderHintsRaw()
@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$frame_type

public static final MemoryLayout.PathElement PATH$frame_type

PATH$RefFrameSignBias

public static final MemoryLayout.PathElement PATH$RefFrameSignBias

PATH$OrderHint

public static final MemoryLayout.PathElement PATH$OrderHint

PATH$SavedOrderHints

public static final MemoryLayout.PathElement PATH$SavedOrderHints

LAYOUT$flags

public static final StructLayout LAYOUT$flags

LAYOUT$frame_type

public static final ValueLayout.OfByte LAYOUT$frame_type

LAYOUT$RefFrameSignBias

public static final ValueLayout.OfByte LAYOUT$RefFrameSignBias

LAYOUT$OrderHint

public static final ValueLayout.OfByte LAYOUT$OrderHint

LAYOUT$SavedOrderHints

public static final SequenceLayout LAYOUT$SavedOrderHints

SIZE$flags

public static final long SIZE$flags

SIZE$frame_type

public static final long SIZE$frame_type

SIZE$RefFrameSignBias

public static final long SIZE$RefFrameSignBias

SIZE$OrderHint

public static final long SIZE$OrderHint

SIZE$SavedOrderHints

public static final long SIZE$SavedOrderHints

OFFSET$flags

public static final long OFFSET$flags

OFFSET$frame_type

public static final long OFFSET$frame_type

OFFSET$RefFrameSignBias

public static final long OFFSET$RefFrameSignBias

OFFSET$OrderHint

public static final long OFFSET$OrderHint

OFFSET$SavedOrderHints

public static final long OFFSET$SavedOrderHints

Constructor Details

StdVideoDecodeAV1ReferenceInfo

public StdVideoDecodeAV1ReferenceInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a StdVideoDecodeAV1ReferenceInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static StdVideoDecodeAV1ReferenceInfo allocate(Arena arena)

allocate

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

clone

public static StdVideoDecodeAV1ReferenceInfo clone(Arena arena,
 StdVideoDecodeAV1ReferenceInfo src)

flags

@NotNull
public @NotNull StdVideoDecodeAV1ReferenceInfoFlags flags()

flags

public StdVideoDecodeAV1ReferenceInfo flags(@NotNull
 @NotNull StdVideoDecodeAV1ReferenceInfoFlags value)

flags

public StdVideoDecodeAV1ReferenceInfo flags(Consumer<@NotNull StdVideoDecodeAV1ReferenceInfoFlags> consumer)

frame_type

@Unsigned
public byte frame_type()

frame_type

public StdVideoDecodeAV1ReferenceInfo frame_type(@Unsigned
 byte value)

RefFrameSignBias

@Unsigned
public byte RefFrameSignBias()

RefFrameSignBias

public StdVideoDecodeAV1ReferenceInfo RefFrameSignBias(@Unsigned
 byte value)

OrderHint

@Unsigned
public byte OrderHint()

OrderHint

public StdVideoDecodeAV1ReferenceInfo OrderHint(@Unsigned
 byte value)

SavedOrderHints

@Unsigned
public BytePtr SavedOrderHints()

SavedOrderHints

public StdVideoDecodeAV1ReferenceInfo SavedOrderHints(@Unsigned
 BytePtr value)

SavedOrderHintsRaw

public MemorySegment SavedOrderHintsRaw()

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