Record Class VkVideoInlineQueryInfoKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkVideoInlineQueryInfoKHR

All Implemented Interfaces:

IPointer, IVkVideoInlineQueryInfoKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkVideoInlineQueryInfoKHR(@NotNull MemorySegment segment)
extends Record
implements IVkVideoInlineQueryInfoKHR

Represents a pointer to a VkVideoInlineQueryInfoKHR structure in native memory.

Structure

typedef struct VkVideoInlineQueryInfoKHR {
    VkStructureType sType;
    void const* pNext; // optional
    VkQueryPool queryPool; // optional
    uint32_t firstQuery;
    uint32_t queryCount;
} VkVideoInlineQueryInfoKHR;

Auto initialization

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

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

• VkVideoInlineQueryInfoKHR

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$queryPool

PATH$firstQuery

public static final MemoryLayout.PathElement PATH$firstQuery

PATH$queryCount

public static final MemoryLayout.PathElement PATH$queryCount

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$queryPool

public static final AddressLayout LAYOUT$queryPool

LAYOUT$firstQuery

public static final ValueLayout.OfInt LAYOUT$firstQuery

LAYOUT$queryCount

public static final ValueLayout.OfInt LAYOUT$queryCount

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$queryPool

public static final long SIZE$queryPool

SIZE$firstQuery

public static final long SIZE$firstQuery

SIZE$queryCount

public static final long SIZE$queryCount

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$queryPool

public static final long OFFSET$queryPool

OFFSET$firstQuery

public static final long OFFSET$firstQuery

OFFSET$queryCount

public static final long OFFSET$queryCount

Constructor Details

VkVideoInlineQueryInfoKHR

public VkVideoInlineQueryInfoKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkVideoInlineQueryInfoKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkVideoInlineQueryInfoKHR allocate(Arena arena)

allocate

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

clone

public static VkVideoInlineQueryInfoKHR clone(Arena arena,
 VkVideoInlineQueryInfoKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkVideoInlineQueryInfoKHR pNext(@Nullable
 @Nullable IPointer pointer)

queryPool

@Nullable
public @Nullable VkQueryPool queryPool()

queryPool

public VkVideoInlineQueryInfoKHR queryPool(@Nullable
 @Nullable VkQueryPool value)

firstQuery

@Unsigned
public int firstQuery()

firstQuery

public VkVideoInlineQueryInfoKHR firstQuery(@Unsigned
 int value)

queryCount

@Unsigned
public int queryCount()

queryCount

public VkVideoInlineQueryInfoKHR queryCount(@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