Record Class StdVideoAV1GlobalMotion

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.StdVideoAV1GlobalMotion

All Implemented Interfaces:

IPointer, IStdVideoAV1GlobalMotion

@ValueBasedCandidate
@UnsafeConstructor
public record StdVideoAV1GlobalMotion(@NotNull MemorySegment segment)
extends Record
implements IStdVideoAV1GlobalMotion

Represents a pointer to a StdVideoAV1GlobalMotion structure in native memory.

Structure

typedef struct StdVideoAV1GlobalMotion {
    uint8_t[STD_VIDEO_AV1_NUM_REF_FRAMES] GmType;
    int32_t[STD_VIDEO_AV1_GLOBAL_MOTION_PARAMS][STD_VIDEO_AV1_NUM_REF_FRAMES] gm_params;
} StdVideoAV1GlobalMotion;

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	StdVideoAV1GlobalMotion.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$gm_params
static final SequenceLayout	LAYOUT$GmType
static final long	OFFSET$gm_params
static final long	OFFSET$GmType
static final MemoryLayout.PathElement	PATH$gm_params
static final MemoryLayout.PathElement	PATH$GmType
static final long	SIZE$gm_params
static final long	SIZE$GmType

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$GmType

PATH$gm_params

public static final MemoryLayout.PathElement PATH$gm_params

LAYOUT$GmType

public static final SequenceLayout LAYOUT$GmType

LAYOUT$gm_params

public static final SequenceLayout LAYOUT$gm_params

SIZE$GmType

public static final long SIZE$GmType

SIZE$gm_params

public static final long SIZE$gm_params

OFFSET$GmType

public static final long OFFSET$GmType

OFFSET$gm_params

public static final long OFFSET$gm_params

Constructor Details

StdVideoAV1GlobalMotion

public StdVideoAV1GlobalMotion(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a StdVideoAV1GlobalMotion record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static StdVideoAV1GlobalMotion allocate(Arena arena)

allocate

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

clone

public static StdVideoAV1GlobalMotion clone(Arena arena,
 StdVideoAV1GlobalMotion src)

GmType

@Unsigned
public BytePtr GmType()

GmType

public StdVideoAV1GlobalMotion GmType(@NotNull
 @NotNull Consumer<BytePtr> consumer)

GmType

public StdVideoAV1GlobalMotion GmType(@Unsigned
 BytePtr value)

GmTypeRaw

@NotNull
public @NotNull MemorySegment GmTypeRaw()

gm_params

public IntPtr gm_params()

gm_params

public StdVideoAV1GlobalMotion gm_params(@NotNull
 @NotNull Consumer<IntPtr> consumer)

gm_params

public StdVideoAV1GlobalMotion gm_params(IntPtr value)

gm_paramsRaw

@NotNull
public @NotNull MemorySegment gm_paramsRaw()

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