Record Class WGPUComputePipelineDescriptor

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUComputePipelineDescriptor

All Implemented Interfaces:

IPointer, IWGPUComputePipelineDescriptor

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUComputePipelineDescriptor(@NotNull MemorySegment segment)
extends Record
implements IWGPUComputePipelineDescriptor

Represents a pointer to a WGPUComputePipelineDescriptor structure in native memory.

Structure

typedef struct WGPUComputePipelineDescriptor {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUStringView label;
    WGPUPipelineLayout layout; // optional
    WGPUProgrammableStageDescriptor compute;
} WGPUComputePipelineDescriptor;

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	WGPUComputePipelineDescriptor.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$compute
static final StructLayout	LAYOUT$label
static final AddressLayout	LAYOUT$layout
static final AddressLayout	LAYOUT$nextInChain
static final long	OFFSET$compute
static final long	OFFSET$label
static final long	OFFSET$layout
static final long	OFFSET$nextInChain
static final MemoryLayout.PathElement	PATH$compute
static final MemoryLayout.PathElement	PATH$label
static final MemoryLayout.PathElement	PATH$layout
static final MemoryLayout.PathElement	PATH$nextInChain
static final long	SIZE$compute
static final long	SIZE$label
static final long	SIZE$layout
static final long	SIZE$nextInChain

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUComputePipelineDescriptor	allocate(Arena arena)
static WGPUComputePipelineDescriptor.Ptr	allocate(Arena arena, long count)
static WGPUComputePipelineDescriptor	clone(Arena arena, WGPUComputePipelineDescriptor src)
@NotNull WGPUProgrammableStageDescriptor	compute()
WGPUComputePipelineDescriptor	compute(@NotNull WGPUProgrammableStageDescriptor value)
WGPUComputePipelineDescriptor	compute(Consumer<@NotNull WGPUProgrammableStageDescriptor> consumer)
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 WGPUStringView	label()
WGPUComputePipelineDescriptor	label(@NotNull WGPUStringView value)
WGPUComputePipelineDescriptor	label(Consumer<@NotNull WGPUStringView> consumer)
@Nullable WGPUPipelineLayout	layout()
WGPUComputePipelineDescriptor	layout(@Nullable WGPUPipelineLayout value)
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUComputePipelineDescriptor	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$label

public static final MemoryLayout.PathElement PATH$label

PATH$layout

public static final MemoryLayout.PathElement PATH$layout

PATH$compute

public static final MemoryLayout.PathElement PATH$compute

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$label

public static final StructLayout LAYOUT$label

LAYOUT$layout

public static final AddressLayout LAYOUT$layout

LAYOUT$compute

public static final StructLayout LAYOUT$compute

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$label

public static final long SIZE$label

SIZE$layout

public static final long SIZE$layout

SIZE$compute

public static final long SIZE$compute

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$label

public static final long OFFSET$label

OFFSET$layout

public static final long OFFSET$layout

OFFSET$compute

public static final long OFFSET$compute

Constructor Details

WGPUComputePipelineDescriptor

public WGPUComputePipelineDescriptor(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUComputePipelineDescriptor record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUComputePipelineDescriptor allocate(Arena arena)

allocate

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

clone

public static WGPUComputePipelineDescriptor clone(Arena arena,
 WGPUComputePipelineDescriptor src)

nextInChain

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

label

@NotNull
public @NotNull WGPUStringView label()

label

public WGPUComputePipelineDescriptor label(@NotNull
 @NotNull WGPUStringView value)

label

public WGPUComputePipelineDescriptor label(Consumer<@NotNull WGPUStringView> consumer)

layout

@Nullable
public @Nullable WGPUPipelineLayout layout()

layout

public WGPUComputePipelineDescriptor layout(@Nullable
 @Nullable WGPUPipelineLayout value)

compute

@NotNull
public @NotNull WGPUProgrammableStageDescriptor compute()

compute

public WGPUComputePipelineDescriptor compute(@NotNull
 @NotNull WGPUProgrammableStageDescriptor value)

compute

public WGPUComputePipelineDescriptor compute(Consumer<@NotNull WGPUProgrammableStageDescriptor> 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