Record Class WGPUShaderSourceGLSL

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUShaderSourceGLSL

All Implemented Interfaces:

IPointer, IWGPUShaderSourceGLSL

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUShaderSourceGLSL(@NotNull MemorySegment segment)
extends Record
implements IWGPUShaderSourceGLSL

Represents a pointer to a WGPUShaderSourceGLSL structure in native memory.

Structure

typedef struct WGPUShaderSourceGLSL {
    WGPUChainedStruct chain;
    WGPUShaderStage stage;
    WGPUStringView code;
    uint32_t defineCount;
    WGPUShaderDefine* defines;
} WGPUShaderSourceGLSL;

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	WGPUShaderSourceGLSL.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 StructLayout	LAYOUT$code
static final ValueLayout.OfInt	LAYOUT$defineCount
static final AddressLayout	LAYOUT$defines
static final ValueLayout.OfLong	LAYOUT$stage
static final long	OFFSET$chain
static final long	OFFSET$code
static final long	OFFSET$defineCount
static final long	OFFSET$defines
static final long	OFFSET$stage
static final MemoryLayout.PathElement	PATH$chain
static final MemoryLayout.PathElement	PATH$code
static final MemoryLayout.PathElement	PATH$defineCount
static final MemoryLayout.PathElement	PATH$defines
static final MemoryLayout.PathElement	PATH$stage
static final long	SIZE$chain
static final long	SIZE$code
static final long	SIZE$defineCount
static final long	SIZE$defines
static final long	SIZE$stage

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUShaderSourceGLSL	allocate(Arena arena)
static WGPUShaderSourceGLSL.Ptr	allocate(Arena arena, long count)
@NotNull WGPUChainedStruct	chain()
WGPUShaderSourceGLSL	chain(@NotNull WGPUChainedStruct value)
WGPUShaderSourceGLSL	chain(Consumer<@NotNull WGPUChainedStruct> consumer)
static WGPUShaderSourceGLSL	clone(Arena arena, WGPUShaderSourceGLSL src)
@NotNull WGPUStringView	code()
WGPUShaderSourceGLSL	code(@NotNull WGPUStringView value)
WGPUShaderSourceGLSL	code(Consumer<@NotNull WGPUStringView> consumer)
int	defineCount()
WGPUShaderSourceGLSL	defineCount(int value)
@Nullable WGPUShaderDefine	defines()
WGPUShaderDefine.Ptr	defines(int assumedCount)
WGPUShaderSourceGLSL	defines(@Nullable IWGPUShaderDefine value)
@NotNull MemorySegment	definesRaw()
void	definesRaw(@NotNull MemorySegment 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.
long	stage()
WGPUShaderSourceGLSL	stage(long 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$chain

public static final MemoryLayout.PathElement PATH$chain

PATH$stage

public static final MemoryLayout.PathElement PATH$stage

PATH$code

public static final MemoryLayout.PathElement PATH$code

PATH$defineCount

public static final MemoryLayout.PathElement PATH$defineCount

PATH$defines

public static final MemoryLayout.PathElement PATH$defines

LAYOUT$chain

public static final StructLayout LAYOUT$chain

LAYOUT$stage

public static final ValueLayout.OfLong LAYOUT$stage

LAYOUT$code

public static final StructLayout LAYOUT$code

LAYOUT$defineCount

public static final ValueLayout.OfInt LAYOUT$defineCount

LAYOUT$defines

public static final AddressLayout LAYOUT$defines

SIZE$chain

public static final long SIZE$chain

SIZE$stage

public static final long SIZE$stage

SIZE$code

public static final long SIZE$code

SIZE$defineCount

public static final long SIZE$defineCount

SIZE$defines

public static final long SIZE$defines

OFFSET$chain

public static final long OFFSET$chain

OFFSET$stage

public static final long OFFSET$stage

OFFSET$code

public static final long OFFSET$code

OFFSET$defineCount

public static final long OFFSET$defineCount

OFFSET$defines

public static final long OFFSET$defines

Constructor Details

WGPUShaderSourceGLSL

public WGPUShaderSourceGLSL(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUShaderSourceGLSL record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUShaderSourceGLSL allocate(Arena arena)

allocate

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

clone

public static WGPUShaderSourceGLSL clone(Arena arena,
 WGPUShaderSourceGLSL src)

chain

@NotNull
public @NotNull WGPUChainedStruct chain()

chain

public WGPUShaderSourceGLSL chain(@NotNull
 @NotNull WGPUChainedStruct value)

chain

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

stage

@Bitmask(WGPUShaderStage.class)
public long stage()

stage

public WGPUShaderSourceGLSL stage(@Bitmask(WGPUShaderStage.class)
 long value)

code

@NotNull
public @NotNull WGPUStringView code()

code

public WGPUShaderSourceGLSL code(@NotNull
 @NotNull WGPUStringView value)

code

public WGPUShaderSourceGLSL code(Consumer<@NotNull WGPUStringView> consumer)

defineCount

@Unsigned
public int defineCount()

defineCount

public WGPUShaderSourceGLSL defineCount(@Unsigned
 int value)

defines

public WGPUShaderSourceGLSL defines(@Nullable
 @Nullable IWGPUShaderDefine value)

defines

@Unsafe
@Nullable
public WGPUShaderDefine.Ptr defines(int assumedCount)

defines

@Nullable
public @Nullable WGPUShaderDefine defines()

definesRaw

@Pointer(target=WGPUShaderDefine.class)
@NotNull
public @NotNull MemorySegment definesRaw()

definesRaw

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