Record Class WGPUFragmentState

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUFragmentState

All Implemented Interfaces:

IPointer, IWGPUFragmentState

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUFragmentState(@NotNull MemorySegment segment)
extends Record
implements IWGPUFragmentState

Represents a pointer to a WGPUFragmentState structure in native memory.

Structure

typedef struct WGPUFragmentState {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUShaderModule module;
    WGPUStringView entryPoint;
    size_t constantCount;
    WGPUConstantEntry const* constants;
    size_t targetCount;
    WGPUColorTargetState const* targets;
} WGPUFragmentState;

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	WGPUFragmentState.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$constants
static final StructLayout	LAYOUT$entryPoint
static final AddressLayout	LAYOUT$module
static final AddressLayout	LAYOUT$nextInChain
static final AddressLayout	LAYOUT$targets
static final long	OFFSET$constantCount
static final long	OFFSET$constants
static final long	OFFSET$entryPoint
static final long	OFFSET$module
static final long	OFFSET$nextInChain
static final long	OFFSET$targetCount
static final long	OFFSET$targets
static final MemoryLayout.PathElement	PATH$constantCount
static final MemoryLayout.PathElement	PATH$constants
static final MemoryLayout.PathElement	PATH$entryPoint
static final MemoryLayout.PathElement	PATH$module
static final MemoryLayout.PathElement	PATH$nextInChain
static final MemoryLayout.PathElement	PATH$targetCount
static final MemoryLayout.PathElement	PATH$targets
static final long	SIZE$constantCount
static final long	SIZE$constants
static final long	SIZE$entryPoint
static final long	SIZE$module
static final long	SIZE$nextInChain
static final long	SIZE$targetCount
static final long	SIZE$targets

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUFragmentState	allocate(Arena arena)
static WGPUFragmentState.Ptr	allocate(Arena arena, long count)
static WGPUFragmentState	clone(Arena arena, WGPUFragmentState src)
long	constantCount()
WGPUFragmentState	constantCount(long value)
@Nullable WGPUConstantEntry	constants()
WGPUConstantEntry.Ptr	constants(int assumedCount)
WGPUFragmentState	constants(@Nullable IWGPUConstantEntry value)
@NotNull MemorySegment	constantsRaw()
void	constantsRaw(@NotNull MemorySegment value)
@NotNull WGPUStringView	entryPoint()
WGPUFragmentState	entryPoint(@NotNull WGPUStringView value)
WGPUFragmentState	entryPoint(Consumer<@NotNull WGPUStringView> consumer)
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.
@Nullable WGPUShaderModule	module()
WGPUFragmentState	module(@Nullable WGPUShaderModule value)
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUFragmentState	nextInChain(@Nullable IWGPUChainedStruct value)
@NotNull MemorySegment	nextInChainRaw()
void	nextInChainRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	targetCount()
WGPUFragmentState	targetCount(long value)
@Nullable WGPUColorTargetState	targets()
WGPUColorTargetState.Ptr	targets(int assumedCount)
WGPUFragmentState	targets(@Nullable IWGPUColorTargetState value)
@NotNull MemorySegment	targetsRaw()
void	targetsRaw(@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$nextInChain

public static final MemoryLayout.PathElement PATH$nextInChain

PATH$module

public static final MemoryLayout.PathElement PATH$module

PATH$entryPoint

public static final MemoryLayout.PathElement PATH$entryPoint

PATH$constantCount

public static final MemoryLayout.PathElement PATH$constantCount

PATH$constants

public static final MemoryLayout.PathElement PATH$constants

PATH$targetCount

public static final MemoryLayout.PathElement PATH$targetCount

PATH$targets

public static final MemoryLayout.PathElement PATH$targets

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$module

public static final AddressLayout LAYOUT$module

LAYOUT$entryPoint

public static final StructLayout LAYOUT$entryPoint

LAYOUT$constants

public static final AddressLayout LAYOUT$constants

LAYOUT$targets

public static final AddressLayout LAYOUT$targets

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$module

public static final long SIZE$module

SIZE$entryPoint

public static final long SIZE$entryPoint

SIZE$constantCount

public static final long SIZE$constantCount

SIZE$constants

public static final long SIZE$constants

SIZE$targetCount

public static final long SIZE$targetCount

SIZE$targets

public static final long SIZE$targets

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$module

public static final long OFFSET$module

OFFSET$entryPoint

public static final long OFFSET$entryPoint

OFFSET$constantCount

public static final long OFFSET$constantCount

OFFSET$constants

public static final long OFFSET$constants

OFFSET$targetCount

public static final long OFFSET$targetCount

OFFSET$targets

public static final long OFFSET$targets

Constructor Details

WGPUFragmentState

public WGPUFragmentState(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUFragmentState record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUFragmentState allocate(Arena arena)

allocate

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

clone

public static WGPUFragmentState clone(Arena arena,
 WGPUFragmentState src)

nextInChain

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

module

@Nullable
public @Nullable WGPUShaderModule module()

module

public WGPUFragmentState module(@Nullable
 @Nullable WGPUShaderModule value)

entryPoint

@NotNull
public @NotNull WGPUStringView entryPoint()

entryPoint

public WGPUFragmentState entryPoint(@NotNull
 @NotNull WGPUStringView value)

entryPoint

public WGPUFragmentState entryPoint(Consumer<@NotNull WGPUStringView> consumer)

constantCount

@Unsigned
public long constantCount()

constantCount

public WGPUFragmentState constantCount(@Unsigned
 long value)

constants

public WGPUFragmentState constants(@Nullable
 @Nullable IWGPUConstantEntry value)

constants

@Unsafe
@Nullable
public WGPUConstantEntry.Ptr constants(int assumedCount)

constants

@Nullable
public @Nullable WGPUConstantEntry constants()

constantsRaw

@Pointer(target=WGPUConstantEntry.class)
@NotNull
public @NotNull MemorySegment constantsRaw()

constantsRaw

public void constantsRaw(@Pointer(target=WGPUConstantEntry.class) @NotNull
 @NotNull MemorySegment value)

targetCount

@Unsigned
public long targetCount()

targetCount

public WGPUFragmentState targetCount(@Unsigned
 long value)

targets

public WGPUFragmentState targets(@Nullable
 @Nullable IWGPUColorTargetState value)

targets

@Unsafe
@Nullable
public WGPUColorTargetState.Ptr targets(int assumedCount)

targets

@Nullable
public @Nullable WGPUColorTargetState targets()

targetsRaw

@Pointer(target=WGPUColorTargetState.class)
@NotNull
public @NotNull MemorySegment targetsRaw()

targetsRaw

public void targetsRaw(@Pointer(target=WGPUColorTargetState.class) @NotNull
 @NotNull MemorySegment 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