Record Class VkDeviceOrHostAddressKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkDeviceOrHostAddressKHR

All Implemented Interfaces:

IPointer, IVkDeviceOrHostAddressKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkDeviceOrHostAddressKHR(@NotNull MemorySegment segment)
extends Record
implements IVkDeviceOrHostAddressKHR

Represents a pointer to a VkDeviceOrHostAddressKHR structure in native memory.

Structure

typedef union VkDeviceOrHostAddressKHR {
    VkDeviceAddress deviceAddress;
    void* hostAddress;
} VkDeviceOrHostAddressKHR;

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:

• VkDeviceOrHostAddressKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkDeviceOrHostAddressKHR.Ptr	Represents a pointer to / an array of VkDeviceOrHostAddressKHR structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final UnionLayout	LAYOUT
static final ValueLayout.OfLong	LAYOUT$deviceAddress
static final AddressLayout	LAYOUT$hostAddress
static final long	OFFSET$deviceAddress
static final long	OFFSET$hostAddress
static final MemoryLayout.PathElement	PATH$deviceAddress
static final MemoryLayout.PathElement	PATH$hostAddress
static final long	SIZE$deviceAddress
static final long	SIZE$hostAddress

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDeviceOrHostAddressKHR	allocate(Arena arena)
static VkDeviceOrHostAddressKHR.Ptr	allocate(Arena arena, long count)
static VkDeviceOrHostAddressKHR	clone(Arena arena, VkDeviceOrHostAddressKHR src)
long	deviceAddress()
VkDeviceOrHostAddressKHR	deviceAddress(long value)
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	hostAddress()
VkDeviceOrHostAddressKHR	hostAddress(@Nullable IPointer pointer)
VkDeviceOrHostAddressKHR	hostAddress(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
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 UnionLayout LAYOUT

BYTES

public static final long BYTES

PATH$deviceAddress

public static final MemoryLayout.PathElement PATH$deviceAddress

PATH$hostAddress

public static final MemoryLayout.PathElement PATH$hostAddress

LAYOUT$deviceAddress

public static final ValueLayout.OfLong LAYOUT$deviceAddress

LAYOUT$hostAddress

public static final AddressLayout LAYOUT$hostAddress

SIZE$deviceAddress

public static final long SIZE$deviceAddress

SIZE$hostAddress

public static final long SIZE$hostAddress

OFFSET$deviceAddress

public static final long OFFSET$deviceAddress

OFFSET$hostAddress

public static final long OFFSET$hostAddress

Constructor Details

VkDeviceOrHostAddressKHR

public VkDeviceOrHostAddressKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkDeviceOrHostAddressKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkDeviceOrHostAddressKHR allocate(Arena arena)

allocate

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

clone

public static VkDeviceOrHostAddressKHR clone(Arena arena,
 VkDeviceOrHostAddressKHR src)

deviceAddress

@NativeType("VkDeviceAddress")
@Unsigned
public long deviceAddress()

deviceAddress

public VkDeviceOrHostAddressKHR deviceAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

hostAddress

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

hostAddress

public VkDeviceOrHostAddressKHR hostAddress(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

hostAddress

public VkDeviceOrHostAddressKHR hostAddress(@Nullable
 @Nullable IPointer pointer)

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