Record Class WGPUQuerySetDescriptorExtras

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUQuerySetDescriptorExtras

All Implemented Interfaces:

IPointer, IWGPUQuerySetDescriptorExtras

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUQuerySetDescriptorExtras(@NotNull MemorySegment segment)
extends Record
implements IWGPUQuerySetDescriptorExtras

Represents a pointer to a WGPUQuerySetDescriptorExtras structure in native memory.

Structure

typedef struct WGPUQuerySetDescriptorExtras {
    WGPUChainedStruct chain;
    WGPUPipelineStatisticName const* pipelineStatistics;
    size_t pipelineStatisticCount;
} WGPUQuerySetDescriptorExtras;

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	WGPUQuerySetDescriptorExtras.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$chain
static final AddressLayout	LAYOUT$pipelineStatistics
static final long	OFFSET$chain
static final long	OFFSET$pipelineStatisticCount
static final long	OFFSET$pipelineStatistics
static final MemoryLayout.PathElement	PATH$chain
static final MemoryLayout.PathElement	PATH$pipelineStatisticCount
static final MemoryLayout.PathElement	PATH$pipelineStatistics
static final long	SIZE$chain
static final long	SIZE$pipelineStatisticCount
static final long	SIZE$pipelineStatistics

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUQuerySetDescriptorExtras	allocate(Arena arena)
static WGPUQuerySetDescriptorExtras.Ptr	allocate(Arena arena, long count)
@NotNull WGPUChainedStruct	chain()
WGPUQuerySetDescriptorExtras	chain(@NotNull WGPUChainedStruct value)
WGPUQuerySetDescriptorExtras	chain(Consumer<@NotNull WGPUChainedStruct> consumer)
static WGPUQuerySetDescriptorExtras	clone(Arena arena, WGPUQuerySetDescriptorExtras 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	pipelineStatisticCount()
WGPUQuerySetDescriptorExtras	pipelineStatisticCount(long value)
@Nullable IntPtr	pipelineStatistics()	Note: the returned IntPtr does not have correct IntPtr.size() property.
WGPUQuerySetDescriptorExtras	pipelineStatistics(@Nullable IntPtr value)
@NotNull MemorySegment	pipelineStatisticsRaw()
void	pipelineStatisticsRaw(@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.

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

public static final MemoryLayout.PathElement PATH$pipelineStatistics

PATH$pipelineStatisticCount

public static final MemoryLayout.PathElement PATH$pipelineStatisticCount

LAYOUT$chain

public static final StructLayout LAYOUT$chain

LAYOUT$pipelineStatistics

public static final AddressLayout LAYOUT$pipelineStatistics

SIZE$chain

public static final long SIZE$chain

SIZE$pipelineStatistics

public static final long SIZE$pipelineStatistics

SIZE$pipelineStatisticCount

public static final long SIZE$pipelineStatisticCount

OFFSET$chain

public static final long OFFSET$chain

OFFSET$pipelineStatistics

public static final long OFFSET$pipelineStatistics

OFFSET$pipelineStatisticCount

public static final long OFFSET$pipelineStatisticCount

Constructor Details

WGPUQuerySetDescriptorExtras

public WGPUQuerySetDescriptorExtras(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUQuerySetDescriptorExtras record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUQuerySetDescriptorExtras allocate(Arena arena)

allocate

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

clone

public static WGPUQuerySetDescriptorExtras clone(Arena arena,
 WGPUQuerySetDescriptorExtras src)

chain

@NotNull
public @NotNull WGPUChainedStruct chain()

chain

public WGPUQuerySetDescriptorExtras chain(@NotNull
 @NotNull WGPUChainedStruct value)

chain

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

pipelineStatistics

@Nullable
@EnumType(WGPUPipelineStatisticName.class)
public @Nullable IntPtr pipelineStatistics()

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

pipelineStatistics

public WGPUQuerySetDescriptorExtras pipelineStatistics(@Nullable @EnumType(WGPUPipelineStatisticName.class)
 @Nullable IntPtr value)

pipelineStatisticsRaw

@Pointer(target=WGPUPipelineStatisticName.class)
@NotNull
public @NotNull MemorySegment pipelineStatisticsRaw()

pipelineStatisticsRaw

public void pipelineStatisticsRaw(@Pointer(target=WGPUPipelineStatisticName.class) @NotNull
 @NotNull MemorySegment value)

pipelineStatisticCount

@Unsigned
public long pipelineStatisticCount()

pipelineStatisticCount

public WGPUQuerySetDescriptorExtras pipelineStatisticCount(@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