Record Class VkVideoEncodeQuantizationMapInfoKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkVideoEncodeQuantizationMapInfoKHR

All Implemented Interfaces:

IPointer, IVkVideoEncodeQuantizationMapInfoKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkVideoEncodeQuantizationMapInfoKHR(@NotNull MemorySegment segment)
extends Record
implements IVkVideoEncodeQuantizationMapInfoKHR

Represents a pointer to a VkVideoEncodeQuantizationMapInfoKHR structure in native memory.

Structure

typedef struct VkVideoEncodeQuantizationMapInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    VkImageView quantizationMap; // optional
    VkExtent2D quantizationMapExtent;
} VkVideoEncodeQuantizationMapInfoKHR;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_VIDEO_ENCODE_QUANTIZATION_MAP_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:

• VkVideoEncodeQuantizationMapInfoKHR

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$quantizationMap
static final StructLayout	LAYOUT$quantizationMapExtent
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$pNext
static final long	OFFSET$quantizationMap
static final long	OFFSET$quantizationMapExtent
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$quantizationMap
static final MemoryLayout.PathElement	PATH$quantizationMapExtent
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$pNext
static final long	SIZE$quantizationMap
static final long	SIZE$quantizationMapExtent
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$quantizationMap

PATH$quantizationMapExtent

public static final MemoryLayout.PathElement PATH$quantizationMapExtent

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$quantizationMap

public static final AddressLayout LAYOUT$quantizationMap

LAYOUT$quantizationMapExtent

public static final StructLayout LAYOUT$quantizationMapExtent

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$quantizationMap

public static final long SIZE$quantizationMap

SIZE$quantizationMapExtent

public static final long SIZE$quantizationMapExtent

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$quantizationMap

public static final long OFFSET$quantizationMap

OFFSET$quantizationMapExtent

public static final long OFFSET$quantizationMapExtent

Constructor Details

VkVideoEncodeQuantizationMapInfoKHR

public VkVideoEncodeQuantizationMapInfoKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkVideoEncodeQuantizationMapInfoKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkVideoEncodeQuantizationMapInfoKHR allocate(Arena arena)

allocate

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

clone

public static VkVideoEncodeQuantizationMapInfoKHR clone(Arena arena,
 VkVideoEncodeQuantizationMapInfoKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkVideoEncodeQuantizationMapInfoKHR pNext(@Nullable
 @Nullable IPointer pointer)

quantizationMap

@Nullable
public @Nullable VkImageView quantizationMap()

quantizationMap

public VkVideoEncodeQuantizationMapInfoKHR quantizationMap(@Nullable
 @Nullable VkImageView value)

quantizationMapExtent

@NotNull
public @NotNull VkExtent2D quantizationMapExtent()

quantizationMapExtent

public VkVideoEncodeQuantizationMapInfoKHR quantizationMapExtent(@NotNull
 @NotNull VkExtent2D value)

quantizationMapExtent

public VkVideoEncodeQuantizationMapInfoKHR quantizationMapExtent(Consumer<@NotNull VkExtent2D> consumer)

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