Record Class WGPURequestAdapterOptions

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPURequestAdapterOptions

All Implemented Interfaces:

IPointer, IWGPURequestAdapterOptions

@ValueBasedCandidate
@UnsafeConstructor
public record WGPURequestAdapterOptions(@NotNull MemorySegment segment)
extends Record
implements IWGPURequestAdapterOptions

Represents a pointer to a WGPURequestAdapterOptions structure in native memory.

Structure

typedef struct WGPURequestAdapterOptions {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUFeatureLevel featureLevel;
    WGPUPowerPreference powerPreference;
    WGPUBool forceFallbackAdapter;
    WGPUBackendType backendType;
    WGPUSurface compatibleSurface; // optional
} WGPURequestAdapterOptions;

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	WGPURequestAdapterOptions.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 ValueLayout.OfInt	LAYOUT$backendType
static final AddressLayout	LAYOUT$compatibleSurface
static final ValueLayout.OfInt	LAYOUT$featureLevel
static final ValueLayout.OfInt	LAYOUT$forceFallbackAdapter
static final AddressLayout	LAYOUT$nextInChain
static final ValueLayout.OfInt	LAYOUT$powerPreference
static final long	OFFSET$backendType
static final long	OFFSET$compatibleSurface
static final long	OFFSET$featureLevel
static final long	OFFSET$forceFallbackAdapter
static final long	OFFSET$nextInChain
static final long	OFFSET$powerPreference
static final MemoryLayout.PathElement	PATH$backendType
static final MemoryLayout.PathElement	PATH$compatibleSurface
static final MemoryLayout.PathElement	PATH$featureLevel
static final MemoryLayout.PathElement	PATH$forceFallbackAdapter
static final MemoryLayout.PathElement	PATH$nextInChain
static final MemoryLayout.PathElement	PATH$powerPreference
static final long	SIZE$backendType
static final long	SIZE$compatibleSurface
static final long	SIZE$featureLevel
static final long	SIZE$forceFallbackAdapter
static final long	SIZE$nextInChain
static final long	SIZE$powerPreference

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$featureLevel

PATH$powerPreference

public static final MemoryLayout.PathElement PATH$powerPreference

PATH$forceFallbackAdapter

public static final MemoryLayout.PathElement PATH$forceFallbackAdapter

PATH$backendType

public static final MemoryLayout.PathElement PATH$backendType

PATH$compatibleSurface

public static final MemoryLayout.PathElement PATH$compatibleSurface

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$featureLevel

public static final ValueLayout.OfInt LAYOUT$featureLevel

LAYOUT$powerPreference

public static final ValueLayout.OfInt LAYOUT$powerPreference

LAYOUT$forceFallbackAdapter

public static final ValueLayout.OfInt LAYOUT$forceFallbackAdapter

LAYOUT$backendType

public static final ValueLayout.OfInt LAYOUT$backendType

LAYOUT$compatibleSurface

public static final AddressLayout LAYOUT$compatibleSurface

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$featureLevel

public static final long SIZE$featureLevel

SIZE$powerPreference

public static final long SIZE$powerPreference

SIZE$forceFallbackAdapter

public static final long SIZE$forceFallbackAdapter

SIZE$backendType

public static final long SIZE$backendType

SIZE$compatibleSurface

public static final long SIZE$compatibleSurface

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$featureLevel

public static final long OFFSET$featureLevel

OFFSET$powerPreference

public static final long OFFSET$powerPreference

OFFSET$forceFallbackAdapter

public static final long OFFSET$forceFallbackAdapter

OFFSET$backendType

public static final long OFFSET$backendType

OFFSET$compatibleSurface

public static final long OFFSET$compatibleSurface

Constructor Details

WGPURequestAdapterOptions

public WGPURequestAdapterOptions(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPURequestAdapterOptions record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPURequestAdapterOptions allocate(Arena arena)

allocate

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

clone

public static WGPURequestAdapterOptions clone(Arena arena,
 WGPURequestAdapterOptions src)

nextInChain

public WGPURequestAdapterOptions 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)

featureLevel

@EnumType(WGPUFeatureLevel.class)
public int featureLevel()

featureLevel

public WGPURequestAdapterOptions featureLevel(@EnumType(WGPUFeatureLevel.class)
 int value)

powerPreference

@EnumType(WGPUPowerPreference.class)
public int powerPreference()

powerPreference

public WGPURequestAdapterOptions powerPreference(@EnumType(WGPUPowerPreference.class)
 int value)

forceFallbackAdapter

@NativeType("WGPUBool")
@Unsigned
public int forceFallbackAdapter()

forceFallbackAdapter

public WGPURequestAdapterOptions forceFallbackAdapter(@NativeType("WGPUBool") @Unsigned
 int value)

backendType

@EnumType(WGPUBackendType.class)
public int backendType()

backendType

public WGPURequestAdapterOptions backendType(@EnumType(WGPUBackendType.class)
 int value)

compatibleSurface

@Nullable
public @Nullable WGPUSurface compatibleSurface()

compatibleSurface

public WGPURequestAdapterOptions compatibleSurface(@Nullable
 @Nullable WGPUSurface 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