Record Class VkSharedPresentSurfaceCapabilitiesKHR.Ptr

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkSharedPresentSurfaceCapabilitiesKHR.Ptr

All Implemented Interfaces:

IPointer, IVkSharedPresentSurfaceCapabilitiesKHR, Iterable<VkSharedPresentSurfaceCapabilitiesKHR>

Enclosing class:

VkSharedPresentSurfaceCapabilitiesKHR

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

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

Technically speaking, this type has no difference with VkSharedPresentSurfaceCapabilitiesKHR. 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 IVkSharedPresentSurfaceCapabilitiesKHR 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 VkSharedPresentSurfaceCapabilitiesKHR.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 VkSharedPresentSurfaceCapabilitiesKHR	at(long index)	Returns (a pointer to) the structure at the given index.
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<VkSharedPresentSurfaceCapabilitiesKHR>	iterator()
@NotNull VkSharedPresentSurfaceCapabilitiesKHR.Ptr	offset(long offset)
@NotNull VkSharedPresentSurfaceCapabilitiesKHR.Ptr	reinterpret(long newSize)	Assume the VkSharedPresentSurfaceCapabilitiesKHR.Ptr is capable of holding at least newSize structures, create a new view VkSharedPresentSurfaceCapabilitiesKHR.Ptr that uses the same backing storage as this VkSharedPresentSurfaceCapabilitiesKHR.Ptr, but with the new size.
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
VkSharedPresentSurfaceCapabilitiesKHR.Ptr	slice(long end)
@NotNull VkSharedPresentSurfaceCapabilitiesKHR.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).
VkSharedPresentSurfaceCapabilitiesKHR[]	toArray()
final String	toString()	Returns a string representation of this record class.
void	write(long index, @NotNull VkSharedPresentSurfaceCapabilitiesKHR 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 VkSharedPresentSurfaceCapabilitiesKHR 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.

write

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

reinterpret

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

Assume the VkSharedPresentSurfaceCapabilitiesKHR.Ptr is capable of holding at least newSize structures, create a new view VkSharedPresentSurfaceCapabilitiesKHR.Ptr that uses the same backing storage as this VkSharedPresentSurfaceCapabilitiesKHR.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 VkSharedPresentSurfaceCapabilitiesKHR.Ptr offset(long offset)

slice

@NotNull
public @NotNull VkSharedPresentSurfaceCapabilitiesKHR.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 VkSharedPresentSurfaceCapabilitiesKHR.Ptr slice(long end)

toArray

public VkSharedPresentSurfaceCapabilitiesKHR[] toArray()

iterator

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

Specified by:

iterator in interface Iterable<VkSharedPresentSurfaceCapabilitiesKHR>

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