Record Class VkQueueFamilyVideoPropertiesKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkQueueFamilyVideoPropertiesKHR

All Implemented Interfaces:

IPointer, IVkQueueFamilyVideoPropertiesKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkQueueFamilyVideoPropertiesKHR(@NotNull MemorySegment segment)
extends Record
implements IVkQueueFamilyVideoPropertiesKHR

Represents a pointer to a VkQueueFamilyVideoPropertiesKHR structure in native memory.

Structure

typedef struct VkQueueFamilyVideoPropertiesKHR {
    VkStructureType sType;
    void* pNext; // optional
    VkVideoCodecOperationFlagsKHR videoCodecOperations;
} VkQueueFamilyVideoPropertiesKHR;

Auto initialization

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

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

• VkQueueFamilyVideoPropertiesKHR

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$videoCodecOperations

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$videoCodecOperations

public static final ValueLayout.OfInt LAYOUT$videoCodecOperations

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$videoCodecOperations

public static final long SIZE$videoCodecOperations

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$videoCodecOperations

public static final long OFFSET$videoCodecOperations

Constructor Details

VkQueueFamilyVideoPropertiesKHR

public VkQueueFamilyVideoPropertiesKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkQueueFamilyVideoPropertiesKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkQueueFamilyVideoPropertiesKHR allocate(Arena arena)

allocate

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

clone

public static VkQueueFamilyVideoPropertiesKHR clone(Arena arena,
 VkQueueFamilyVideoPropertiesKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkQueueFamilyVideoPropertiesKHR pNext(@Nullable
 @Nullable IPointer pointer)

videoCodecOperations

@Bitmask(VkVideoCodecOperationFlagsKHR.class)
public int videoCodecOperations()

videoCodecOperations

public VkQueueFamilyVideoPropertiesKHR videoCodecOperations(@Bitmask(VkVideoCodecOperationFlagsKHR.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