Record Class WGPUPipelineLayoutDescriptor

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUPipelineLayoutDescriptor

All Implemented Interfaces:

IPointer, IWGPUPipelineLayoutDescriptor

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUPipelineLayoutDescriptor(@NotNull MemorySegment segment)
extends Record
implements IWGPUPipelineLayoutDescriptor

Represents a pointer to a WGPUPipelineLayoutDescriptor structure in native memory.

Structure

typedef struct WGPUPipelineLayoutDescriptor {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUStringView label;
    size_t bindGroupLayoutCount;
    WGPUBindGroupLayout const* bindGroupLayouts;
} WGPUPipelineLayoutDescriptor;

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	WGPUPipelineLayoutDescriptor.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$bindGroupLayouts
static final StructLayout	LAYOUT$label
static final AddressLayout	LAYOUT$nextInChain
static final long	OFFSET$bindGroupLayoutCount
static final long	OFFSET$bindGroupLayouts
static final long	OFFSET$label
static final long	OFFSET$nextInChain
static final MemoryLayout.PathElement	PATH$bindGroupLayoutCount
static final MemoryLayout.PathElement	PATH$bindGroupLayouts
static final MemoryLayout.PathElement	PATH$label
static final MemoryLayout.PathElement	PATH$nextInChain
static final long	SIZE$bindGroupLayoutCount
static final long	SIZE$bindGroupLayouts
static final long	SIZE$label
static final long	SIZE$nextInChain

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUPipelineLayoutDescriptor	allocate(Arena arena)
static WGPUPipelineLayoutDescriptor.Ptr	allocate(Arena arena, long count)
long	bindGroupLayoutCount()
WGPUPipelineLayoutDescriptor	bindGroupLayoutCount(long value)
WGPUBindGroupLayout.Ptr	bindGroupLayouts()	Note: the returned WGPUBindGroupLayout.Ptr does not have correct WGPUBindGroupLayout.Ptr.size() property.
WGPUPipelineLayoutDescriptor	bindGroupLayouts(WGPUBindGroupLayout.Ptr value)
@NotNull MemorySegment	bindGroupLayoutsRaw()
void	bindGroupLayoutsRaw(@NotNull MemorySegment value)
static WGPUPipelineLayoutDescriptor	clone(Arena arena, WGPUPipelineLayoutDescriptor 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 WGPUStringView	label()
WGPUPipelineLayoutDescriptor	label(@NotNull WGPUStringView value)
WGPUPipelineLayoutDescriptor	label(Consumer<@NotNull WGPUStringView> consumer)
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUPipelineLayoutDescriptor	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$bindGroupLayoutCount

public static final MemoryLayout.PathElement PATH$bindGroupLayoutCount

PATH$bindGroupLayouts

public static final MemoryLayout.PathElement PATH$bindGroupLayouts

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$label

public static final StructLayout LAYOUT$label

LAYOUT$bindGroupLayouts

public static final AddressLayout LAYOUT$bindGroupLayouts

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$label

public static final long SIZE$label

SIZE$bindGroupLayoutCount

public static final long SIZE$bindGroupLayoutCount

SIZE$bindGroupLayouts

public static final long SIZE$bindGroupLayouts

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$label

public static final long OFFSET$label

OFFSET$bindGroupLayoutCount

public static final long OFFSET$bindGroupLayoutCount

OFFSET$bindGroupLayouts

public static final long OFFSET$bindGroupLayouts

Constructor Details

WGPUPipelineLayoutDescriptor

public WGPUPipelineLayoutDescriptor(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUPipelineLayoutDescriptor record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUPipelineLayoutDescriptor allocate(Arena arena)

allocate

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

clone

public static WGPUPipelineLayoutDescriptor clone(Arena arena,
 WGPUPipelineLayoutDescriptor src)

nextInChain

public WGPUPipelineLayoutDescriptor 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 WGPUPipelineLayoutDescriptor label(@NotNull
 @NotNull WGPUStringView value)

label

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

bindGroupLayoutCount

@Unsigned
public long bindGroupLayoutCount()

bindGroupLayoutCount

public WGPUPipelineLayoutDescriptor bindGroupLayoutCount(@Unsigned
 long value)

bindGroupLayouts

@Nullable
public WGPUBindGroupLayout.Ptr bindGroupLayouts()

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

bindGroupLayouts

public WGPUPipelineLayoutDescriptor bindGroupLayouts(@Nullable
 WGPUBindGroupLayout.Ptr value)

bindGroupLayoutsRaw

@Pointer(target=WGPUBindGroupLayout.class)
@NotNull
public @NotNull MemorySegment bindGroupLayoutsRaw()

bindGroupLayoutsRaw

public void bindGroupLayoutsRaw(@Pointer(target=WGPUBindGroupLayout.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