Record Class WGPUBindGroupEntryExtras

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUBindGroupEntryExtras

All Implemented Interfaces:

IPointer, IWGPUBindGroupEntryExtras

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUBindGroupEntryExtras(@NotNull MemorySegment segment)
extends Record
implements IWGPUBindGroupEntryExtras

Represents a pointer to a WGPUBindGroupEntryExtras structure in native memory.

Structure

typedef struct WGPUBindGroupEntryExtras {
    WGPUChainedStruct chain;
    WGPUBuffer const* buffers;
    size_t bufferCount;
    WGPUSampler const* samplers;
    size_t samplerCount;
    WGPUTextureView const* textureViews;
    size_t textureViewCount;
} WGPUBindGroupEntryExtras;

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	WGPUBindGroupEntryExtras.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 AddressLayout	LAYOUT$buffers
static final StructLayout	LAYOUT$chain
static final AddressLayout	LAYOUT$samplers
static final AddressLayout	LAYOUT$textureViews
static final long	OFFSET$bufferCount
static final long	OFFSET$buffers
static final long	OFFSET$chain
static final long	OFFSET$samplerCount
static final long	OFFSET$samplers
static final long	OFFSET$textureViewCount
static final long	OFFSET$textureViews
static final MemoryLayout.PathElement	PATH$bufferCount
static final MemoryLayout.PathElement	PATH$buffers
static final MemoryLayout.PathElement	PATH$chain
static final MemoryLayout.PathElement	PATH$samplerCount
static final MemoryLayout.PathElement	PATH$samplers
static final MemoryLayout.PathElement	PATH$textureViewCount
static final MemoryLayout.PathElement	PATH$textureViews
static final long	SIZE$bufferCount
static final long	SIZE$buffers
static final long	SIZE$chain
static final long	SIZE$samplerCount
static final long	SIZE$samplers
static final long	SIZE$textureViewCount
static final long	SIZE$textureViews

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUBindGroupEntryExtras	allocate(Arena arena)
static WGPUBindGroupEntryExtras.Ptr	allocate(Arena arena, long count)
long	bufferCount()
WGPUBindGroupEntryExtras	bufferCount(long value)
WGPUBuffer.Ptr	buffers()	Note: the returned WGPUBuffer.Ptr does not have correct WGPUBuffer.Ptr.size() property.
WGPUBindGroupEntryExtras	buffers(WGPUBuffer.Ptr value)
@NotNull MemorySegment	buffersRaw()
void	buffersRaw(@NotNull MemorySegment value)
@NotNull WGPUChainedStruct	chain()
WGPUBindGroupEntryExtras	chain(@NotNull WGPUChainedStruct value)
WGPUBindGroupEntryExtras	chain(Consumer<@NotNull WGPUChainedStruct> consumer)
static WGPUBindGroupEntryExtras	clone(Arena arena, WGPUBindGroupEntryExtras 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.
long	samplerCount()
WGPUBindGroupEntryExtras	samplerCount(long value)
WGPUSampler.Ptr	samplers()	Note: the returned WGPUSampler.Ptr does not have correct WGPUSampler.Ptr.size() property.
WGPUBindGroupEntryExtras	samplers(WGPUSampler.Ptr value)
@NotNull MemorySegment	samplersRaw()
void	samplersRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	textureViewCount()
WGPUBindGroupEntryExtras	textureViewCount(long value)
WGPUTextureView.Ptr	textureViews()	Note: the returned WGPUTextureView.Ptr does not have correct WGPUTextureView.Ptr.size() property.
WGPUBindGroupEntryExtras	textureViews(WGPUTextureView.Ptr value)
@NotNull MemorySegment	textureViewsRaw()
void	textureViewsRaw(@NotNull MemorySegment 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$chain

public static final MemoryLayout.PathElement PATH$chain

PATH$buffers

public static final MemoryLayout.PathElement PATH$buffers

PATH$bufferCount

public static final MemoryLayout.PathElement PATH$bufferCount

PATH$samplers

public static final MemoryLayout.PathElement PATH$samplers

PATH$samplerCount

public static final MemoryLayout.PathElement PATH$samplerCount

PATH$textureViews

public static final MemoryLayout.PathElement PATH$textureViews

PATH$textureViewCount

public static final MemoryLayout.PathElement PATH$textureViewCount

LAYOUT$chain

public static final StructLayout LAYOUT$chain

LAYOUT$buffers

public static final AddressLayout LAYOUT$buffers

LAYOUT$samplers

public static final AddressLayout LAYOUT$samplers

LAYOUT$textureViews

public static final AddressLayout LAYOUT$textureViews

SIZE$chain

public static final long SIZE$chain

SIZE$buffers

public static final long SIZE$buffers

SIZE$bufferCount

public static final long SIZE$bufferCount

SIZE$samplers

public static final long SIZE$samplers

SIZE$samplerCount

public static final long SIZE$samplerCount

SIZE$textureViews

public static final long SIZE$textureViews

SIZE$textureViewCount

public static final long SIZE$textureViewCount

OFFSET$chain

public static final long OFFSET$chain

OFFSET$buffers

public static final long OFFSET$buffers

OFFSET$bufferCount

public static final long OFFSET$bufferCount

OFFSET$samplers

public static final long OFFSET$samplers

OFFSET$samplerCount

public static final long OFFSET$samplerCount

OFFSET$textureViews

public static final long OFFSET$textureViews

OFFSET$textureViewCount

public static final long OFFSET$textureViewCount

Constructor Details

WGPUBindGroupEntryExtras

public WGPUBindGroupEntryExtras(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUBindGroupEntryExtras record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUBindGroupEntryExtras allocate(Arena arena)

allocate

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

clone

public static WGPUBindGroupEntryExtras clone(Arena arena,
 WGPUBindGroupEntryExtras src)

chain

@NotNull
public @NotNull WGPUChainedStruct chain()

chain

public WGPUBindGroupEntryExtras chain(@NotNull
 @NotNull WGPUChainedStruct value)

chain

public WGPUBindGroupEntryExtras chain(Consumer<@NotNull WGPUChainedStruct> consumer)

buffers

@Nullable
public WGPUBuffer.Ptr buffers()

Note: the returned WGPUBuffer.Ptr does not have correct WGPUBuffer.Ptr.size() property. It's up to user to track the size of the buffer, and use WGPUBuffer.Ptr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

buffers

public WGPUBindGroupEntryExtras buffers(@Nullable
 WGPUBuffer.Ptr value)

buffersRaw

@Pointer(target=WGPUBuffer.class)
@NotNull
public @NotNull MemorySegment buffersRaw()

buffersRaw

public void buffersRaw(@Pointer(target=WGPUBuffer.class) @NotNull
 @NotNull MemorySegment value)

bufferCount

@Unsigned
public long bufferCount()

bufferCount

public WGPUBindGroupEntryExtras bufferCount(@Unsigned
 long value)

samplers

@Nullable
public WGPUSampler.Ptr samplers()

Note: the returned WGPUSampler.Ptr does not have correct WGPUSampler.Ptr.size() property. It's up to user to track the size of the buffer, and use WGPUSampler.Ptr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

samplers

public WGPUBindGroupEntryExtras samplers(@Nullable
 WGPUSampler.Ptr value)

samplersRaw

@Pointer(target=WGPUSampler.class)
@NotNull
public @NotNull MemorySegment samplersRaw()

samplersRaw

public void samplersRaw(@Pointer(target=WGPUSampler.class) @NotNull
 @NotNull MemorySegment value)

samplerCount

@Unsigned
public long samplerCount()

samplerCount

public WGPUBindGroupEntryExtras samplerCount(@Unsigned
 long value)

textureViews

@Nullable
public WGPUTextureView.Ptr textureViews()

Note: the returned WGPUTextureView.Ptr does not have correct WGPUTextureView.Ptr.size() property. It's up to user to track the size of the buffer, and use WGPUTextureView.Ptr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

textureViews

public WGPUBindGroupEntryExtras textureViews(@Nullable
 WGPUTextureView.Ptr value)

textureViewsRaw

@Pointer(target=WGPUTextureView.class)
@NotNull
public @NotNull MemorySegment textureViewsRaw()

textureViewsRaw

public void textureViewsRaw(@Pointer(target=WGPUTextureView.class) @NotNull
 @NotNull MemorySegment value)

textureViewCount

@Unsigned
public long textureViewCount()

textureViewCount

public WGPUBindGroupEntryExtras textureViewCount(@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