Record Class StdVideoAV1TimingInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.StdVideoAV1TimingInfo

All Implemented Interfaces:

IPointer, IStdVideoAV1TimingInfo

@ValueBasedCandidate
@UnsafeConstructor
public record StdVideoAV1TimingInfo(@NotNull MemorySegment segment)
extends Record
implements IStdVideoAV1TimingInfo

Represents a pointer to a StdVideoAV1TimingInfo structure in native memory.

Structure

typedef struct StdVideoAV1TimingInfo {
    StdVideoAV1TimingInfoFlags flags;
    uint32_t num_units_in_display_tick;
    uint32_t time_scale;
    uint32_t num_ticks_per_picture_minus_1;
} StdVideoAV1TimingInfo;

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	StdVideoAV1TimingInfo.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.OfInt	LAYOUT$num_ticks_per_picture_minus_1
static final ValueLayout.OfInt	LAYOUT$num_units_in_display_tick
static final ValueLayout.OfInt	LAYOUT$time_scale
static final long	OFFSET$flags
static final long	OFFSET$num_ticks_per_picture_minus_1
static final long	OFFSET$num_units_in_display_tick
static final long	OFFSET$time_scale
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$num_ticks_per_picture_minus_1
static final MemoryLayout.PathElement	PATH$num_units_in_display_tick
static final MemoryLayout.PathElement	PATH$time_scale
static final long	SIZE$flags
static final long	SIZE$num_ticks_per_picture_minus_1
static final long	SIZE$num_units_in_display_tick
static final long	SIZE$time_scale

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$num_units_in_display_tick

PATH$time_scale

public static final MemoryLayout.PathElement PATH$time_scale

PATH$num_ticks_per_picture_minus_1

public static final MemoryLayout.PathElement PATH$num_ticks_per_picture_minus_1

LAYOUT$flags

public static final StructLayout LAYOUT$flags

LAYOUT$num_units_in_display_tick

public static final ValueLayout.OfInt LAYOUT$num_units_in_display_tick

LAYOUT$time_scale

public static final ValueLayout.OfInt LAYOUT$time_scale

LAYOUT$num_ticks_per_picture_minus_1

public static final ValueLayout.OfInt LAYOUT$num_ticks_per_picture_minus_1

SIZE$flags

public static final long SIZE$flags

SIZE$num_units_in_display_tick

public static final long SIZE$num_units_in_display_tick

SIZE$time_scale

public static final long SIZE$time_scale

SIZE$num_ticks_per_picture_minus_1

public static final long SIZE$num_ticks_per_picture_minus_1

OFFSET$flags

public static final long OFFSET$flags

OFFSET$num_units_in_display_tick

public static final long OFFSET$num_units_in_display_tick

OFFSET$time_scale

public static final long OFFSET$time_scale

OFFSET$num_ticks_per_picture_minus_1

public static final long OFFSET$num_ticks_per_picture_minus_1

Constructor Details

StdVideoAV1TimingInfo

public StdVideoAV1TimingInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a StdVideoAV1TimingInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static StdVideoAV1TimingInfo allocate(Arena arena)

allocate

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

clone

public static StdVideoAV1TimingInfo clone(Arena arena,
 StdVideoAV1TimingInfo src)

flags

@NotNull
public @NotNull StdVideoAV1TimingInfoFlags flags()

flags

public StdVideoAV1TimingInfo flags(@NotNull
 @NotNull StdVideoAV1TimingInfoFlags value)

flags

public StdVideoAV1TimingInfo flags(Consumer<@NotNull StdVideoAV1TimingInfoFlags> consumer)

num_units_in_display_tick

@Unsigned
public int num_units_in_display_tick()

num_units_in_display_tick

public StdVideoAV1TimingInfo num_units_in_display_tick(@Unsigned
 int value)

time_scale

@Unsigned
public int time_scale()

time_scale

public StdVideoAV1TimingInfo time_scale(@Unsigned
 int value)

num_ticks_per_picture_minus_1

@Unsigned
public int num_ticks_per_picture_minus_1()

num_ticks_per_picture_minus_1

public StdVideoAV1TimingInfo num_ticks_per_picture_minus_1(@Unsigned
 int 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