Record Class WGPUBindGroupDescriptor

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUBindGroupDescriptor

All Implemented Interfaces:

IPointer, IWGPUBindGroupDescriptor

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUBindGroupDescriptor(@NotNull MemorySegment segment)
extends Record
implements IWGPUBindGroupDescriptor

Represents a pointer to a WGPUBindGroupDescriptor structure in native memory.

Structure

typedef struct WGPUBindGroupDescriptor {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUStringView label;
    WGPUBindGroupLayout layout;
    size_t entryCount;
    WGPUBindGroupEntry const* entries;
} WGPUBindGroupDescriptor;

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUBindGroupDescriptor	allocate(Arena arena)
static WGPUBindGroupDescriptor.Ptr	allocate(Arena arena, long count)
static WGPUBindGroupDescriptor	clone(Arena arena, WGPUBindGroupDescriptor src)
@Nullable WGPUBindGroupEntry	entries()
WGPUBindGroupEntry.Ptr	entries(int assumedCount)
WGPUBindGroupDescriptor	entries(@Nullable IWGPUBindGroupEntry value)
@NotNull MemorySegment	entriesRaw()
void	entriesRaw(@NotNull MemorySegment value)
long	entryCount()
WGPUBindGroupDescriptor	entryCount(long 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 WGPUStringView	label()
WGPUBindGroupDescriptor	label(@NotNull WGPUStringView value)
WGPUBindGroupDescriptor	label(Consumer<@NotNull WGPUStringView> consumer)
@Nullable WGPUBindGroupLayout	layout()
WGPUBindGroupDescriptor	layout(@Nullable WGPUBindGroupLayout value)
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUBindGroupDescriptor	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$entryCount

public static final MemoryLayout.PathElement PATH$entryCount

PATH$entries

public static final MemoryLayout.PathElement PATH$entries

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$entries

public static final AddressLayout LAYOUT$entries

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$entryCount

public static final long SIZE$entryCount

SIZE$entries

public static final long SIZE$entries

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$entryCount

public static final long OFFSET$entryCount

OFFSET$entries

public static final long OFFSET$entries

Constructor Details

WGPUBindGroupDescriptor

public WGPUBindGroupDescriptor(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUBindGroupDescriptor record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUBindGroupDescriptor allocate(Arena arena)

allocate

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

clone

public static WGPUBindGroupDescriptor clone(Arena arena,
 WGPUBindGroupDescriptor src)

nextInChain

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

label

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

layout

@Nullable
public @Nullable WGPUBindGroupLayout layout()

layout

public WGPUBindGroupDescriptor layout(@Nullable
 @Nullable WGPUBindGroupLayout value)

entryCount

@Unsigned
public long entryCount()

entryCount

public WGPUBindGroupDescriptor entryCount(@Unsigned
 long value)

entries

public WGPUBindGroupDescriptor entries(@Nullable
 @Nullable IWGPUBindGroupEntry value)

entries

@Unsafe
@Nullable
public WGPUBindGroupEntry.Ptr entries(int assumedCount)

entries

@Nullable
public @Nullable WGPUBindGroupEntry entries()

entriesRaw

@Pointer(target=WGPUBindGroupEntry.class)
@NotNull
public @NotNull MemorySegment entriesRaw()

entriesRaw

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