Record Class WGPUBindGroupLayoutEntry

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUBindGroupLayoutEntry

All Implemented Interfaces:

IPointer, IWGPUBindGroupLayoutEntry

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUBindGroupLayoutEntry(@NotNull MemorySegment segment)
extends Record
implements IWGPUBindGroupLayoutEntry

Represents a pointer to a WGPUBindGroupLayoutEntry structure in native memory.

Structure

typedef struct WGPUBindGroupLayoutEntry {
    WGPUChainedStruct const* nextInChain; // optional
    uint32_t binding;
    WGPUShaderStage visibility;
    WGPUBufferBindingLayout buffer;
    WGPUSamplerBindingLayout sampler;
    WGPUTextureBindingLayout texture;
    WGPUStorageTextureBindingLayout storageTexture;
} WGPUBindGroupLayoutEntry;

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	WGPUBindGroupLayoutEntry.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 StructLayout	LAYOUT$buffer
static final AddressLayout	LAYOUT$nextInChain
static final StructLayout	LAYOUT$sampler
static final StructLayout	LAYOUT$storageTexture
static final StructLayout	LAYOUT$texture
static final ValueLayout.OfLong	LAYOUT$visibility
static final long	OFFSET$binding
static final long	OFFSET$buffer
static final long	OFFSET$nextInChain
static final long	OFFSET$sampler
static final long	OFFSET$storageTexture
static final long	OFFSET$texture
static final long	OFFSET$visibility
static final MemoryLayout.PathElement	PATH$binding
static final MemoryLayout.PathElement	PATH$buffer
static final MemoryLayout.PathElement	PATH$nextInChain
static final MemoryLayout.PathElement	PATH$sampler
static final MemoryLayout.PathElement	PATH$storageTexture
static final MemoryLayout.PathElement	PATH$texture
static final MemoryLayout.PathElement	PATH$visibility
static final long	SIZE$binding
static final long	SIZE$buffer
static final long	SIZE$nextInChain
static final long	SIZE$sampler
static final long	SIZE$storageTexture
static final long	SIZE$texture
static final long	SIZE$visibility

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUBindGroupLayoutEntry	allocate(Arena arena)
static WGPUBindGroupLayoutEntry.Ptr	allocate(Arena arena, long count)
int	binding()
WGPUBindGroupLayoutEntry	binding(int value)
@NotNull WGPUBufferBindingLayout	buffer()
WGPUBindGroupLayoutEntry	buffer(@NotNull WGPUBufferBindingLayout value)
WGPUBindGroupLayoutEntry	buffer(Consumer<@NotNull WGPUBufferBindingLayout> consumer)
static WGPUBindGroupLayoutEntry	clone(Arena arena, WGPUBindGroupLayoutEntry 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)
WGPUBindGroupLayoutEntry	nextInChain(@Nullable IWGPUChainedStruct value)
@NotNull MemorySegment	nextInChainRaw()
void	nextInChainRaw(@NotNull MemorySegment value)
@NotNull WGPUSamplerBindingLayout	sampler()
WGPUBindGroupLayoutEntry	sampler(@NotNull WGPUSamplerBindingLayout value)
WGPUBindGroupLayoutEntry	sampler(Consumer<@NotNull WGPUSamplerBindingLayout> consumer)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@NotNull WGPUStorageTextureBindingLayout	storageTexture()
WGPUBindGroupLayoutEntry	storageTexture(@NotNull WGPUStorageTextureBindingLayout value)
WGPUBindGroupLayoutEntry	storageTexture(Consumer<@NotNull WGPUStorageTextureBindingLayout> consumer)
@NotNull WGPUTextureBindingLayout	texture()
WGPUBindGroupLayoutEntry	texture(@NotNull WGPUTextureBindingLayout value)
WGPUBindGroupLayoutEntry	texture(Consumer<@NotNull WGPUTextureBindingLayout> consumer)
final String	toString()	Returns a string representation of this record class.
long	visibility()
WGPUBindGroupLayoutEntry	visibility(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$binding

public static final MemoryLayout.PathElement PATH$binding

PATH$visibility

public static final MemoryLayout.PathElement PATH$visibility

PATH$buffer

public static final MemoryLayout.PathElement PATH$buffer

PATH$sampler

public static final MemoryLayout.PathElement PATH$sampler

PATH$texture

public static final MemoryLayout.PathElement PATH$texture

PATH$storageTexture

public static final MemoryLayout.PathElement PATH$storageTexture

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$binding

public static final ValueLayout.OfInt LAYOUT$binding

LAYOUT$visibility

public static final ValueLayout.OfLong LAYOUT$visibility

LAYOUT$buffer

public static final StructLayout LAYOUT$buffer

LAYOUT$sampler

public static final StructLayout LAYOUT$sampler

LAYOUT$texture

public static final StructLayout LAYOUT$texture

LAYOUT$storageTexture

public static final StructLayout LAYOUT$storageTexture

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$binding

public static final long SIZE$binding

SIZE$visibility

public static final long SIZE$visibility

SIZE$buffer

public static final long SIZE$buffer

SIZE$sampler

public static final long SIZE$sampler

SIZE$texture

public static final long SIZE$texture

SIZE$storageTexture

public static final long SIZE$storageTexture

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$binding

public static final long OFFSET$binding

OFFSET$visibility

public static final long OFFSET$visibility

OFFSET$buffer

public static final long OFFSET$buffer

OFFSET$sampler

public static final long OFFSET$sampler

OFFSET$texture

public static final long OFFSET$texture

OFFSET$storageTexture

public static final long OFFSET$storageTexture

Constructor Details

WGPUBindGroupLayoutEntry

public WGPUBindGroupLayoutEntry(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUBindGroupLayoutEntry record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUBindGroupLayoutEntry allocate(Arena arena)

allocate

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

clone

public static WGPUBindGroupLayoutEntry clone(Arena arena,
 WGPUBindGroupLayoutEntry src)

nextInChain

public WGPUBindGroupLayoutEntry 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 WGPUBindGroupLayoutEntry binding(@Unsigned
 int value)

visibility

@Bitmask(WGPUShaderStage.class)
public long visibility()

visibility

public WGPUBindGroupLayoutEntry visibility(@Bitmask(WGPUShaderStage.class)
 long value)

buffer

@NotNull
public @NotNull WGPUBufferBindingLayout buffer()

buffer

public WGPUBindGroupLayoutEntry buffer(@NotNull
 @NotNull WGPUBufferBindingLayout value)

buffer

public WGPUBindGroupLayoutEntry buffer(Consumer<@NotNull WGPUBufferBindingLayout> consumer)

sampler

@NotNull
public @NotNull WGPUSamplerBindingLayout sampler()

sampler

public WGPUBindGroupLayoutEntry sampler(@NotNull
 @NotNull WGPUSamplerBindingLayout value)

sampler

public WGPUBindGroupLayoutEntry sampler(Consumer<@NotNull WGPUSamplerBindingLayout> consumer)

texture

@NotNull
public @NotNull WGPUTextureBindingLayout texture()

texture

public WGPUBindGroupLayoutEntry texture(@NotNull
 @NotNull WGPUTextureBindingLayout value)

texture

public WGPUBindGroupLayoutEntry texture(Consumer<@NotNull WGPUTextureBindingLayout> consumer)

storageTexture

@NotNull
public @NotNull WGPUStorageTextureBindingLayout storageTexture()

storageTexture

public WGPUBindGroupLayoutEntry storageTexture(@NotNull
 @NotNull WGPUStorageTextureBindingLayout value)

storageTexture

public WGPUBindGroupLayoutEntry storageTexture(Consumer<@NotNull WGPUStorageTextureBindingLayout> 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