Record Class VkVideoEncodeH264FrameSizeKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkVideoEncodeH264FrameSizeKHR

All Implemented Interfaces:

IPointer, IVkVideoEncodeH264FrameSizeKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkVideoEncodeH264FrameSizeKHR(@NotNull MemorySegment segment)
extends Record
implements IVkVideoEncodeH264FrameSizeKHR

Represents a pointer to a VkVideoEncodeH264FrameSizeKHR structure in native memory.

Structure

typedef struct VkVideoEncodeH264FrameSizeKHR {
    uint32_t frameISize;
    uint32_t framePSize;
    uint32_t frameBSize;
} VkVideoEncodeH264FrameSizeKHR;

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.

See Also:

• VkVideoEncodeH264FrameSizeKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkVideoEncodeH264FrameSizeKHR.Ptr	Represents a pointer to / an array of VkVideoEncodeH264FrameSizeKHR structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$frameBSize
static final ValueLayout.OfInt	LAYOUT$frameISize
static final ValueLayout.OfInt	LAYOUT$framePSize
static final long	OFFSET$frameBSize
static final long	OFFSET$frameISize
static final long	OFFSET$framePSize
static final MemoryLayout.PathElement	PATH$frameBSize
static final MemoryLayout.PathElement	PATH$frameISize
static final MemoryLayout.PathElement	PATH$framePSize
static final long	SIZE$frameBSize
static final long	SIZE$frameISize
static final long	SIZE$framePSize

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeH264FrameSizeKHR	allocate(Arena arena)
static VkVideoEncodeH264FrameSizeKHR.Ptr	allocate(Arena arena, long count)
static VkVideoEncodeH264FrameSizeKHR	clone(Arena arena, VkVideoEncodeH264FrameSizeKHR src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	frameBSize()
VkVideoEncodeH264FrameSizeKHR	frameBSize(int value)
int	frameISize()
VkVideoEncodeH264FrameSizeKHR	frameISize(int value)
int	framePSize()
VkVideoEncodeH264FrameSizeKHR	framePSize(int value)
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$frameISize

public static final MemoryLayout.PathElement PATH$frameISize

PATH$framePSize

public static final MemoryLayout.PathElement PATH$framePSize

PATH$frameBSize

public static final MemoryLayout.PathElement PATH$frameBSize

LAYOUT$frameISize

public static final ValueLayout.OfInt LAYOUT$frameISize

LAYOUT$framePSize

public static final ValueLayout.OfInt LAYOUT$framePSize

LAYOUT$frameBSize

public static final ValueLayout.OfInt LAYOUT$frameBSize

SIZE$frameISize

public static final long SIZE$frameISize

SIZE$framePSize

public static final long SIZE$framePSize

SIZE$frameBSize

public static final long SIZE$frameBSize

OFFSET$frameISize

public static final long OFFSET$frameISize

OFFSET$framePSize

public static final long OFFSET$framePSize

OFFSET$frameBSize

public static final long OFFSET$frameBSize

Constructor Details

VkVideoEncodeH264FrameSizeKHR

public VkVideoEncodeH264FrameSizeKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkVideoEncodeH264FrameSizeKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkVideoEncodeH264FrameSizeKHR allocate(Arena arena)

allocate

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

clone

public static VkVideoEncodeH264FrameSizeKHR clone(Arena arena,
 VkVideoEncodeH264FrameSizeKHR src)

frameISize

@Unsigned
public int frameISize()

frameISize

public VkVideoEncodeH264FrameSizeKHR frameISize(@Unsigned
 int value)

framePSize

@Unsigned
public int framePSize()

framePSize

public VkVideoEncodeH264FrameSizeKHR framePSize(@Unsigned
 int value)

frameBSize

@Unsigned
public int frameBSize()

frameBSize

public VkVideoEncodeH264FrameSizeKHR frameBSize(@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