Record Class WGPUStencilFaceState

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUStencilFaceState

All Implemented Interfaces:

IPointer, IWGPUStencilFaceState

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUStencilFaceState(@NotNull MemorySegment segment)
extends Record
implements IWGPUStencilFaceState

Represents a pointer to a WGPUStencilFaceState structure in native memory.

Structure

typedef struct WGPUStencilFaceState {
    WGPUCompareFunction compare;
    WGPUStencilOperation failOp;
    WGPUStencilOperation depthFailOp;
    WGPUStencilOperation passOp;
} WGPUStencilFaceState;

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	WGPUStencilFaceState.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$compare
static final ValueLayout.OfInt	LAYOUT$depthFailOp
static final ValueLayout.OfInt	LAYOUT$failOp
static final ValueLayout.OfInt	LAYOUT$passOp
static final long	OFFSET$compare
static final long	OFFSET$depthFailOp
static final long	OFFSET$failOp
static final long	OFFSET$passOp
static final MemoryLayout.PathElement	PATH$compare
static final MemoryLayout.PathElement	PATH$depthFailOp
static final MemoryLayout.PathElement	PATH$failOp
static final MemoryLayout.PathElement	PATH$passOp
static final long	SIZE$compare
static final long	SIZE$depthFailOp
static final long	SIZE$failOp
static final long	SIZE$passOp

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUStencilFaceState	allocate(Arena arena)
static WGPUStencilFaceState.Ptr	allocate(Arena arena, long count)
static WGPUStencilFaceState	clone(Arena arena, WGPUStencilFaceState src)
int	compare()
WGPUStencilFaceState	compare(int value)
int	depthFailOp()
WGPUStencilFaceState	depthFailOp(int value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	failOp()
WGPUStencilFaceState	failOp(int value)
final int	hashCode()	Returns a hash code value for this object.
int	passOp()
WGPUStencilFaceState	passOp(int 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$compare

public static final MemoryLayout.PathElement PATH$compare

PATH$failOp

public static final MemoryLayout.PathElement PATH$failOp

PATH$depthFailOp

public static final MemoryLayout.PathElement PATH$depthFailOp

PATH$passOp

public static final MemoryLayout.PathElement PATH$passOp

LAYOUT$compare

public static final ValueLayout.OfInt LAYOUT$compare

LAYOUT$failOp

public static final ValueLayout.OfInt LAYOUT$failOp

LAYOUT$depthFailOp

public static final ValueLayout.OfInt LAYOUT$depthFailOp

LAYOUT$passOp

public static final ValueLayout.OfInt LAYOUT$passOp

SIZE$compare

public static final long SIZE$compare

SIZE$failOp

public static final long SIZE$failOp

SIZE$depthFailOp

public static final long SIZE$depthFailOp

SIZE$passOp

public static final long SIZE$passOp

OFFSET$compare

public static final long OFFSET$compare

OFFSET$failOp

public static final long OFFSET$failOp

OFFSET$depthFailOp

public static final long OFFSET$depthFailOp

OFFSET$passOp

public static final long OFFSET$passOp

Constructor Details

WGPUStencilFaceState

public WGPUStencilFaceState(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUStencilFaceState record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUStencilFaceState allocate(Arena arena)

allocate

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

clone

public static WGPUStencilFaceState clone(Arena arena,
 WGPUStencilFaceState src)

compare

@EnumType(WGPUCompareFunction.class)
public int compare()

compare

public WGPUStencilFaceState compare(@EnumType(WGPUCompareFunction.class)
 int value)

failOp

@EnumType(WGPUStencilOperation.class)
public int failOp()

failOp

public WGPUStencilFaceState failOp(@EnumType(WGPUStencilOperation.class)
 int value)

depthFailOp

@EnumType(WGPUStencilOperation.class)
public int depthFailOp()

depthFailOp

public WGPUStencilFaceState depthFailOp(@EnumType(WGPUStencilOperation.class)
 int value)

passOp

@EnumType(WGPUStencilOperation.class)
public int passOp()

passOp

public WGPUStencilFaceState passOp(@EnumType(WGPUStencilOperation.class)
 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