Record Class WGPUCommandBufferDescriptor

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUCommandBufferDescriptor

All Implemented Interfaces:

IPointer, IWGPUCommandBufferDescriptor

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUCommandBufferDescriptor(@NotNull MemorySegment segment)
extends Record
implements IWGPUCommandBufferDescriptor

Represents a pointer to a WGPUCommandBufferDescriptor structure in native memory.

Structure

typedef struct WGPUCommandBufferDescriptor {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUStringView label;
} WGPUCommandBufferDescriptor;

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

Constructor Summary

Constructors

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

Method Summary

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

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$label

public static final StructLayout LAYOUT$label

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$label

public static final long SIZE$label

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$label

public static final long OFFSET$label

Constructor Details

WGPUCommandBufferDescriptor

public WGPUCommandBufferDescriptor(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUCommandBufferDescriptor record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUCommandBufferDescriptor allocate(Arena arena)

allocate

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

clone

public static WGPUCommandBufferDescriptor clone(Arena arena,
 WGPUCommandBufferDescriptor src)

nextInChain

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

label

public WGPUCommandBufferDescriptor label(Consumer<@NotNull WGPUStringView> 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