Record Class WGPUChainedStruct

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUChainedStruct

All Implemented Interfaces:

IPointer, IWGPUChainedStruct

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUChainedStruct(@NotNull MemorySegment segment)
extends Record
implements IWGPUChainedStruct

Represents a pointer to a WGPUChainedStruct structure in native memory.

Structure

typedef struct WGPUChainedStruct {
    WGPUChainedStruct* next; // optional
    WGPUSType sType;
} WGPUChainedStruct;

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	WGPUChainedStruct.Ptr	Represents a pointer to / an array of null 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$next
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$next
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$next
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUChainedStruct	allocate(Arena arena)
static WGPUChainedStruct.Ptr	allocate(Arena arena, long count)
static WGPUChainedStruct	clone(Arena arena, WGPUChainedStruct 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.
@Nullable WGPUChainedStruct	next()
WGPUChainedStruct.Ptr	next(int assumedCount)
WGPUChainedStruct	next(@Nullable IWGPUChainedStruct value)
@NotNull MemorySegment	nextRaw()
void	nextRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
WGPUChainedStruct	sType(int 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$next

public static final MemoryLayout.PathElement PATH$next

PATH$sType

public static final MemoryLayout.PathElement PATH$sType

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

SIZE$next

public static final long SIZE$next

SIZE$sType

public static final long SIZE$sType

OFFSET$next

public static final long OFFSET$next

OFFSET$sType

public static final long OFFSET$sType

Constructor Details

WGPUChainedStruct

public WGPUChainedStruct(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUChainedStruct record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUChainedStruct allocate(Arena arena)

allocate

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

clone

public static WGPUChainedStruct clone(Arena arena,
 WGPUChainedStruct src)

next

public WGPUChainedStruct next(@Nullable
 @Nullable IWGPUChainedStruct value)

next

@Unsafe
@Nullable
public WGPUChainedStruct.Ptr next(int assumedCount)

next

@Nullable
public @Nullable WGPUChainedStruct next()

nextRaw

@Pointer(target=WGPUChainedStruct.class)
@NotNull
public @NotNull MemorySegment nextRaw()

nextRaw

public void nextRaw(@Pointer(target=WGPUChainedStruct.class) @NotNull
 @NotNull MemorySegment value)

sType

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

sType

public WGPUChainedStruct sType(@EnumType(WGPUSType.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