Record Class VkVideoEncodeRateControlLayerInfoKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkVideoEncodeRateControlLayerInfoKHR

All Implemented Interfaces:

IPointer, IVkVideoEncodeRateControlLayerInfoKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkVideoEncodeRateControlLayerInfoKHR(@NotNull MemorySegment segment)
extends Record
implements IVkVideoEncodeRateControlLayerInfoKHR

Represents a pointer to a VkVideoEncodeRateControlLayerInfoKHR structure in native memory.

Structure

typedef struct VkVideoEncodeRateControlLayerInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    uint64_t averageBitrate;
    uint64_t maxBitrate;
    uint32_t frameRateNumerator;
    uint32_t frameRateDenominator;
} VkVideoEncodeRateControlLayerInfoKHR;

Auto initialization

This structure has the following members that can be automatically initialized:

• sType = VK_STRUCTURE_TYPE_VIDEO_ENCODE_RATE_CONTROL_LAYER_INFO_KHR

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

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:

• VkVideoEncodeRateControlLayerInfoKHR

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfLong	LAYOUT$averageBitrate
static final ValueLayout.OfInt	LAYOUT$frameRateDenominator
static final ValueLayout.OfInt	LAYOUT$frameRateNumerator
static final ValueLayout.OfLong	LAYOUT$maxBitrate
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$averageBitrate
static final long	OFFSET$frameRateDenominator
static final long	OFFSET$frameRateNumerator
static final long	OFFSET$maxBitrate
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$averageBitrate
static final MemoryLayout.PathElement	PATH$frameRateDenominator
static final MemoryLayout.PathElement	PATH$frameRateNumerator
static final MemoryLayout.PathElement	PATH$maxBitrate
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$averageBitrate
static final long	SIZE$frameRateDenominator
static final long	SIZE$frameRateNumerator
static final long	SIZE$maxBitrate
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkVideoEncodeRateControlLayerInfoKHR	allocate(Arena arena)
static VkVideoEncodeRateControlLayerInfoKHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
long	averageBitrate()
VkVideoEncodeRateControlLayerInfoKHR	averageBitrate(long value)
static VkVideoEncodeRateControlLayerInfoKHR	clone(Arena arena, VkVideoEncodeRateControlLayerInfoKHR src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	frameRateDenominator()
VkVideoEncodeRateControlLayerInfoKHR	frameRateDenominator(int value)
int	frameRateNumerator()
VkVideoEncodeRateControlLayerInfoKHR	frameRateNumerator(int value)
final int	hashCode()	Returns a hash code value for this object.
long	maxBitrate()
VkVideoEncodeRateControlLayerInfoKHR	maxBitrate(long value)
MemorySegment	pNext()
VkVideoEncodeRateControlLayerInfoKHR	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkVideoEncodeRateControlLayerInfoKHR	sType(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$sType

public static final MemoryLayout.PathElement PATH$sType

PATH$pNext

public static final MemoryLayout.PathElement PATH$pNext

PATH$averageBitrate

public static final MemoryLayout.PathElement PATH$averageBitrate

PATH$maxBitrate

public static final MemoryLayout.PathElement PATH$maxBitrate

PATH$frameRateNumerator

public static final MemoryLayout.PathElement PATH$frameRateNumerator

PATH$frameRateDenominator

public static final MemoryLayout.PathElement PATH$frameRateDenominator

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$averageBitrate

public static final ValueLayout.OfLong LAYOUT$averageBitrate

LAYOUT$maxBitrate

public static final ValueLayout.OfLong LAYOUT$maxBitrate

LAYOUT$frameRateNumerator

public static final ValueLayout.OfInt LAYOUT$frameRateNumerator

LAYOUT$frameRateDenominator

public static final ValueLayout.OfInt LAYOUT$frameRateDenominator

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$averageBitrate

public static final long SIZE$averageBitrate

SIZE$maxBitrate

public static final long SIZE$maxBitrate

SIZE$frameRateNumerator

public static final long SIZE$frameRateNumerator

SIZE$frameRateDenominator

public static final long SIZE$frameRateDenominator

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$averageBitrate

public static final long OFFSET$averageBitrate

OFFSET$maxBitrate

public static final long OFFSET$maxBitrate

OFFSET$frameRateNumerator

public static final long OFFSET$frameRateNumerator

OFFSET$frameRateDenominator

public static final long OFFSET$frameRateDenominator

Constructor Details

VkVideoEncodeRateControlLayerInfoKHR

public VkVideoEncodeRateControlLayerInfoKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkVideoEncodeRateControlLayerInfoKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkVideoEncodeRateControlLayerInfoKHR allocate(Arena arena)

allocate

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

clone

public static VkVideoEncodeRateControlLayerInfoKHR clone(Arena arena,
 VkVideoEncodeRateControlLayerInfoKHR src)

autoInit

public void autoInit()

sType

@EnumType(VkStructureType.class)
public int sType()

sType

public VkVideoEncodeRateControlLayerInfoKHR sType(@EnumType(VkStructureType.class)
 int value)

pNext

@Pointer(comment="void*")
public MemorySegment pNext()

pNext

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

pNext

public VkVideoEncodeRateControlLayerInfoKHR pNext(@Nullable
 @Nullable IPointer pointer)

averageBitrate

@Unsigned
public long averageBitrate()

averageBitrate

public VkVideoEncodeRateControlLayerInfoKHR averageBitrate(@Unsigned
 long value)

maxBitrate

@Unsigned
public long maxBitrate()

maxBitrate

public VkVideoEncodeRateControlLayerInfoKHR maxBitrate(@Unsigned
 long value)

frameRateNumerator

@Unsigned
public int frameRateNumerator()

frameRateNumerator

public VkVideoEncodeRateControlLayerInfoKHR frameRateNumerator(@Unsigned
 int value)

frameRateDenominator

@Unsigned
public int frameRateDenominator()

frameRateDenominator

public VkVideoEncodeRateControlLayerInfoKHR frameRateDenominator(@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