Record Class StdVideoAV1LoopRestoration

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.StdVideoAV1LoopRestoration

All Implemented Interfaces:

IPointer, IStdVideoAV1LoopRestoration

@ValueBasedCandidate
@UnsafeConstructor
public record StdVideoAV1LoopRestoration(@NotNull MemorySegment segment)
extends Record
implements IStdVideoAV1LoopRestoration

Represents a pointer to a StdVideoAV1LoopRestoration structure in native memory.

Structure

typedef struct StdVideoAV1LoopRestoration {
    StdVideoAV1FrameRestorationType[STD_VIDEO_AV1_MAX_NUM_PLANES] FrameRestorationType;
    uint16_t[STD_VIDEO_AV1_MAX_NUM_PLANES] LoopRestorationSize;
} StdVideoAV1LoopRestoration;

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	StdVideoAV1LoopRestoration.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 SequenceLayout	LAYOUT$FrameRestorationType
static final SequenceLayout	LAYOUT$LoopRestorationSize
static final long	OFFSET$FrameRestorationType
static final long	OFFSET$LoopRestorationSize
static final MemoryLayout.PathElement	PATH$FrameRestorationType
static final MemoryLayout.PathElement	PATH$LoopRestorationSize
static final long	SIZE$FrameRestorationType
static final long	SIZE$LoopRestorationSize

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static StdVideoAV1LoopRestoration	allocate(Arena arena)
static StdVideoAV1LoopRestoration.Ptr	allocate(Arena arena, long count)
static StdVideoAV1LoopRestoration	clone(Arena arena, StdVideoAV1LoopRestoration src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
IntPtr	FrameRestorationType()
StdVideoAV1LoopRestoration	FrameRestorationType(IntPtr value)
StdVideoAV1LoopRestoration	FrameRestorationType(@NotNull Consumer<IntPtr> consumer)
@NotNull MemorySegment	FrameRestorationTypeRaw()
final int	hashCode()	Returns a hash code value for this object.
ShortPtr	LoopRestorationSize()
StdVideoAV1LoopRestoration	LoopRestorationSize(ShortPtr value)
StdVideoAV1LoopRestoration	LoopRestorationSize(@NotNull Consumer<ShortPtr> consumer)
@NotNull MemorySegment	LoopRestorationSizeRaw()
@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$FrameRestorationType

public static final MemoryLayout.PathElement PATH$FrameRestorationType

PATH$LoopRestorationSize

public static final MemoryLayout.PathElement PATH$LoopRestorationSize

LAYOUT$FrameRestorationType

public static final SequenceLayout LAYOUT$FrameRestorationType

LAYOUT$LoopRestorationSize

public static final SequenceLayout LAYOUT$LoopRestorationSize

SIZE$FrameRestorationType

public static final long SIZE$FrameRestorationType

SIZE$LoopRestorationSize

public static final long SIZE$LoopRestorationSize

OFFSET$FrameRestorationType

public static final long OFFSET$FrameRestorationType

OFFSET$LoopRestorationSize

public static final long OFFSET$LoopRestorationSize

Constructor Details

StdVideoAV1LoopRestoration

public StdVideoAV1LoopRestoration(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a StdVideoAV1LoopRestoration record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static StdVideoAV1LoopRestoration allocate(Arena arena)

allocate

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

clone

public static StdVideoAV1LoopRestoration clone(Arena arena,
 StdVideoAV1LoopRestoration src)

FrameRestorationType

@EnumType(StdVideoAV1FrameRestorationType.class)
public IntPtr FrameRestorationType()

FrameRestorationType

public StdVideoAV1LoopRestoration FrameRestorationType(@NotNull
 @NotNull Consumer<IntPtr> consumer)

FrameRestorationType

public StdVideoAV1LoopRestoration FrameRestorationType(@EnumType(StdVideoAV1FrameRestorationType.class)
 IntPtr value)

FrameRestorationTypeRaw

@NotNull
public @NotNull MemorySegment FrameRestorationTypeRaw()

LoopRestorationSize

@Unsigned
public ShortPtr LoopRestorationSize()

LoopRestorationSize

public StdVideoAV1LoopRestoration LoopRestorationSize(@NotNull
 @NotNull Consumer<ShortPtr> consumer)

LoopRestorationSize

public StdVideoAV1LoopRestoration LoopRestorationSize(@Unsigned
 ShortPtr value)

LoopRestorationSizeRaw

@NotNull
public @NotNull MemorySegment LoopRestorationSizeRaw()

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