Record Class WGPUShaderSourceSpirv

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUShaderSourceSpirv

All Implemented Interfaces:

IPointer, IWGPUShaderSourceSpirv

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUShaderSourceSpirv(@NotNull MemorySegment segment)
extends Record
implements IWGPUShaderSourceSpirv

Represents a pointer to a WGPUShaderSourceSpirv structure in native memory.

Structure

typedef struct WGPUShaderSourceSpirv {
    WGPUChainedStruct chain;
    uint32_t codeSize;
    uint32_t const* code;
} WGPUShaderSourceSpirv;

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	WGPUShaderSourceSpirv.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 StructLayout	LAYOUT$chain
static final AddressLayout	LAYOUT$code
static final ValueLayout.OfInt	LAYOUT$codeSize
static final long	OFFSET$chain
static final long	OFFSET$code
static final long	OFFSET$codeSize
static final MemoryLayout.PathElement	PATH$chain
static final MemoryLayout.PathElement	PATH$code
static final MemoryLayout.PathElement	PATH$codeSize
static final long	SIZE$chain
static final long	SIZE$code
static final long	SIZE$codeSize

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUShaderSourceSpirv	allocate(Arena arena)
static WGPUShaderSourceSpirv.Ptr	allocate(Arena arena, long count)
@NotNull WGPUChainedStruct	chain()
WGPUShaderSourceSpirv	chain(@NotNull WGPUChainedStruct value)
WGPUShaderSourceSpirv	chain(Consumer<@NotNull WGPUChainedStruct> consumer)
static WGPUShaderSourceSpirv	clone(Arena arena, WGPUShaderSourceSpirv src)
@Nullable IntPtr	code()	Note: the returned IntPtr does not have correct IntPtr.size() property.
WGPUShaderSourceSpirv	code(@Nullable IntPtr value)
@NotNull MemorySegment	codeRaw()
void	codeRaw(@NotNull MemorySegment value)
int	codeSize()
WGPUShaderSourceSpirv	codeSize(int value)
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.
@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$chain

public static final MemoryLayout.PathElement PATH$chain

PATH$codeSize

public static final MemoryLayout.PathElement PATH$codeSize

PATH$code

public static final MemoryLayout.PathElement PATH$code

LAYOUT$chain

public static final StructLayout LAYOUT$chain

LAYOUT$codeSize

public static final ValueLayout.OfInt LAYOUT$codeSize

LAYOUT$code

public static final AddressLayout LAYOUT$code

SIZE$chain

public static final long SIZE$chain

SIZE$codeSize

public static final long SIZE$codeSize

SIZE$code

public static final long SIZE$code

OFFSET$chain

public static final long OFFSET$chain

OFFSET$codeSize

public static final long OFFSET$codeSize

OFFSET$code

public static final long OFFSET$code

Constructor Details

WGPUShaderSourceSpirv

public WGPUShaderSourceSpirv(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUShaderSourceSpirv record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUShaderSourceSpirv allocate(Arena arena)

allocate

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

clone

public static WGPUShaderSourceSpirv clone(Arena arena,
 WGPUShaderSourceSpirv src)

chain

@NotNull
public @NotNull WGPUChainedStruct chain()

chain

public WGPUShaderSourceSpirv chain(@NotNull
 @NotNull WGPUChainedStruct value)

chain

public WGPUShaderSourceSpirv chain(Consumer<@NotNull WGPUChainedStruct> consumer)

codeSize

@Unsigned
public int codeSize()

codeSize

public WGPUShaderSourceSpirv codeSize(@Unsigned
 int value)

code

@Nullable
@Unsigned
public @Nullable IntPtr code()

Note: the returned IntPtr does not have correct IntPtr.size() property. It's up to user to track the size of the buffer, and use IntPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

code

public WGPUShaderSourceSpirv code(@Nullable @Unsigned
 @Nullable IntPtr value)

codeRaw

@Pointer(comment="uint32_t*")
@NotNull
public @NotNull MemorySegment codeRaw()

codeRaw

public void codeRaw(@Pointer(comment="uint32_t*") @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