Record Class StdVideoEncodeAV1ExtensionHeader

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.StdVideoEncodeAV1ExtensionHeader

All Implemented Interfaces:

IPointer, IStdVideoEncodeAV1ExtensionHeader

@ValueBasedCandidate
@UnsafeConstructor
public record StdVideoEncodeAV1ExtensionHeader(@NotNull MemorySegment segment)
extends Record
implements IStdVideoEncodeAV1ExtensionHeader

Represents a pointer to a StdVideoEncodeAV1ExtensionHeader structure in native memory.

Structure

typedef struct StdVideoEncodeAV1ExtensionHeader {
    uint8_t temporal_id;
    uint8_t spatial_id;
} StdVideoEncodeAV1ExtensionHeader;

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	StdVideoEncodeAV1ExtensionHeader.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 ValueLayout.OfByte	LAYOUT$spatial_id
static final ValueLayout.OfByte	LAYOUT$temporal_id
static final long	OFFSET$spatial_id
static final long	OFFSET$temporal_id
static final MemoryLayout.PathElement	PATH$spatial_id
static final MemoryLayout.PathElement	PATH$temporal_id
static final long	SIZE$spatial_id
static final long	SIZE$temporal_id

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static StdVideoEncodeAV1ExtensionHeader	allocate(Arena arena)
static StdVideoEncodeAV1ExtensionHeader.Ptr	allocate(Arena arena, long count)
static StdVideoEncodeAV1ExtensionHeader	clone(Arena arena, StdVideoEncodeAV1ExtensionHeader src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
byte	spatial_id()
StdVideoEncodeAV1ExtensionHeader	spatial_id(byte value)
byte	temporal_id()
StdVideoEncodeAV1ExtensionHeader	temporal_id(byte value)
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$temporal_id

public static final MemoryLayout.PathElement PATH$temporal_id

PATH$spatial_id

public static final MemoryLayout.PathElement PATH$spatial_id

LAYOUT$temporal_id

public static final ValueLayout.OfByte LAYOUT$temporal_id

LAYOUT$spatial_id

public static final ValueLayout.OfByte LAYOUT$spatial_id

SIZE$temporal_id

public static final long SIZE$temporal_id

SIZE$spatial_id

public static final long SIZE$spatial_id

OFFSET$temporal_id

public static final long OFFSET$temporal_id

OFFSET$spatial_id

public static final long OFFSET$spatial_id

Constructor Details

StdVideoEncodeAV1ExtensionHeader

public StdVideoEncodeAV1ExtensionHeader(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a StdVideoEncodeAV1ExtensionHeader record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static StdVideoEncodeAV1ExtensionHeader allocate(Arena arena)

allocate

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

clone

public static StdVideoEncodeAV1ExtensionHeader clone(Arena arena,
 StdVideoEncodeAV1ExtensionHeader src)

temporal_id

@Unsigned
public byte temporal_id()

temporal_id

public StdVideoEncodeAV1ExtensionHeader temporal_id(@Unsigned
 byte value)

spatial_id

@Unsigned
public byte spatial_id()

spatial_id

public StdVideoEncodeAV1ExtensionHeader spatial_id(@Unsigned
 byte 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