Record Class StdVideoAV1SequenceHeader

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.StdVideoAV1SequenceHeader

All Implemented Interfaces:

IPointer, IStdVideoAV1SequenceHeader

@ValueBasedCandidate
@UnsafeConstructor
public record StdVideoAV1SequenceHeader(@NotNull MemorySegment segment)
extends Record
implements IStdVideoAV1SequenceHeader

Represents a pointer to a StdVideoAV1SequenceHeader structure in native memory.

Structure

typedef struct StdVideoAV1SequenceHeader {
    StdVideoAV1SequenceHeaderFlags flags;
    StdVideoAV1Profile seq_profile;
    uint8_t frame_width_bits_minus_1;
    uint8_t frame_height_bits_minus_1;
    uint16_t max_frame_width_minus_1;
    uint16_t max_frame_height_minus_1;
    uint8_t delta_frame_id_length_minus_2;
    uint8_t additional_frame_id_length_minus_1;
    uint8_t order_hint_bits_minus_1;
    uint8_t seq_force_integer_mv;
    uint8_t seq_force_screen_content_tools;
    uint8_t[5] reserved1;
    StdVideoAV1ColorConfig const* pColorConfig;
    StdVideoAV1TimingInfo const* pTimingInfo;
} StdVideoAV1SequenceHeader;

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	StdVideoAV1SequenceHeader.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$additional_frame_id_length_minus_1
static final ValueLayout.OfByte	LAYOUT$delta_frame_id_length_minus_2
static final StructLayout	LAYOUT$flags
static final ValueLayout.OfByte	LAYOUT$frame_height_bits_minus_1
static final ValueLayout.OfByte	LAYOUT$frame_width_bits_minus_1
static final ValueLayout.OfShort	LAYOUT$max_frame_height_minus_1
static final ValueLayout.OfShort	LAYOUT$max_frame_width_minus_1
static final ValueLayout.OfByte	LAYOUT$order_hint_bits_minus_1
static final AddressLayout	LAYOUT$pColorConfig
static final AddressLayout	LAYOUT$pTimingInfo
static final ValueLayout.OfByte	LAYOUT$seq_force_integer_mv
static final ValueLayout.OfByte	LAYOUT$seq_force_screen_content_tools
static final ValueLayout.OfInt	LAYOUT$seq_profile
static final long	OFFSET$additional_frame_id_length_minus_1
static final long	OFFSET$delta_frame_id_length_minus_2
static final long	OFFSET$flags
static final long	OFFSET$frame_height_bits_minus_1
static final long	OFFSET$frame_width_bits_minus_1
static final long	OFFSET$max_frame_height_minus_1
static final long	OFFSET$max_frame_width_minus_1
static final long	OFFSET$order_hint_bits_minus_1
static final long	OFFSET$pColorConfig
static final long	OFFSET$pTimingInfo
static final long	OFFSET$seq_force_integer_mv
static final long	OFFSET$seq_force_screen_content_tools
static final long	OFFSET$seq_profile
static final MemoryLayout.PathElement	PATH$additional_frame_id_length_minus_1
static final MemoryLayout.PathElement	PATH$delta_frame_id_length_minus_2
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$frame_height_bits_minus_1
static final MemoryLayout.PathElement	PATH$frame_width_bits_minus_1
static final MemoryLayout.PathElement	PATH$max_frame_height_minus_1
static final MemoryLayout.PathElement	PATH$max_frame_width_minus_1
static final MemoryLayout.PathElement	PATH$order_hint_bits_minus_1
static final MemoryLayout.PathElement	PATH$pColorConfig
static final MemoryLayout.PathElement	PATH$pTimingInfo
static final MemoryLayout.PathElement	PATH$seq_force_integer_mv
static final MemoryLayout.PathElement	PATH$seq_force_screen_content_tools
static final MemoryLayout.PathElement	PATH$seq_profile
static final long	SIZE$additional_frame_id_length_minus_1
static final long	SIZE$delta_frame_id_length_minus_2
static final long	SIZE$flags
static final long	SIZE$frame_height_bits_minus_1
static final long	SIZE$frame_width_bits_minus_1
static final long	SIZE$max_frame_height_minus_1
static final long	SIZE$max_frame_width_minus_1
static final long	SIZE$order_hint_bits_minus_1
static final long	SIZE$pColorConfig
static final long	SIZE$pTimingInfo
static final long	SIZE$seq_force_integer_mv
static final long	SIZE$seq_force_screen_content_tools
static final long	SIZE$seq_profile

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
byte	additional_frame_id_length_minus_1()
StdVideoAV1SequenceHeader	additional_frame_id_length_minus_1(byte value)
static StdVideoAV1SequenceHeader	allocate(Arena arena)
static StdVideoAV1SequenceHeader.Ptr	allocate(Arena arena, long count)
static StdVideoAV1SequenceHeader	clone(Arena arena, StdVideoAV1SequenceHeader src)
byte	delta_frame_id_length_minus_2()
StdVideoAV1SequenceHeader	delta_frame_id_length_minus_2(byte value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull StdVideoAV1SequenceHeaderFlags	flags()
StdVideoAV1SequenceHeader	flags(@NotNull StdVideoAV1SequenceHeaderFlags value)
StdVideoAV1SequenceHeader	flags(Consumer<@NotNull StdVideoAV1SequenceHeaderFlags> consumer)
byte	frame_height_bits_minus_1()
StdVideoAV1SequenceHeader	frame_height_bits_minus_1(byte value)
byte	frame_width_bits_minus_1()
StdVideoAV1SequenceHeader	frame_width_bits_minus_1(byte value)
final int	hashCode()	Returns a hash code value for this object.
short	max_frame_height_minus_1()
StdVideoAV1SequenceHeader	max_frame_height_minus_1(short value)
short	max_frame_width_minus_1()
StdVideoAV1SequenceHeader	max_frame_width_minus_1(short value)
byte	order_hint_bits_minus_1()
StdVideoAV1SequenceHeader	order_hint_bits_minus_1(byte value)
@Nullable StdVideoAV1ColorConfig	pColorConfig()
StdVideoAV1ColorConfig.Ptr	pColorConfig(int assumedCount)
StdVideoAV1SequenceHeader	pColorConfig(@Nullable IStdVideoAV1ColorConfig value)
MemorySegment	pColorConfigRaw()
void	pColorConfigRaw(MemorySegment value)
@Nullable StdVideoAV1TimingInfo	pTimingInfo()
StdVideoAV1TimingInfo.Ptr	pTimingInfo(int assumedCount)
StdVideoAV1SequenceHeader	pTimingInfo(@Nullable IStdVideoAV1TimingInfo value)
MemorySegment	pTimingInfoRaw()
void	pTimingInfoRaw(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
byte	seq_force_integer_mv()
StdVideoAV1SequenceHeader	seq_force_integer_mv(byte value)
byte	seq_force_screen_content_tools()
StdVideoAV1SequenceHeader	seq_force_screen_content_tools(byte value)
int	seq_profile()
StdVideoAV1SequenceHeader	seq_profile(int 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$flags

public static final MemoryLayout.PathElement PATH$flags

PATH$seq_profile

public static final MemoryLayout.PathElement PATH$seq_profile

PATH$frame_width_bits_minus_1

public static final MemoryLayout.PathElement PATH$frame_width_bits_minus_1

PATH$frame_height_bits_minus_1

public static final MemoryLayout.PathElement PATH$frame_height_bits_minus_1

PATH$max_frame_width_minus_1

public static final MemoryLayout.PathElement PATH$max_frame_width_minus_1

PATH$max_frame_height_minus_1

public static final MemoryLayout.PathElement PATH$max_frame_height_minus_1

PATH$delta_frame_id_length_minus_2

public static final MemoryLayout.PathElement PATH$delta_frame_id_length_minus_2

PATH$additional_frame_id_length_minus_1

public static final MemoryLayout.PathElement PATH$additional_frame_id_length_minus_1

PATH$order_hint_bits_minus_1

public static final MemoryLayout.PathElement PATH$order_hint_bits_minus_1

PATH$seq_force_integer_mv

public static final MemoryLayout.PathElement PATH$seq_force_integer_mv

PATH$seq_force_screen_content_tools

public static final MemoryLayout.PathElement PATH$seq_force_screen_content_tools

PATH$pColorConfig

public static final MemoryLayout.PathElement PATH$pColorConfig

PATH$pTimingInfo

public static final MemoryLayout.PathElement PATH$pTimingInfo

LAYOUT$flags

public static final StructLayout LAYOUT$flags

LAYOUT$seq_profile

public static final ValueLayout.OfInt LAYOUT$seq_profile

LAYOUT$frame_width_bits_minus_1

public static final ValueLayout.OfByte LAYOUT$frame_width_bits_minus_1

LAYOUT$frame_height_bits_minus_1

public static final ValueLayout.OfByte LAYOUT$frame_height_bits_minus_1

LAYOUT$max_frame_width_minus_1

public static final ValueLayout.OfShort LAYOUT$max_frame_width_minus_1

LAYOUT$max_frame_height_minus_1

public static final ValueLayout.OfShort LAYOUT$max_frame_height_minus_1

LAYOUT$delta_frame_id_length_minus_2

public static final ValueLayout.OfByte LAYOUT$delta_frame_id_length_minus_2

LAYOUT$additional_frame_id_length_minus_1

public static final ValueLayout.OfByte LAYOUT$additional_frame_id_length_minus_1

LAYOUT$order_hint_bits_minus_1

public static final ValueLayout.OfByte LAYOUT$order_hint_bits_minus_1

LAYOUT$seq_force_integer_mv

public static final ValueLayout.OfByte LAYOUT$seq_force_integer_mv

LAYOUT$seq_force_screen_content_tools

public static final ValueLayout.OfByte LAYOUT$seq_force_screen_content_tools

LAYOUT$pColorConfig

public static final AddressLayout LAYOUT$pColorConfig

LAYOUT$pTimingInfo

public static final AddressLayout LAYOUT$pTimingInfo

SIZE$flags

public static final long SIZE$flags

SIZE$seq_profile

public static final long SIZE$seq_profile

SIZE$frame_width_bits_minus_1

public static final long SIZE$frame_width_bits_minus_1

SIZE$frame_height_bits_minus_1

public static final long SIZE$frame_height_bits_minus_1

SIZE$max_frame_width_minus_1

public static final long SIZE$max_frame_width_minus_1

SIZE$max_frame_height_minus_1

public static final long SIZE$max_frame_height_minus_1

SIZE$delta_frame_id_length_minus_2

public static final long SIZE$delta_frame_id_length_minus_2

SIZE$additional_frame_id_length_minus_1

public static final long SIZE$additional_frame_id_length_minus_1

SIZE$order_hint_bits_minus_1

public static final long SIZE$order_hint_bits_minus_1

SIZE$seq_force_integer_mv

public static final long SIZE$seq_force_integer_mv

SIZE$seq_force_screen_content_tools

public static final long SIZE$seq_force_screen_content_tools

SIZE$pColorConfig

public static final long SIZE$pColorConfig

SIZE$pTimingInfo

public static final long SIZE$pTimingInfo

OFFSET$flags

public static final long OFFSET$flags

OFFSET$seq_profile

public static final long OFFSET$seq_profile

OFFSET$frame_width_bits_minus_1

public static final long OFFSET$frame_width_bits_minus_1

OFFSET$frame_height_bits_minus_1

public static final long OFFSET$frame_height_bits_minus_1

OFFSET$max_frame_width_minus_1

public static final long OFFSET$max_frame_width_minus_1

OFFSET$max_frame_height_minus_1

public static final long OFFSET$max_frame_height_minus_1

OFFSET$delta_frame_id_length_minus_2

public static final long OFFSET$delta_frame_id_length_minus_2

OFFSET$additional_frame_id_length_minus_1

public static final long OFFSET$additional_frame_id_length_minus_1

OFFSET$order_hint_bits_minus_1

public static final long OFFSET$order_hint_bits_minus_1

OFFSET$seq_force_integer_mv

public static final long OFFSET$seq_force_integer_mv

OFFSET$seq_force_screen_content_tools

public static final long OFFSET$seq_force_screen_content_tools

OFFSET$pColorConfig

public static final long OFFSET$pColorConfig

OFFSET$pTimingInfo

public static final long OFFSET$pTimingInfo

Constructor Details

StdVideoAV1SequenceHeader

public StdVideoAV1SequenceHeader(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a StdVideoAV1SequenceHeader record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static StdVideoAV1SequenceHeader allocate(Arena arena)

allocate

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

clone

public static StdVideoAV1SequenceHeader clone(Arena arena,
 StdVideoAV1SequenceHeader src)

flags

@NotNull
public @NotNull StdVideoAV1SequenceHeaderFlags flags()

flags

public StdVideoAV1SequenceHeader flags(@NotNull
 @NotNull StdVideoAV1SequenceHeaderFlags value)

flags

public StdVideoAV1SequenceHeader flags(Consumer<@NotNull StdVideoAV1SequenceHeaderFlags> consumer)

seq_profile

@EnumType(StdVideoAV1Profile.class)
public int seq_profile()

seq_profile

public StdVideoAV1SequenceHeader seq_profile(@EnumType(StdVideoAV1Profile.class)
 int value)

frame_width_bits_minus_1

@Unsigned
public byte frame_width_bits_minus_1()

frame_width_bits_minus_1

public StdVideoAV1SequenceHeader frame_width_bits_minus_1(@Unsigned
 byte value)

frame_height_bits_minus_1

@Unsigned
public byte frame_height_bits_minus_1()

frame_height_bits_minus_1

public StdVideoAV1SequenceHeader frame_height_bits_minus_1(@Unsigned
 byte value)

max_frame_width_minus_1

@Unsigned
public short max_frame_width_minus_1()

max_frame_width_minus_1

public StdVideoAV1SequenceHeader max_frame_width_minus_1(@Unsigned
 short value)

max_frame_height_minus_1

@Unsigned
public short max_frame_height_minus_1()

max_frame_height_minus_1

public StdVideoAV1SequenceHeader max_frame_height_minus_1(@Unsigned
 short value)

delta_frame_id_length_minus_2

@Unsigned
public byte delta_frame_id_length_minus_2()

delta_frame_id_length_minus_2

public StdVideoAV1SequenceHeader delta_frame_id_length_minus_2(@Unsigned
 byte value)

additional_frame_id_length_minus_1

@Unsigned
public byte additional_frame_id_length_minus_1()

additional_frame_id_length_minus_1

public StdVideoAV1SequenceHeader additional_frame_id_length_minus_1(@Unsigned
 byte value)

order_hint_bits_minus_1

@Unsigned
public byte order_hint_bits_minus_1()

order_hint_bits_minus_1

public StdVideoAV1SequenceHeader order_hint_bits_minus_1(@Unsigned
 byte value)

seq_force_integer_mv

@Unsigned
public byte seq_force_integer_mv()

seq_force_integer_mv

public StdVideoAV1SequenceHeader seq_force_integer_mv(@Unsigned
 byte value)

seq_force_screen_content_tools

@Unsigned
public byte seq_force_screen_content_tools()

seq_force_screen_content_tools

public StdVideoAV1SequenceHeader seq_force_screen_content_tools(@Unsigned
 byte value)

pColorConfig

public StdVideoAV1SequenceHeader pColorConfig(@Nullable
 @Nullable IStdVideoAV1ColorConfig value)

pColorConfig

@Unsafe
@Nullable
public StdVideoAV1ColorConfig.Ptr pColorConfig(int assumedCount)

pColorConfig

@Nullable
public @Nullable StdVideoAV1ColorConfig pColorConfig()

pColorConfigRaw

@Pointer(target=StdVideoAV1ColorConfig.class)
public MemorySegment pColorConfigRaw()

pColorConfigRaw

public void pColorConfigRaw(@Pointer(target=StdVideoAV1ColorConfig.class)
 MemorySegment value)

pTimingInfo

public StdVideoAV1SequenceHeader pTimingInfo(@Nullable
 @Nullable IStdVideoAV1TimingInfo value)

pTimingInfo

@Unsafe
@Nullable
public StdVideoAV1TimingInfo.Ptr pTimingInfo(int assumedCount)

pTimingInfo

@Nullable
public @Nullable StdVideoAV1TimingInfo pTimingInfo()

pTimingInfoRaw

@Pointer(target=StdVideoAV1TimingInfo.class)
public MemorySegment pTimingInfoRaw()

pTimingInfoRaw

public void pTimingInfoRaw(@Pointer(target=StdVideoAV1TimingInfo.class)
 MemorySegment 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