Record Class WGPUBindGroupEntry

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUBindGroupEntry

All Implemented Interfaces:

IPointer, IWGPUBindGroupEntry

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUBindGroupEntry(@NotNull MemorySegment segment)
extends Record
implements IWGPUBindGroupEntry

Represents a pointer to a WGPUBindGroupEntry structure in native memory.

Structure

typedef struct WGPUBindGroupEntry {
    WGPUChainedStruct const* nextInChain; // optional
    uint32_t binding;
    WGPUBuffer buffer; // optional
    uint64_t offset;
    uint64_t size;
    WGPUSampler sampler; // optional
    WGPUTextureView textureView; // optional
} WGPUBindGroupEntry;

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	WGPUBindGroupEntry.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$binding
static final AddressLayout	LAYOUT$buffer
static final AddressLayout	LAYOUT$nextInChain
static final ValueLayout.OfLong	LAYOUT$offset
static final AddressLayout	LAYOUT$sampler
static final ValueLayout.OfLong	LAYOUT$size
static final AddressLayout	LAYOUT$textureView
static final long	OFFSET$binding
static final long	OFFSET$buffer
static final long	OFFSET$nextInChain
static final long	OFFSET$offset
static final long	OFFSET$sampler
static final long	OFFSET$size
static final long	OFFSET$textureView
static final MemoryLayout.PathElement	PATH$binding
static final MemoryLayout.PathElement	PATH$buffer
static final MemoryLayout.PathElement	PATH$nextInChain
static final MemoryLayout.PathElement	PATH$offset
static final MemoryLayout.PathElement	PATH$sampler
static final MemoryLayout.PathElement	PATH$size
static final MemoryLayout.PathElement	PATH$textureView
static final long	SIZE$binding
static final long	SIZE$buffer
static final long	SIZE$nextInChain
static final long	SIZE$offset
static final long	SIZE$sampler
static final long	SIZE$size
static final long	SIZE$textureView

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUBindGroupEntry	allocate(Arena arena)
static WGPUBindGroupEntry.Ptr	allocate(Arena arena, long count)
int	binding()
WGPUBindGroupEntry	binding(int value)
@Nullable WGPUBuffer	buffer()
WGPUBindGroupEntry	buffer(@Nullable WGPUBuffer value)
static WGPUBindGroupEntry	clone(Arena arena, WGPUBindGroupEntry 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.
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUBindGroupEntry	nextInChain(@Nullable IWGPUChainedStruct value)
@NotNull MemorySegment	nextInChainRaw()
void	nextInChainRaw(@NotNull MemorySegment value)
long	offset()
WGPUBindGroupEntry	offset(long value)
@Nullable WGPUSampler	sampler()
WGPUBindGroupEntry	sampler(@Nullable WGPUSampler value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
WGPUBindGroupEntry	size(long value)
@Nullable WGPUTextureView	textureView()
WGPUBindGroupEntry	textureView(@Nullable WGPUTextureView value)
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$binding

public static final MemoryLayout.PathElement PATH$binding

PATH$buffer

public static final MemoryLayout.PathElement PATH$buffer

PATH$offset

public static final MemoryLayout.PathElement PATH$offset

PATH$size

public static final MemoryLayout.PathElement PATH$size

PATH$sampler

public static final MemoryLayout.PathElement PATH$sampler

PATH$textureView

public static final MemoryLayout.PathElement PATH$textureView

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$binding

public static final ValueLayout.OfInt LAYOUT$binding

LAYOUT$buffer

public static final AddressLayout LAYOUT$buffer

LAYOUT$offset

public static final ValueLayout.OfLong LAYOUT$offset

LAYOUT$size

public static final ValueLayout.OfLong LAYOUT$size

LAYOUT$sampler

public static final AddressLayout LAYOUT$sampler

LAYOUT$textureView

public static final AddressLayout LAYOUT$textureView

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$binding

public static final long SIZE$binding

SIZE$buffer

public static final long SIZE$buffer

SIZE$offset

public static final long SIZE$offset

SIZE$size

public static final long SIZE$size

SIZE$sampler

public static final long SIZE$sampler

SIZE$textureView

public static final long SIZE$textureView

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$binding

public static final long OFFSET$binding

OFFSET$buffer

public static final long OFFSET$buffer

OFFSET$offset

public static final long OFFSET$offset

OFFSET$size

public static final long OFFSET$size

OFFSET$sampler

public static final long OFFSET$sampler

OFFSET$textureView

public static final long OFFSET$textureView

Constructor Details

WGPUBindGroupEntry

public WGPUBindGroupEntry(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUBindGroupEntry record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUBindGroupEntry allocate(Arena arena)

allocate

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

clone

public static WGPUBindGroupEntry clone(Arena arena,
 WGPUBindGroupEntry src)

nextInChain

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

binding

@Unsigned
public int binding()

binding

public WGPUBindGroupEntry binding(@Unsigned
 int value)

buffer

@Nullable
public @Nullable WGPUBuffer buffer()

buffer

public WGPUBindGroupEntry buffer(@Nullable
 @Nullable WGPUBuffer value)

offset

@Unsigned
public long offset()

offset

public WGPUBindGroupEntry offset(@Unsigned
 long value)

size

@Unsigned
public long size()

size

public WGPUBindGroupEntry size(@Unsigned
 long value)

sampler

@Nullable
public @Nullable WGPUSampler sampler()

sampler

public WGPUBindGroupEntry sampler(@Nullable
 @Nullable WGPUSampler value)

textureView

@Nullable
public @Nullable WGPUTextureView textureView()

textureView

public WGPUBindGroupEntry textureView(@Nullable
 @Nullable WGPUTextureView 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