Record Class WGPUBufferDescriptor

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUBufferDescriptor

All Implemented Interfaces:

IPointer, IWGPUBufferDescriptor

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUBufferDescriptor(@NotNull MemorySegment segment)
extends Record
implements IWGPUBufferDescriptor

Represents a pointer to a WGPUBufferDescriptor structure in native memory.

Structure

typedef struct WGPUBufferDescriptor {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUStringView label;
    WGPUBufferUsage usage;
    uint64_t size;
    WGPUBool mappedAtCreation;
} WGPUBufferDescriptor;

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	WGPUBufferDescriptor.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 ValueLayout.OfInt	LAYOUT$mappedAtCreation
static final AddressLayout	LAYOUT$nextInChain
static final ValueLayout.OfLong	LAYOUT$size
static final ValueLayout.OfLong	LAYOUT$usage
static final long	OFFSET$label
static final long	OFFSET$mappedAtCreation
static final long	OFFSET$nextInChain
static final long	OFFSET$size
static final long	OFFSET$usage
static final MemoryLayout.PathElement	PATH$label
static final MemoryLayout.PathElement	PATH$mappedAtCreation
static final MemoryLayout.PathElement	PATH$nextInChain
static final MemoryLayout.PathElement	PATH$size
static final MemoryLayout.PathElement	PATH$usage
static final long	SIZE$label
static final long	SIZE$mappedAtCreation
static final long	SIZE$nextInChain
static final long	SIZE$size
static final long	SIZE$usage

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUBufferDescriptor	allocate(Arena arena)
static WGPUBufferDescriptor.Ptr	allocate(Arena arena, long count)
static WGPUBufferDescriptor	clone(Arena arena, WGPUBufferDescriptor 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()
WGPUBufferDescriptor	label(@NotNull WGPUStringView value)
WGPUBufferDescriptor	label(Consumer<@NotNull WGPUStringView> consumer)
int	mappedAtCreation()
WGPUBufferDescriptor	mappedAtCreation(int value)
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUBufferDescriptor	nextInChain(@Nullable IWGPUChainedStruct value)
@NotNull MemorySegment	nextInChainRaw()
void	nextInChainRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
WGPUBufferDescriptor	size(long value)
final String	toString()	Returns a string representation of this record class.
long	usage()
WGPUBufferDescriptor	usage(long value)

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

public static final MemoryLayout.PathElement PATH$usage

PATH$size

public static final MemoryLayout.PathElement PATH$size

PATH$mappedAtCreation

public static final MemoryLayout.PathElement PATH$mappedAtCreation

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$label

public static final StructLayout LAYOUT$label

LAYOUT$usage

public static final ValueLayout.OfLong LAYOUT$usage

LAYOUT$size

public static final ValueLayout.OfLong LAYOUT$size

LAYOUT$mappedAtCreation

public static final ValueLayout.OfInt LAYOUT$mappedAtCreation

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$label

public static final long SIZE$label

SIZE$usage

public static final long SIZE$usage

SIZE$size

public static final long SIZE$size

SIZE$mappedAtCreation

public static final long SIZE$mappedAtCreation

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$label

public static final long OFFSET$label

OFFSET$usage

public static final long OFFSET$usage

OFFSET$size

public static final long OFFSET$size

OFFSET$mappedAtCreation

public static final long OFFSET$mappedAtCreation

Constructor Details

WGPUBufferDescriptor

public WGPUBufferDescriptor(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUBufferDescriptor record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUBufferDescriptor allocate(Arena arena)

allocate

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

clone

public static WGPUBufferDescriptor clone(Arena arena,
 WGPUBufferDescriptor src)

nextInChain

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

label

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

usage

@Bitmask(WGPUBufferUsage.class)
public long usage()

usage

public WGPUBufferDescriptor usage(@Bitmask(WGPUBufferUsage.class)
 long value)

size

@Unsigned
public long size()

size

public WGPUBufferDescriptor size(@Unsigned
 long value)

mappedAtCreation

@NativeType("WGPUBool")
@Unsigned
public int mappedAtCreation()

mappedAtCreation

public WGPUBufferDescriptor mappedAtCreation(@NativeType("WGPUBool") @Unsigned
 int 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