Record Class VkStridedDeviceAddressRegionKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkStridedDeviceAddressRegionKHR

All Implemented Interfaces:

IPointer, IVkStridedDeviceAddressRegionKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkStridedDeviceAddressRegionKHR(@NotNull MemorySegment segment)
extends Record
implements IVkStridedDeviceAddressRegionKHR

Represents a pointer to a VkStridedDeviceAddressRegionKHR structure in native memory.

Structure

typedef struct VkStridedDeviceAddressRegionKHR {
    VkDeviceAddress deviceAddress; // optional
    VkDeviceSize stride;
    VkDeviceSize size;
} VkStridedDeviceAddressRegionKHR;

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:

• VkStridedDeviceAddressRegionKHR

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfLong	LAYOUT$deviceAddress
static final ValueLayout.OfLong	LAYOUT$size
static final ValueLayout.OfLong	LAYOUT$stride
static final long	OFFSET$deviceAddress
static final long	OFFSET$size
static final long	OFFSET$stride
static final MemoryLayout.PathElement	PATH$deviceAddress
static final MemoryLayout.PathElement	PATH$size
static final MemoryLayout.PathElement	PATH$stride
static final long	SIZE$deviceAddress
static final long	SIZE$size
static final long	SIZE$stride

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkStridedDeviceAddressRegionKHR	allocate(Arena arena)
static VkStridedDeviceAddressRegionKHR.Ptr	allocate(Arena arena, long count)
static VkStridedDeviceAddressRegionKHR	clone(Arena arena, VkStridedDeviceAddressRegionKHR src)
long	deviceAddress()
VkStridedDeviceAddressRegionKHR	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	segment()	Returns the value of the segment record component.
long	size()
VkStridedDeviceAddressRegionKHR	size(long value)
long	stride()
VkStridedDeviceAddressRegionKHR	stride(long 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$deviceAddress

public static final MemoryLayout.PathElement PATH$deviceAddress

PATH$stride

public static final MemoryLayout.PathElement PATH$stride

PATH$size

public static final MemoryLayout.PathElement PATH$size

LAYOUT$deviceAddress

public static final ValueLayout.OfLong LAYOUT$deviceAddress

LAYOUT$stride

public static final ValueLayout.OfLong LAYOUT$stride

LAYOUT$size

public static final ValueLayout.OfLong LAYOUT$size

SIZE$deviceAddress

public static final long SIZE$deviceAddress

SIZE$stride

public static final long SIZE$stride

SIZE$size

public static final long SIZE$size

OFFSET$deviceAddress

public static final long OFFSET$deviceAddress

OFFSET$stride

public static final long OFFSET$stride

OFFSET$size

public static final long OFFSET$size

Constructor Details

VkStridedDeviceAddressRegionKHR

public VkStridedDeviceAddressRegionKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkStridedDeviceAddressRegionKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkStridedDeviceAddressRegionKHR allocate(Arena arena)

allocate

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

clone

public static VkStridedDeviceAddressRegionKHR clone(Arena arena,
 VkStridedDeviceAddressRegionKHR src)

deviceAddress

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

deviceAddress

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

stride

@NativeType("VkDeviceSize")
@Unsigned
public long stride()

stride

public VkStridedDeviceAddressRegionKHR stride(@NativeType("VkDeviceSize") @Unsigned
 long value)

size

@NativeType("VkDeviceSize")
@Unsigned
public long size()

size

public VkStridedDeviceAddressRegionKHR size(@NativeType("VkDeviceSize") @Unsigned
 long 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