Record Class WGPUBufferBindingLayout

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUBufferBindingLayout

All Implemented Interfaces:

IPointer, IWGPUBufferBindingLayout

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUBufferBindingLayout(@NotNull MemorySegment segment)
extends Record
implements IWGPUBufferBindingLayout

Represents a pointer to a WGPUBufferBindingLayout structure in native memory.

Structure

typedef struct WGPUBufferBindingLayout {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUBufferBindingType type;
    WGPUBool hasDynamicOffset;
    uint64_t minBindingSize;
} WGPUBufferBindingLayout;

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	WGPUBufferBindingLayout.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 ValueLayout.OfInt	LAYOUT$hasDynamicOffset
static final ValueLayout.OfLong	LAYOUT$minBindingSize
static final AddressLayout	LAYOUT$nextInChain
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$hasDynamicOffset
static final long	OFFSET$minBindingSize
static final long	OFFSET$nextInChain
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$hasDynamicOffset
static final MemoryLayout.PathElement	PATH$minBindingSize
static final MemoryLayout.PathElement	PATH$nextInChain
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$hasDynamicOffset
static final long	SIZE$minBindingSize
static final long	SIZE$nextInChain
static final long	SIZE$type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUBufferBindingLayout	allocate(Arena arena)
static WGPUBufferBindingLayout.Ptr	allocate(Arena arena, long count)
static WGPUBufferBindingLayout	clone(Arena arena, WGPUBufferBindingLayout src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	hasDynamicOffset()
WGPUBufferBindingLayout	hasDynamicOffset(int value)
final int	hashCode()	Returns a hash code value for this object.
long	minBindingSize()
WGPUBufferBindingLayout	minBindingSize(long value)
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUBufferBindingLayout	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.
int	type()
WGPUBufferBindingLayout	type(int 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$type

public static final MemoryLayout.PathElement PATH$type

PATH$hasDynamicOffset

public static final MemoryLayout.PathElement PATH$hasDynamicOffset

PATH$minBindingSize

public static final MemoryLayout.PathElement PATH$minBindingSize

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$hasDynamicOffset

public static final ValueLayout.OfInt LAYOUT$hasDynamicOffset

LAYOUT$minBindingSize

public static final ValueLayout.OfLong LAYOUT$minBindingSize

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$type

public static final long SIZE$type

SIZE$hasDynamicOffset

public static final long SIZE$hasDynamicOffset

SIZE$minBindingSize

public static final long SIZE$minBindingSize

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$type

public static final long OFFSET$type

OFFSET$hasDynamicOffset

public static final long OFFSET$hasDynamicOffset

OFFSET$minBindingSize

public static final long OFFSET$minBindingSize

Constructor Details

WGPUBufferBindingLayout

public WGPUBufferBindingLayout(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUBufferBindingLayout record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUBufferBindingLayout allocate(Arena arena)

allocate

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

clone

public static WGPUBufferBindingLayout clone(Arena arena,
 WGPUBufferBindingLayout src)

nextInChain

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

type

@EnumType(WGPUBufferBindingType.class)
public int type()

type

public WGPUBufferBindingLayout type(@EnumType(WGPUBufferBindingType.class)
 int value)

hasDynamicOffset

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

hasDynamicOffset

public WGPUBufferBindingLayout hasDynamicOffset(@NativeType("WGPUBool") @Unsigned
 int value)

minBindingSize

@Unsigned
public long minBindingSize()

minBindingSize

public WGPUBufferBindingLayout minBindingSize(@Unsigned
 long 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