Record Class WGPUSurfaceConfigurationExtras

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUSurfaceConfigurationExtras

All Implemented Interfaces:

IPointer, IWGPUSurfaceConfigurationExtras

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUSurfaceConfigurationExtras(@NotNull MemorySegment segment)
extends Record
implements IWGPUSurfaceConfigurationExtras

Represents a pointer to a WGPUSurfaceConfigurationExtras structure in native memory.

Structure

typedef struct WGPUSurfaceConfigurationExtras {
    WGPUChainedStruct chain;
    uint32_t desiredMaximumFrameLatency;
} WGPUSurfaceConfigurationExtras;

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	WGPUSurfaceConfigurationExtras.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$chain
static final ValueLayout.OfInt	LAYOUT$desiredMaximumFrameLatency
static final long	OFFSET$chain
static final long	OFFSET$desiredMaximumFrameLatency
static final MemoryLayout.PathElement	PATH$chain
static final MemoryLayout.PathElement	PATH$desiredMaximumFrameLatency
static final long	SIZE$chain
static final long	SIZE$desiredMaximumFrameLatency

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUSurfaceConfigurationExtras	allocate(Arena arena)
static WGPUSurfaceConfigurationExtras.Ptr	allocate(Arena arena, long count)
@NotNull WGPUChainedStruct	chain()
WGPUSurfaceConfigurationExtras	chain(@NotNull WGPUChainedStruct value)
WGPUSurfaceConfigurationExtras	chain(Consumer<@NotNull WGPUChainedStruct> consumer)
static WGPUSurfaceConfigurationExtras	clone(Arena arena, WGPUSurfaceConfigurationExtras src)
int	desiredMaximumFrameLatency()
WGPUSurfaceConfigurationExtras	desiredMaximumFrameLatency(int 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.
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$chain

public static final MemoryLayout.PathElement PATH$chain

PATH$desiredMaximumFrameLatency

public static final MemoryLayout.PathElement PATH$desiredMaximumFrameLatency

LAYOUT$chain

public static final StructLayout LAYOUT$chain

LAYOUT$desiredMaximumFrameLatency

public static final ValueLayout.OfInt LAYOUT$desiredMaximumFrameLatency

SIZE$chain

public static final long SIZE$chain

SIZE$desiredMaximumFrameLatency

public static final long SIZE$desiredMaximumFrameLatency

OFFSET$chain

public static final long OFFSET$chain

OFFSET$desiredMaximumFrameLatency

public static final long OFFSET$desiredMaximumFrameLatency

Constructor Details

WGPUSurfaceConfigurationExtras

public WGPUSurfaceConfigurationExtras(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUSurfaceConfigurationExtras record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUSurfaceConfigurationExtras allocate(Arena arena)

allocate

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

clone

public static WGPUSurfaceConfigurationExtras clone(Arena arena,
 WGPUSurfaceConfigurationExtras src)

chain

@NotNull
public @NotNull WGPUChainedStruct chain()

chain

public WGPUSurfaceConfigurationExtras chain(@NotNull
 @NotNull WGPUChainedStruct value)

chain

public WGPUSurfaceConfigurationExtras chain(Consumer<@NotNull WGPUChainedStruct> consumer)

desiredMaximumFrameLatency

@Unsigned
public int desiredMaximumFrameLatency()

desiredMaximumFrameLatency

public WGPUSurfaceConfigurationExtras desiredMaximumFrameLatency(@Unsigned
 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