Record Class WGPUSurfaceSourceMetalLayer

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUSurfaceSourceMetalLayer

All Implemented Interfaces:

IPointer, IWGPUSurfaceSourceMetalLayer

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUSurfaceSourceMetalLayer(@NotNull MemorySegment segment)
extends Record
implements IWGPUSurfaceSourceMetalLayer

Represents a pointer to a WGPUSurfaceSourceMetalLayer structure in native memory.

Structure

typedef struct WGPUSurfaceSourceMetalLayer {
    WGPUChainedStruct chain;
    void* layer;
} WGPUSurfaceSourceMetalLayer;

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	WGPUSurfaceSourceMetalLayer.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 AddressLayout	LAYOUT$layer
static final long	OFFSET$chain
static final long	OFFSET$layer
static final MemoryLayout.PathElement	PATH$chain
static final MemoryLayout.PathElement	PATH$layer
static final long	SIZE$chain
static final long	SIZE$layer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUSurfaceSourceMetalLayer	allocate(Arena arena)
static WGPUSurfaceSourceMetalLayer.Ptr	allocate(Arena arena, long count)
@NotNull WGPUChainedStruct	chain()
WGPUSurfaceSourceMetalLayer	chain(@NotNull WGPUChainedStruct value)
WGPUSurfaceSourceMetalLayer	chain(Consumer<@NotNull WGPUChainedStruct> consumer)
static WGPUSurfaceSourceMetalLayer	clone(Arena arena, WGPUSurfaceSourceMetalLayer 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.
@NotNull MemorySegment	layer()
WGPUSurfaceSourceMetalLayer	layer(@Nullable IPointer pointer)
WGPUSurfaceSourceMetalLayer	layer(@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$chain

public static final MemoryLayout.PathElement PATH$chain

PATH$layer

public static final MemoryLayout.PathElement PATH$layer

LAYOUT$chain

public static final StructLayout LAYOUT$chain

LAYOUT$layer

public static final AddressLayout LAYOUT$layer

SIZE$chain

public static final long SIZE$chain

SIZE$layer

public static final long SIZE$layer

OFFSET$chain

public static final long OFFSET$chain

OFFSET$layer

public static final long OFFSET$layer

Constructor Details

WGPUSurfaceSourceMetalLayer

public WGPUSurfaceSourceMetalLayer(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUSurfaceSourceMetalLayer record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUSurfaceSourceMetalLayer allocate(Arena arena)

allocate

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

clone

public static WGPUSurfaceSourceMetalLayer clone(Arena arena,
 WGPUSurfaceSourceMetalLayer src)

chain

@NotNull
public @NotNull WGPUChainedStruct chain()

chain

public WGPUSurfaceSourceMetalLayer chain(@NotNull
 @NotNull WGPUChainedStruct value)

chain

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

layer

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment layer()

layer

public WGPUSurfaceSourceMetalLayer layer(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

layer

public WGPUSurfaceSourceMetalLayer layer(@Nullable
 @Nullable IPointer pointer)

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