Record Class WGPUPrimitiveState

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUPrimitiveState

All Implemented Interfaces:

IPointer, IWGPUPrimitiveState

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUPrimitiveState(@NotNull MemorySegment segment)
extends Record
implements IWGPUPrimitiveState

Represents a pointer to a WGPUPrimitiveState structure in native memory.

Structure

typedef struct WGPUPrimitiveState {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUPrimitiveTopology topology;
    WGPUIndexFormat stripIndexFormat;
    WGPUFrontFace frontFace;
    WGPUCullMode cullMode;
    WGPUBool unclippedDepth;
} WGPUPrimitiveState;

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	WGPUPrimitiveState.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$cullMode
static final ValueLayout.OfInt	LAYOUT$frontFace
static final AddressLayout	LAYOUT$nextInChain
static final ValueLayout.OfInt	LAYOUT$stripIndexFormat
static final ValueLayout.OfInt	LAYOUT$topology
static final ValueLayout.OfInt	LAYOUT$unclippedDepth
static final long	OFFSET$cullMode
static final long	OFFSET$frontFace
static final long	OFFSET$nextInChain
static final long	OFFSET$stripIndexFormat
static final long	OFFSET$topology
static final long	OFFSET$unclippedDepth
static final MemoryLayout.PathElement	PATH$cullMode
static final MemoryLayout.PathElement	PATH$frontFace
static final MemoryLayout.PathElement	PATH$nextInChain
static final MemoryLayout.PathElement	PATH$stripIndexFormat
static final MemoryLayout.PathElement	PATH$topology
static final MemoryLayout.PathElement	PATH$unclippedDepth
static final long	SIZE$cullMode
static final long	SIZE$frontFace
static final long	SIZE$nextInChain
static final long	SIZE$stripIndexFormat
static final long	SIZE$topology
static final long	SIZE$unclippedDepth

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUPrimitiveState	allocate(Arena arena)
static WGPUPrimitiveState.Ptr	allocate(Arena arena, long count)
static WGPUPrimitiveState	clone(Arena arena, WGPUPrimitiveState src)
int	cullMode()
WGPUPrimitiveState	cullMode(int value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	frontFace()
WGPUPrimitiveState	frontFace(int value)
final int	hashCode()	Returns a hash code value for this object.
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUPrimitiveState	nextInChain(@Nullable IWGPUChainedStruct value)
@NotNull MemorySegment	nextInChainRaw()
void	nextInChainRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	stripIndexFormat()
WGPUPrimitiveState	stripIndexFormat(int value)
int	topology()
WGPUPrimitiveState	topology(int value)
final String	toString()	Returns a string representation of this record class.
int	unclippedDepth()
WGPUPrimitiveState	unclippedDepth(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$topology

public static final MemoryLayout.PathElement PATH$topology

PATH$stripIndexFormat

public static final MemoryLayout.PathElement PATH$stripIndexFormat

PATH$frontFace

public static final MemoryLayout.PathElement PATH$frontFace

PATH$cullMode

public static final MemoryLayout.PathElement PATH$cullMode

PATH$unclippedDepth

public static final MemoryLayout.PathElement PATH$unclippedDepth

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$topology

public static final ValueLayout.OfInt LAYOUT$topology

LAYOUT$stripIndexFormat

public static final ValueLayout.OfInt LAYOUT$stripIndexFormat

LAYOUT$frontFace

public static final ValueLayout.OfInt LAYOUT$frontFace

LAYOUT$cullMode

public static final ValueLayout.OfInt LAYOUT$cullMode

LAYOUT$unclippedDepth

public static final ValueLayout.OfInt LAYOUT$unclippedDepth

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$topology

public static final long SIZE$topology

SIZE$stripIndexFormat

public static final long SIZE$stripIndexFormat

SIZE$frontFace

public static final long SIZE$frontFace

SIZE$cullMode

public static final long SIZE$cullMode

SIZE$unclippedDepth

public static final long SIZE$unclippedDepth

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$topology

public static final long OFFSET$topology

OFFSET$stripIndexFormat

public static final long OFFSET$stripIndexFormat

OFFSET$frontFace

public static final long OFFSET$frontFace

OFFSET$cullMode

public static final long OFFSET$cullMode

OFFSET$unclippedDepth

public static final long OFFSET$unclippedDepth

Constructor Details

WGPUPrimitiveState

public WGPUPrimitiveState(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUPrimitiveState record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUPrimitiveState allocate(Arena arena)

allocate

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

clone

public static WGPUPrimitiveState clone(Arena arena,
 WGPUPrimitiveState src)

nextInChain

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

topology

@EnumType(WGPUPrimitiveTopology.class)
public int topology()

topology

public WGPUPrimitiveState topology(@EnumType(WGPUPrimitiveTopology.class)
 int value)

stripIndexFormat

@EnumType(WGPUIndexFormat.class)
public int stripIndexFormat()

stripIndexFormat

public WGPUPrimitiveState stripIndexFormat(@EnumType(WGPUIndexFormat.class)
 int value)

frontFace

@EnumType(WGPUFrontFace.class)
public int frontFace()

frontFace

public WGPUPrimitiveState frontFace(@EnumType(WGPUFrontFace.class)
 int value)

cullMode

@EnumType(WGPUCullMode.class)
public int cullMode()

cullMode

public WGPUPrimitiveState cullMode(@EnumType(WGPUCullMode.class)
 int value)

unclippedDepth

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

unclippedDepth

public WGPUPrimitiveState unclippedDepth(@NativeType("WGPUBool") @Unsigned
 int 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