Record Class VkVideoEncodeAV1CapabilitiesKHR.Ptr

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkVideoEncodeAV1CapabilitiesKHR.Ptr

All Implemented Interfaces:

IPointer, IVkVideoEncodeAV1CapabilitiesKHR, Iterable<VkVideoEncodeAV1CapabilitiesKHR>

Enclosing class:

VkVideoEncodeAV1CapabilitiesKHR

@ValueBasedCandidate
@UnsafeConstructor
public static record VkVideoEncodeAV1CapabilitiesKHR.Ptr(@NotNull MemorySegment segment)
extends Record
implements IVkVideoEncodeAV1CapabilitiesKHR, Iterable<VkVideoEncodeAV1CapabilitiesKHR>

Represents a pointer to / an array of VkVideoEncodeAV1CapabilitiesKHR structure(s) in native memory.

Technically speaking, this type has no difference with VkVideoEncodeAV1CapabilitiesKHR. This type is introduced mainly for user to distinguish between a pointer to a single structure and a pointer to (potentially) an array of structure(s). APIs should use interface IVkVideoEncodeAV1CapabilitiesKHR to handle both types uniformly. See package level documentation for more details.

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to VkVideoEncodeAV1CapabilitiesKHR.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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NotNull VkVideoEncodeAV1CapabilitiesKHR	at(long index)	Returns (a pointer to) the structure at the given index.
VkVideoEncodeAV1CapabilitiesKHR.Ptr	at(long index, @NotNull Consumer<@NotNull VkVideoEncodeAV1CapabilitiesKHR> consumer)
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 Iterator<VkVideoEncodeAV1CapabilitiesKHR>	iterator()
@NotNull VkVideoEncodeAV1CapabilitiesKHR.Ptr	offset(long offset)
@NotNull VkVideoEncodeAV1CapabilitiesKHR.Ptr	reinterpret(long newSize)	Assume the VkVideoEncodeAV1CapabilitiesKHR.Ptr is capable of holding at least newSize structures, create a new view VkVideoEncodeAV1CapabilitiesKHR.Ptr that uses the same backing storage as this VkVideoEncodeAV1CapabilitiesKHR.Ptr, but with the new size.
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
VkVideoEncodeAV1CapabilitiesKHR.Ptr	slice(long end)
@NotNull VkVideoEncodeAV1CapabilitiesKHR.Ptr	slice(long start, long end)	Note that this function uses the List.subList(int, int) semantics (left inclusive, right exclusive interval), not MemorySegment.asSlice(long, long) semantics (offset + newSize).
VkVideoEncodeAV1CapabilitiesKHR[]	toArray()
final String	toString()	Returns a string representation of this record class.
void	write(long index, @NotNull VkVideoEncodeAV1CapabilitiesKHR value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

Ptr

public Ptr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a Ptr record class.

Parameters:

segment - the value for the segment record component

Method Details

size

public long size()

at

@NotNull
public @NotNull VkVideoEncodeAV1CapabilitiesKHR at(long index)

Returns (a pointer to) the structure at the given index.

Note that unlike read series functions (IntPtr.read() for example), modification on returned structure will be reflected on the original structure array. So this function is called at to explicitly indicate that the returned structure is a view of the original structure.

at

public VkVideoEncodeAV1CapabilitiesKHR.Ptr at(long index,
 @NotNull
 @NotNull Consumer<@NotNull VkVideoEncodeAV1CapabilitiesKHR> consumer)

write

public void write(long index,
 @NotNull
 @NotNull VkVideoEncodeAV1CapabilitiesKHR value)

reinterpret

@Unsafe
@NotNull
public @NotNull VkVideoEncodeAV1CapabilitiesKHR.Ptr reinterpret(long newSize)

Assume the VkVideoEncodeAV1CapabilitiesKHR.Ptr is capable of holding at least newSize structures, create a new view VkVideoEncodeAV1CapabilitiesKHR.Ptr that uses the same backing storage as this VkVideoEncodeAV1CapabilitiesKHR.Ptr, but with the new size. Since there is actually no way to really check whether the new size is valid, while buffer overflow is undefined behavior, this method is marked as Unsafe.

This method could be useful when handling data returned from some C API, where the size of the data is not known in advance.

If the size of the underlying segment is actually known in advance and correctly set, and you want to create a shrunk view, you may use slice(long) (with validation) instead.

offset

@NotNull
public @NotNull VkVideoEncodeAV1CapabilitiesKHR.Ptr offset(long offset)

slice

@NotNull
public @NotNull VkVideoEncodeAV1CapabilitiesKHR.Ptr slice(long start,
 long end)

Note that this function uses the List.subList(int, int) semantics (left inclusive, right exclusive interval), not MemorySegment.asSlice(long, long) semantics (offset + newSize). Be careful with the difference

slice

public VkVideoEncodeAV1CapabilitiesKHR.Ptr slice(long end)

toArray

public VkVideoEncodeAV1CapabilitiesKHR[] toArray()

iterator

@NotNull
public @NotNull Iterator<VkVideoEncodeAV1CapabilitiesKHR> iterator()

Specified by:

iterator in interface Iterable<VkVideoEncodeAV1CapabilitiesKHR>

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