Record Class StdVideoAV1TileInfo

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.StdVideoAV1TileInfo

All Implemented Interfaces:

IPointer, IStdVideoAV1TileInfo

@ValueBasedCandidate
@UnsafeConstructor
public record StdVideoAV1TileInfo(@NotNull MemorySegment segment)
extends Record
implements IStdVideoAV1TileInfo

Represents a pointer to a StdVideoAV1TileInfo structure in native memory.

Structure

typedef struct StdVideoAV1TileInfo {
    StdVideoAV1TileInfoFlags flags;
    uint8_t TileCols;
    uint8_t TileRows;
    uint16_t context_update_tile_id;
    uint8_t tile_size_bytes_minus_1;
    uint8_t[7] reserved1;
    uint16_t const* pMiColStarts;
    uint16_t const* pMiRowStarts;
    uint16_t const* pWidthInSbsMinus1;
    uint16_t const* pHeightInSbsMinus1;
} StdVideoAV1TileInfo;

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	StdVideoAV1TileInfo.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.OfShort	LAYOUT$context_update_tile_id
static final StructLayout	LAYOUT$flags
static final AddressLayout	LAYOUT$pHeightInSbsMinus1
static final AddressLayout	LAYOUT$pMiColStarts
static final AddressLayout	LAYOUT$pMiRowStarts
static final AddressLayout	LAYOUT$pWidthInSbsMinus1
static final ValueLayout.OfByte	LAYOUT$tile_size_bytes_minus_1
static final ValueLayout.OfByte	LAYOUT$TileCols
static final ValueLayout.OfByte	LAYOUT$TileRows
static final long	OFFSET$context_update_tile_id
static final long	OFFSET$flags
static final long	OFFSET$pHeightInSbsMinus1
static final long	OFFSET$pMiColStarts
static final long	OFFSET$pMiRowStarts
static final long	OFFSET$pWidthInSbsMinus1
static final long	OFFSET$tile_size_bytes_minus_1
static final long	OFFSET$TileCols
static final long	OFFSET$TileRows
static final MemoryLayout.PathElement	PATH$context_update_tile_id
static final MemoryLayout.PathElement	PATH$flags
static final MemoryLayout.PathElement	PATH$pHeightInSbsMinus1
static final MemoryLayout.PathElement	PATH$pMiColStarts
static final MemoryLayout.PathElement	PATH$pMiRowStarts
static final MemoryLayout.PathElement	PATH$pWidthInSbsMinus1
static final MemoryLayout.PathElement	PATH$tile_size_bytes_minus_1
static final MemoryLayout.PathElement	PATH$TileCols
static final MemoryLayout.PathElement	PATH$TileRows
static final long	SIZE$context_update_tile_id
static final long	SIZE$flags
static final long	SIZE$pHeightInSbsMinus1
static final long	SIZE$pMiColStarts
static final long	SIZE$pMiRowStarts
static final long	SIZE$pWidthInSbsMinus1
static final long	SIZE$tile_size_bytes_minus_1
static final long	SIZE$TileCols
static final long	SIZE$TileRows

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static StdVideoAV1TileInfo	allocate(Arena arena)
static StdVideoAV1TileInfo.Ptr	allocate(Arena arena, long count)
static StdVideoAV1TileInfo	clone(Arena arena, StdVideoAV1TileInfo src)
short	context_update_tile_id()
StdVideoAV1TileInfo	context_update_tile_id(short value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull StdVideoAV1TileInfoFlags	flags()
StdVideoAV1TileInfo	flags(@NotNull StdVideoAV1TileInfoFlags value)
StdVideoAV1TileInfo	flags(Consumer<@NotNull StdVideoAV1TileInfoFlags> consumer)
final int	hashCode()	Returns a hash code value for this object.
@Nullable ShortPtr	pHeightInSbsMinus1()	Note: the returned ShortPtr does not have correct ShortPtr.size() property.
StdVideoAV1TileInfo	pHeightInSbsMinus1(@Nullable ShortPtr value)
MemorySegment	pHeightInSbsMinus1Raw()
void	pHeightInSbsMinus1Raw(MemorySegment value)
@Nullable ShortPtr	pMiColStarts()	Note: the returned ShortPtr does not have correct ShortPtr.size() property.
StdVideoAV1TileInfo	pMiColStarts(@Nullable ShortPtr value)
MemorySegment	pMiColStartsRaw()
void	pMiColStartsRaw(MemorySegment value)
@Nullable ShortPtr	pMiRowStarts()	Note: the returned ShortPtr does not have correct ShortPtr.size() property.
StdVideoAV1TileInfo	pMiRowStarts(@Nullable ShortPtr value)
MemorySegment	pMiRowStartsRaw()
void	pMiRowStartsRaw(MemorySegment value)
@Nullable ShortPtr	pWidthInSbsMinus1()	Note: the returned ShortPtr does not have correct ShortPtr.size() property.
StdVideoAV1TileInfo	pWidthInSbsMinus1(@Nullable ShortPtr value)
MemorySegment	pWidthInSbsMinus1Raw()
void	pWidthInSbsMinus1Raw(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
byte	tile_size_bytes_minus_1()
StdVideoAV1TileInfo	tile_size_bytes_minus_1(byte value)
byte	TileCols()
StdVideoAV1TileInfo	TileCols(byte value)
byte	TileRows()
StdVideoAV1TileInfo	TileRows(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$flags

public static final MemoryLayout.PathElement PATH$flags

PATH$TileCols

public static final MemoryLayout.PathElement PATH$TileCols

PATH$TileRows

public static final MemoryLayout.PathElement PATH$TileRows

PATH$context_update_tile_id

public static final MemoryLayout.PathElement PATH$context_update_tile_id

PATH$tile_size_bytes_minus_1

public static final MemoryLayout.PathElement PATH$tile_size_bytes_minus_1

PATH$pMiColStarts

public static final MemoryLayout.PathElement PATH$pMiColStarts

PATH$pMiRowStarts

public static final MemoryLayout.PathElement PATH$pMiRowStarts

PATH$pWidthInSbsMinus1

public static final MemoryLayout.PathElement PATH$pWidthInSbsMinus1

PATH$pHeightInSbsMinus1

public static final MemoryLayout.PathElement PATH$pHeightInSbsMinus1

LAYOUT$flags

public static final StructLayout LAYOUT$flags

LAYOUT$TileCols

public static final ValueLayout.OfByte LAYOUT$TileCols

LAYOUT$TileRows

public static final ValueLayout.OfByte LAYOUT$TileRows

LAYOUT$context_update_tile_id

public static final ValueLayout.OfShort LAYOUT$context_update_tile_id

LAYOUT$tile_size_bytes_minus_1

public static final ValueLayout.OfByte LAYOUT$tile_size_bytes_minus_1

LAYOUT$pMiColStarts

public static final AddressLayout LAYOUT$pMiColStarts

LAYOUT$pMiRowStarts

public static final AddressLayout LAYOUT$pMiRowStarts

LAYOUT$pWidthInSbsMinus1

public static final AddressLayout LAYOUT$pWidthInSbsMinus1

LAYOUT$pHeightInSbsMinus1

public static final AddressLayout LAYOUT$pHeightInSbsMinus1

SIZE$flags

public static final long SIZE$flags

SIZE$TileCols

public static final long SIZE$TileCols

SIZE$TileRows

public static final long SIZE$TileRows

SIZE$context_update_tile_id

public static final long SIZE$context_update_tile_id

SIZE$tile_size_bytes_minus_1

public static final long SIZE$tile_size_bytes_minus_1

SIZE$pMiColStarts

public static final long SIZE$pMiColStarts

SIZE$pMiRowStarts

public static final long SIZE$pMiRowStarts

SIZE$pWidthInSbsMinus1

public static final long SIZE$pWidthInSbsMinus1

SIZE$pHeightInSbsMinus1

public static final long SIZE$pHeightInSbsMinus1

OFFSET$flags

public static final long OFFSET$flags

OFFSET$TileCols

public static final long OFFSET$TileCols

OFFSET$TileRows

public static final long OFFSET$TileRows

OFFSET$context_update_tile_id

public static final long OFFSET$context_update_tile_id

OFFSET$tile_size_bytes_minus_1

public static final long OFFSET$tile_size_bytes_minus_1

OFFSET$pMiColStarts

public static final long OFFSET$pMiColStarts

OFFSET$pMiRowStarts

public static final long OFFSET$pMiRowStarts

OFFSET$pWidthInSbsMinus1

public static final long OFFSET$pWidthInSbsMinus1

OFFSET$pHeightInSbsMinus1

public static final long OFFSET$pHeightInSbsMinus1

Constructor Details

StdVideoAV1TileInfo

public StdVideoAV1TileInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a StdVideoAV1TileInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static StdVideoAV1TileInfo allocate(Arena arena)

allocate

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

clone

public static StdVideoAV1TileInfo clone(Arena arena,
 StdVideoAV1TileInfo src)

flags

@NotNull
public @NotNull StdVideoAV1TileInfoFlags flags()

flags

public StdVideoAV1TileInfo flags(@NotNull
 @NotNull StdVideoAV1TileInfoFlags value)

flags

public StdVideoAV1TileInfo flags(Consumer<@NotNull StdVideoAV1TileInfoFlags> consumer)

TileCols

@Unsigned
public byte TileCols()

TileCols

public StdVideoAV1TileInfo TileCols(@Unsigned
 byte value)

TileRows

@Unsigned
public byte TileRows()

TileRows

public StdVideoAV1TileInfo TileRows(@Unsigned
 byte value)

context_update_tile_id

@Unsigned
public short context_update_tile_id()

context_update_tile_id

public StdVideoAV1TileInfo context_update_tile_id(@Unsigned
 short value)

tile_size_bytes_minus_1

@Unsigned
public byte tile_size_bytes_minus_1()

tile_size_bytes_minus_1

public StdVideoAV1TileInfo tile_size_bytes_minus_1(@Unsigned
 byte value)

pMiColStarts

@Nullable
@Unsigned
public @Nullable ShortPtr pMiColStarts()

Note: the returned ShortPtr does not have correct ShortPtr.size() property. It's up to user to track the size of the buffer, and use ShortPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

pMiColStarts

public StdVideoAV1TileInfo pMiColStarts(@Nullable @Unsigned
 @Nullable ShortPtr value)

pMiColStartsRaw

@Pointer(comment="uint16_t*")
public MemorySegment pMiColStartsRaw()

pMiColStartsRaw

public void pMiColStartsRaw(@Pointer(comment="uint16_t*")
 MemorySegment value)

pMiRowStarts

@Nullable
@Unsigned
public @Nullable ShortPtr pMiRowStarts()

Note: the returned ShortPtr does not have correct ShortPtr.size() property. It's up to user to track the size of the buffer, and use ShortPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

pMiRowStarts

public StdVideoAV1TileInfo pMiRowStarts(@Nullable @Unsigned
 @Nullable ShortPtr value)

pMiRowStartsRaw

@Pointer(comment="uint16_t*")
public MemorySegment pMiRowStartsRaw()

pMiRowStartsRaw

public void pMiRowStartsRaw(@Pointer(comment="uint16_t*")
 MemorySegment value)

pWidthInSbsMinus1

@Nullable
@Unsigned
public @Nullable ShortPtr pWidthInSbsMinus1()

Note: the returned ShortPtr does not have correct ShortPtr.size() property. It's up to user to track the size of the buffer, and use ShortPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

pWidthInSbsMinus1

public StdVideoAV1TileInfo pWidthInSbsMinus1(@Nullable @Unsigned
 @Nullable ShortPtr value)

pWidthInSbsMinus1Raw

@Pointer(comment="uint16_t*")
public MemorySegment pWidthInSbsMinus1Raw()

pWidthInSbsMinus1Raw

public void pWidthInSbsMinus1Raw(@Pointer(comment="uint16_t*")
 MemorySegment value)

pHeightInSbsMinus1

@Nullable
@Unsigned
public @Nullable ShortPtr pHeightInSbsMinus1()

Note: the returned ShortPtr does not have correct ShortPtr.size() property. It's up to user to track the size of the buffer, and use ShortPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

pHeightInSbsMinus1

public StdVideoAV1TileInfo pHeightInSbsMinus1(@Nullable @Unsigned
 @Nullable ShortPtr value)

pHeightInSbsMinus1Raw

@Pointer(comment="uint16_t*")
public MemorySegment pHeightInSbsMinus1Raw()

pHeightInSbsMinus1Raw

public void pHeightInSbsMinus1Raw(@Pointer(comment="uint16_t*")
 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