Record Class WGPUSupportedFeatures

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUSupportedFeatures

All Implemented Interfaces:

IPointer, IWGPUSupportedFeatures

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUSupportedFeatures(@NotNull MemorySegment segment)
extends Record
implements IWGPUSupportedFeatures

Represents a pointer to a WGPUSupportedFeatures structure in native memory.

Structure

typedef struct WGPUSupportedFeatures {
    size_t featureCount;
    WGPUFeatureName const* features;
} WGPUSupportedFeatures;

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	WGPUSupportedFeatures.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$features
static final long	OFFSET$featureCount
static final long	OFFSET$features
static final MemoryLayout.PathElement	PATH$featureCount
static final MemoryLayout.PathElement	PATH$features
static final long	SIZE$featureCount
static final long	SIZE$features

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUSupportedFeatures	allocate(Arena arena)
static WGPUSupportedFeatures.Ptr	allocate(Arena arena, long count)
static WGPUSupportedFeatures	clone(Arena arena, WGPUSupportedFeatures src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	featureCount()
WGPUSupportedFeatures	featureCount(long value)
@Nullable IntPtr	features()	Note: the returned IntPtr does not have correct IntPtr.size() property.
WGPUSupportedFeatures	features(@Nullable IntPtr value)
@NotNull MemorySegment	featuresRaw()
void	featuresRaw(@NotNull MemorySegment value)
final int	hashCode()	Returns a hash code value for this object.
@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$featureCount

public static final MemoryLayout.PathElement PATH$featureCount

PATH$features

public static final MemoryLayout.PathElement PATH$features

LAYOUT$features

public static final AddressLayout LAYOUT$features

SIZE$featureCount

public static final long SIZE$featureCount

SIZE$features

public static final long SIZE$features

OFFSET$featureCount

public static final long OFFSET$featureCount

OFFSET$features

public static final long OFFSET$features

Constructor Details

WGPUSupportedFeatures

public WGPUSupportedFeatures(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUSupportedFeatures record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUSupportedFeatures allocate(Arena arena)

allocate

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

clone

public static WGPUSupportedFeatures clone(Arena arena,
 WGPUSupportedFeatures src)

featureCount

@Unsigned
public long featureCount()

featureCount

public WGPUSupportedFeatures featureCount(@Unsigned
 long value)

features

@Nullable
@EnumType(WGPUFeatureName.class)
public @Nullable IntPtr features()

Note: the returned IntPtr does not have correct IntPtr.size() property. It's up to user to track the size of the buffer, and use IntPtr.reinterpret(long) to set the size before actually reading fro or writing to the buffer.

features

public WGPUSupportedFeatures features(@Nullable @EnumType(WGPUFeatureName.class)
 @Nullable IntPtr value)

featuresRaw

@Pointer(target=WGPUFeatureName.class)
@NotNull
public @NotNull MemorySegment featuresRaw()

featuresRaw

public void featuresRaw(@Pointer(target=WGPUFeatureName.class) @NotNull
 @NotNull MemorySegment 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