Record Class WGPUInstanceDescriptor

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUInstanceDescriptor

All Implemented Interfaces:

IPointer, IWGPUInstanceDescriptor

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUInstanceDescriptor(@NotNull MemorySegment segment)
extends Record
implements IWGPUInstanceDescriptor

Represents a pointer to a WGPUInstanceDescriptor structure in native memory.

Structure

typedef struct WGPUInstanceDescriptor {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUInstanceCapabilities features;
} WGPUInstanceDescriptor;

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	WGPUInstanceDescriptor.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 StructLayout	LAYOUT$features
static final AddressLayout	LAYOUT$nextInChain
static final long	OFFSET$features
static final long	OFFSET$nextInChain
static final MemoryLayout.PathElement	PATH$features
static final MemoryLayout.PathElement	PATH$nextInChain
static final long	SIZE$features
static final long	SIZE$nextInChain

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUInstanceDescriptor	allocate(Arena arena)
static WGPUInstanceDescriptor.Ptr	allocate(Arena arena, long count)
static WGPUInstanceDescriptor	clone(Arena arena, WGPUInstanceDescriptor src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull WGPUInstanceCapabilities	features()
WGPUInstanceDescriptor	features(@NotNull WGPUInstanceCapabilities value)
WGPUInstanceDescriptor	features(Consumer<@NotNull WGPUInstanceCapabilities> consumer)
final int	hashCode()	Returns a hash code value for this object.
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUInstanceDescriptor	nextInChain(@Nullable IWGPUChainedStruct value)
@NotNull MemorySegment	nextInChainRaw()
void	nextInChainRaw(@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 StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$nextInChain

public static final MemoryLayout.PathElement PATH$nextInChain

PATH$features

public static final MemoryLayout.PathElement PATH$features

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$features

public static final StructLayout LAYOUT$features

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$features

public static final long SIZE$features

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$features

public static final long OFFSET$features

Constructor Details

WGPUInstanceDescriptor

public WGPUInstanceDescriptor(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUInstanceDescriptor record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUInstanceDescriptor allocate(Arena arena)

allocate

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

clone

public static WGPUInstanceDescriptor clone(Arena arena,
 WGPUInstanceDescriptor src)

nextInChain

public WGPUInstanceDescriptor nextInChain(@Nullable
 @Nullable IWGPUChainedStruct value)

nextInChain

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

nextInChain

@Nullable
public @Nullable WGPUChainedStruct nextInChain()

nextInChainRaw

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

nextInChainRaw

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

features

@NotNull
public @NotNull WGPUInstanceCapabilities features()

features

public WGPUInstanceDescriptor features(@NotNull
 @NotNull WGPUInstanceCapabilities value)

features

public WGPUInstanceDescriptor features(Consumer<@NotNull WGPUInstanceCapabilities> consumer)

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