Record Class VkVideoDecodeUsageInfoKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkVideoDecodeUsageInfoKHR

All Implemented Interfaces:

IPointer, IVkVideoDecodeUsageInfoKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkVideoDecodeUsageInfoKHR(@NotNull MemorySegment segment)
extends Record
implements IVkVideoDecodeUsageInfoKHR

Represents a pointer to a VkVideoDecodeUsageInfoKHR structure in native memory.

Structure

typedef struct VkVideoDecodeUsageInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    VkVideoDecodeUsageFlagsKHR videoUsageHints; // optional
} VkVideoDecodeUsageInfoKHR;

Auto initialization

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

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

• VkVideoDecodeUsageInfoKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkVideoDecodeUsageInfoKHR.Ptr	Represents a pointer to / an array of VkVideoDecodeUsageInfoKHR 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 ValueLayout.OfInt	LAYOUT$sType
static final ValueLayout.OfInt	LAYOUT$videoUsageHints
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final long	OFFSET$videoUsageHints
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final MemoryLayout.PathElement	PATH$videoUsageHints
static final long	SIZE$pNext
static final long	SIZE$sType
static final long	SIZE$videoUsageHints

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkVideoDecodeUsageInfoKHR	allocate(Arena arena)
static VkVideoDecodeUsageInfoKHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkVideoDecodeUsageInfoKHR	clone(Arena arena, VkVideoDecodeUsageInfoKHR 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.
@NotNull MemorySegment	pNext()
VkVideoDecodeUsageInfoKHR	pNext(@Nullable IPointer pointer)
VkVideoDecodeUsageInfoKHR	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkVideoDecodeUsageInfoKHR	sType(int value)
final String	toString()	Returns a string representation of this record class.
int	videoUsageHints()
VkVideoDecodeUsageInfoKHR	videoUsageHints(int value)

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$videoUsageHints

public static final MemoryLayout.PathElement PATH$videoUsageHints

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$videoUsageHints

public static final ValueLayout.OfInt LAYOUT$videoUsageHints

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$videoUsageHints

public static final long SIZE$videoUsageHints

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$videoUsageHints

public static final long OFFSET$videoUsageHints

Constructor Details

VkVideoDecodeUsageInfoKHR

public VkVideoDecodeUsageInfoKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkVideoDecodeUsageInfoKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkVideoDecodeUsageInfoKHR allocate(Arena arena)

allocate

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

clone

public static VkVideoDecodeUsageInfoKHR clone(Arena arena,
 VkVideoDecodeUsageInfoKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkVideoDecodeUsageInfoKHR pNext(@Nullable
 @Nullable IPointer pointer)

videoUsageHints

@Bitmask(VkVideoDecodeUsageFlagsKHR.class)
public int videoUsageHints()

videoUsageHints

public VkVideoDecodeUsageInfoKHR videoUsageHints(@Bitmask(VkVideoDecodeUsageFlagsKHR.class)
 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