Record Class WGPUDepthStencilState

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUDepthStencilState

All Implemented Interfaces:

IPointer, IWGPUDepthStencilState

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUDepthStencilState(@NotNull MemorySegment segment)
extends Record
implements IWGPUDepthStencilState

Represents a pointer to a WGPUDepthStencilState structure in native memory.

Structure

typedef struct WGPUDepthStencilState {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUTextureFormat format;
    WGPUOptionalBool depthWriteEnabled;
    WGPUCompareFunction depthCompare;
    WGPUStencilFaceState stencilFront;
    WGPUStencilFaceState stencilBack;
    uint32_t stencilReadMask;
    uint32_t stencilWriteMask;
    int32_t depthBias;
    float depthBiasSlopeScale;
    float depthBiasClamp;
} WGPUDepthStencilState;

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	WGPUDepthStencilState.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$depthBias
static final ValueLayout.OfFloat	LAYOUT$depthBiasClamp
static final ValueLayout.OfFloat	LAYOUT$depthBiasSlopeScale
static final ValueLayout.OfInt	LAYOUT$depthCompare
static final ValueLayout.OfInt	LAYOUT$depthWriteEnabled
static final ValueLayout.OfInt	LAYOUT$format
static final AddressLayout	LAYOUT$nextInChain
static final StructLayout	LAYOUT$stencilBack
static final StructLayout	LAYOUT$stencilFront
static final ValueLayout.OfInt	LAYOUT$stencilReadMask
static final ValueLayout.OfInt	LAYOUT$stencilWriteMask
static final long	OFFSET$depthBias
static final long	OFFSET$depthBiasClamp
static final long	OFFSET$depthBiasSlopeScale
static final long	OFFSET$depthCompare
static final long	OFFSET$depthWriteEnabled
static final long	OFFSET$format
static final long	OFFSET$nextInChain
static final long	OFFSET$stencilBack
static final long	OFFSET$stencilFront
static final long	OFFSET$stencilReadMask
static final long	OFFSET$stencilWriteMask
static final MemoryLayout.PathElement	PATH$depthBias
static final MemoryLayout.PathElement	PATH$depthBiasClamp
static final MemoryLayout.PathElement	PATH$depthBiasSlopeScale
static final MemoryLayout.PathElement	PATH$depthCompare
static final MemoryLayout.PathElement	PATH$depthWriteEnabled
static final MemoryLayout.PathElement	PATH$format
static final MemoryLayout.PathElement	PATH$nextInChain
static final MemoryLayout.PathElement	PATH$stencilBack
static final MemoryLayout.PathElement	PATH$stencilFront
static final MemoryLayout.PathElement	PATH$stencilReadMask
static final MemoryLayout.PathElement	PATH$stencilWriteMask
static final long	SIZE$depthBias
static final long	SIZE$depthBiasClamp
static final long	SIZE$depthBiasSlopeScale
static final long	SIZE$depthCompare
static final long	SIZE$depthWriteEnabled
static final long	SIZE$format
static final long	SIZE$nextInChain
static final long	SIZE$stencilBack
static final long	SIZE$stencilFront
static final long	SIZE$stencilReadMask
static final long	SIZE$stencilWriteMask

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUDepthStencilState	allocate(Arena arena)
static WGPUDepthStencilState.Ptr	allocate(Arena arena, long count)
static WGPUDepthStencilState	clone(Arena arena, WGPUDepthStencilState src)
int	depthBias()
WGPUDepthStencilState	depthBias(int value)
float	depthBiasClamp()
WGPUDepthStencilState	depthBiasClamp(float value)
float	depthBiasSlopeScale()
WGPUDepthStencilState	depthBiasSlopeScale(float value)
int	depthCompare()
WGPUDepthStencilState	depthCompare(int value)
int	depthWriteEnabled()
WGPUDepthStencilState	depthWriteEnabled(int value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	format()
WGPUDepthStencilState	format(int value)
final int	hashCode()	Returns a hash code value for this object.
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUDepthStencilState	nextInChain(@Nullable IWGPUChainedStruct value)
@NotNull MemorySegment	nextInChainRaw()
void	nextInChainRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@NotNull WGPUStencilFaceState	stencilBack()
WGPUDepthStencilState	stencilBack(@NotNull WGPUStencilFaceState value)
WGPUDepthStencilState	stencilBack(Consumer<@NotNull WGPUStencilFaceState> consumer)
@NotNull WGPUStencilFaceState	stencilFront()
WGPUDepthStencilState	stencilFront(@NotNull WGPUStencilFaceState value)
WGPUDepthStencilState	stencilFront(Consumer<@NotNull WGPUStencilFaceState> consumer)
int	stencilReadMask()
WGPUDepthStencilState	stencilReadMask(int value)
int	stencilWriteMask()
WGPUDepthStencilState	stencilWriteMask(int 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$nextInChain

public static final MemoryLayout.PathElement PATH$nextInChain

PATH$format

public static final MemoryLayout.PathElement PATH$format

PATH$depthWriteEnabled

public static final MemoryLayout.PathElement PATH$depthWriteEnabled

PATH$depthCompare

public static final MemoryLayout.PathElement PATH$depthCompare

PATH$stencilFront

public static final MemoryLayout.PathElement PATH$stencilFront

PATH$stencilBack

public static final MemoryLayout.PathElement PATH$stencilBack

PATH$stencilReadMask

public static final MemoryLayout.PathElement PATH$stencilReadMask

PATH$stencilWriteMask

public static final MemoryLayout.PathElement PATH$stencilWriteMask

PATH$depthBias

public static final MemoryLayout.PathElement PATH$depthBias

PATH$depthBiasSlopeScale

public static final MemoryLayout.PathElement PATH$depthBiasSlopeScale

PATH$depthBiasClamp

public static final MemoryLayout.PathElement PATH$depthBiasClamp

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$format

public static final ValueLayout.OfInt LAYOUT$format

LAYOUT$depthWriteEnabled

public static final ValueLayout.OfInt LAYOUT$depthWriteEnabled

LAYOUT$depthCompare

public static final ValueLayout.OfInt LAYOUT$depthCompare

LAYOUT$stencilFront

public static final StructLayout LAYOUT$stencilFront

LAYOUT$stencilBack

public static final StructLayout LAYOUT$stencilBack

LAYOUT$stencilReadMask

public static final ValueLayout.OfInt LAYOUT$stencilReadMask

LAYOUT$stencilWriteMask

public static final ValueLayout.OfInt LAYOUT$stencilWriteMask

LAYOUT$depthBias

public static final ValueLayout.OfInt LAYOUT$depthBias

LAYOUT$depthBiasSlopeScale

public static final ValueLayout.OfFloat LAYOUT$depthBiasSlopeScale

LAYOUT$depthBiasClamp

public static final ValueLayout.OfFloat LAYOUT$depthBiasClamp

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$format

public static final long SIZE$format

SIZE$depthWriteEnabled

public static final long SIZE$depthWriteEnabled

SIZE$depthCompare

public static final long SIZE$depthCompare

SIZE$stencilFront

public static final long SIZE$stencilFront

SIZE$stencilBack

public static final long SIZE$stencilBack

SIZE$stencilReadMask

public static final long SIZE$stencilReadMask

SIZE$stencilWriteMask

public static final long SIZE$stencilWriteMask

SIZE$depthBias

public static final long SIZE$depthBias

SIZE$depthBiasSlopeScale

public static final long SIZE$depthBiasSlopeScale

SIZE$depthBiasClamp

public static final long SIZE$depthBiasClamp

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$format

public static final long OFFSET$format

OFFSET$depthWriteEnabled

public static final long OFFSET$depthWriteEnabled

OFFSET$depthCompare

public static final long OFFSET$depthCompare

OFFSET$stencilFront

public static final long OFFSET$stencilFront

OFFSET$stencilBack

public static final long OFFSET$stencilBack

OFFSET$stencilReadMask

public static final long OFFSET$stencilReadMask

OFFSET$stencilWriteMask

public static final long OFFSET$stencilWriteMask

OFFSET$depthBias

public static final long OFFSET$depthBias

OFFSET$depthBiasSlopeScale

public static final long OFFSET$depthBiasSlopeScale

OFFSET$depthBiasClamp

public static final long OFFSET$depthBiasClamp

Constructor Details

WGPUDepthStencilState

public WGPUDepthStencilState(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUDepthStencilState record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUDepthStencilState allocate(Arena arena)

allocate

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

clone

public static WGPUDepthStencilState clone(Arena arena,
 WGPUDepthStencilState src)

nextInChain

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

format

@EnumType(WGPUTextureFormat.class)
public int format()

format

public WGPUDepthStencilState format(@EnumType(WGPUTextureFormat.class)
 int value)

depthWriteEnabled

@EnumType(WGPUOptionalBool.class)
public int depthWriteEnabled()

depthWriteEnabled

public WGPUDepthStencilState depthWriteEnabled(@EnumType(WGPUOptionalBool.class)
 int value)

depthCompare

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

depthCompare

public WGPUDepthStencilState depthCompare(@EnumType(WGPUCompareFunction.class)
 int value)

stencilFront

@NotNull
public @NotNull WGPUStencilFaceState stencilFront()

stencilFront

public WGPUDepthStencilState stencilFront(@NotNull
 @NotNull WGPUStencilFaceState value)

stencilFront

public WGPUDepthStencilState stencilFront(Consumer<@NotNull WGPUStencilFaceState> consumer)

stencilBack

@NotNull
public @NotNull WGPUStencilFaceState stencilBack()

stencilBack

public WGPUDepthStencilState stencilBack(@NotNull
 @NotNull WGPUStencilFaceState value)

stencilBack

public WGPUDepthStencilState stencilBack(Consumer<@NotNull WGPUStencilFaceState> consumer)

stencilReadMask

@Unsigned
public int stencilReadMask()

stencilReadMask

public WGPUDepthStencilState stencilReadMask(@Unsigned
 int value)

stencilWriteMask

@Unsigned
public int stencilWriteMask()

stencilWriteMask

public WGPUDepthStencilState stencilWriteMask(@Unsigned
 int value)

depthBias

public int depthBias()

depthBias

public WGPUDepthStencilState depthBias(int value)

depthBiasSlopeScale

public float depthBiasSlopeScale()

depthBiasSlopeScale

public WGPUDepthStencilState depthBiasSlopeScale(float value)

depthBiasClamp

public float depthBiasClamp()

depthBiasClamp

public WGPUDepthStencilState depthBiasClamp(float 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