Record Class WGPUVertexState

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUVertexState

All Implemented Interfaces:

IPointer, IWGPUVertexState

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUVertexState(@NotNull MemorySegment segment)
extends Record
implements IWGPUVertexState

Represents a pointer to a WGPUVertexState structure in native memory.

Structure

typedef struct WGPUVertexState {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUShaderModule module;
    WGPUStringView entryPoint;
    size_t constantCount;
    WGPUConstantEntry const* constants;
    size_t bufferCount;
    WGPUVertexBufferLayout const* buffers;
} WGPUVertexState;

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	WGPUVertexState.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$buffers
static final AddressLayout	LAYOUT$constants
static final StructLayout	LAYOUT$entryPoint
static final AddressLayout	LAYOUT$module
static final AddressLayout	LAYOUT$nextInChain
static final long	OFFSET$bufferCount
static final long	OFFSET$buffers
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 MemoryLayout.PathElement	PATH$bufferCount
static final MemoryLayout.PathElement	PATH$buffers
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 long	SIZE$bufferCount
static final long	SIZE$buffers
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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUVertexState	allocate(Arena arena)
static WGPUVertexState.Ptr	allocate(Arena arena, long count)
long	bufferCount()
WGPUVertexState	bufferCount(long value)
@Nullable WGPUVertexBufferLayout	buffers()
WGPUVertexBufferLayout.Ptr	buffers(int assumedCount)
WGPUVertexState	buffers(@Nullable IWGPUVertexBufferLayout value)
@NotNull MemorySegment	buffersRaw()
void	buffersRaw(@NotNull MemorySegment value)
static WGPUVertexState	clone(Arena arena, WGPUVertexState src)
long	constantCount()
WGPUVertexState	constantCount(long value)
@Nullable WGPUConstantEntry	constants()
WGPUConstantEntry.Ptr	constants(int assumedCount)
WGPUVertexState	constants(@Nullable IWGPUConstantEntry value)
@NotNull MemorySegment	constantsRaw()
void	constantsRaw(@NotNull MemorySegment value)
@NotNull WGPUStringView	entryPoint()
WGPUVertexState	entryPoint(@NotNull WGPUStringView value)
WGPUVertexState	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()
WGPUVertexState	module(@Nullable WGPUShaderModule value)
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUVertexState	nextInChain(@Nullable IWGPUChainedStruct value)
@NotNull MemorySegment	nextInChainRaw()
void	nextInChainRaw(@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$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$bufferCount

public static final MemoryLayout.PathElement PATH$bufferCount

PATH$buffers

public static final MemoryLayout.PathElement PATH$buffers

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

public static final AddressLayout LAYOUT$buffers

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

public static final long SIZE$bufferCount

SIZE$buffers

public static final long SIZE$buffers

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

public static final long OFFSET$bufferCount

OFFSET$buffers

public static final long OFFSET$buffers

Constructor Details

WGPUVertexState

public WGPUVertexState(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUVertexState record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUVertexState allocate(Arena arena)

allocate

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

clone

public static WGPUVertexState clone(Arena arena,
 WGPUVertexState src)

nextInChain

public WGPUVertexState 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 WGPUVertexState module(@Nullable
 @Nullable WGPUShaderModule value)

entryPoint

@NotNull
public @NotNull WGPUStringView entryPoint()

entryPoint

public WGPUVertexState entryPoint(@NotNull
 @NotNull WGPUStringView value)

entryPoint

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

constantCount

@Unsigned
public long constantCount()

constantCount

public WGPUVertexState constantCount(@Unsigned
 long value)

constants

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

bufferCount

@Unsigned
public long bufferCount()

bufferCount

public WGPUVertexState bufferCount(@Unsigned
 long value)

buffers

public WGPUVertexState buffers(@Nullable
 @Nullable IWGPUVertexBufferLayout value)

buffers

@Unsafe
@Nullable
public WGPUVertexBufferLayout.Ptr buffers(int assumedCount)

buffers

@Nullable
public @Nullable WGPUVertexBufferLayout buffers()

buffersRaw

@Pointer(target=WGPUVertexBufferLayout.class)
@NotNull
public @NotNull MemorySegment buffersRaw()

buffersRaw

public void buffersRaw(@Pointer(target=WGPUVertexBufferLayout.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