Record Class WGPUShaderModuleDescriptorSpirV

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUShaderModuleDescriptorSpirV

All Implemented Interfaces:

IPointer, IWGPUShaderModuleDescriptorSpirV

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUShaderModuleDescriptorSpirV(@NotNull MemorySegment segment)
extends Record
implements IWGPUShaderModuleDescriptorSpirV

Represents a pointer to a WGPUShaderModuleDescriptorSpirV structure in native memory.

Structure

typedef struct WGPUShaderModuleDescriptorSpirV {
    WGPUStringView label;
    uint32_t sourceSize;
    uint32_t const* source;
} WGPUShaderModuleDescriptorSpirV;

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	WGPUShaderModuleDescriptorSpirV.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$label
static final AddressLayout	LAYOUT$source
static final ValueLayout.OfInt	LAYOUT$sourceSize
static final long	OFFSET$label
static final long	OFFSET$source
static final long	OFFSET$sourceSize
static final MemoryLayout.PathElement	PATH$label
static final MemoryLayout.PathElement	PATH$source
static final MemoryLayout.PathElement	PATH$sourceSize
static final long	SIZE$label
static final long	SIZE$source
static final long	SIZE$sourceSize

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUShaderModuleDescriptorSpirV	allocate(Arena arena)
static WGPUShaderModuleDescriptorSpirV.Ptr	allocate(Arena arena, long count)
static WGPUShaderModuleDescriptorSpirV	clone(Arena arena, WGPUShaderModuleDescriptorSpirV src)
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 WGPUStringView	label()
WGPUShaderModuleDescriptorSpirV	label(@NotNull WGPUStringView value)
WGPUShaderModuleDescriptorSpirV	label(Consumer<@NotNull WGPUStringView> consumer)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable IntPtr	source()	Note: the returned IntPtr does not have correct IntPtr.size() property.
WGPUShaderModuleDescriptorSpirV	source(@Nullable IntPtr value)
@NotNull MemorySegment	sourceRaw()
void	sourceRaw(@NotNull MemorySegment value)
int	sourceSize()
WGPUShaderModuleDescriptorSpirV	sourceSize(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$label

public static final MemoryLayout.PathElement PATH$label

PATH$sourceSize

public static final MemoryLayout.PathElement PATH$sourceSize

PATH$source

public static final MemoryLayout.PathElement PATH$source

LAYOUT$label

public static final StructLayout LAYOUT$label

LAYOUT$sourceSize

public static final ValueLayout.OfInt LAYOUT$sourceSize

LAYOUT$source

public static final AddressLayout LAYOUT$source

SIZE$label

public static final long SIZE$label

SIZE$sourceSize

public static final long SIZE$sourceSize

SIZE$source

public static final long SIZE$source

OFFSET$label

public static final long OFFSET$label

OFFSET$sourceSize

public static final long OFFSET$sourceSize

OFFSET$source

public static final long OFFSET$source

Constructor Details

WGPUShaderModuleDescriptorSpirV

public WGPUShaderModuleDescriptorSpirV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUShaderModuleDescriptorSpirV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUShaderModuleDescriptorSpirV allocate(Arena arena)

allocate

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

clone

public static WGPUShaderModuleDescriptorSpirV clone(Arena arena,
 WGPUShaderModuleDescriptorSpirV src)

label

@NotNull
public @NotNull WGPUStringView label()

label

public WGPUShaderModuleDescriptorSpirV label(@NotNull
 @NotNull WGPUStringView value)

label

public WGPUShaderModuleDescriptorSpirV label(Consumer<@NotNull WGPUStringView> consumer)

sourceSize

@Unsigned
public int sourceSize()

sourceSize

public WGPUShaderModuleDescriptorSpirV sourceSize(@Unsigned
 int value)

source

@Nullable
@Unsigned
public @Nullable IntPtr source()

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.

source

public WGPUShaderModuleDescriptorSpirV source(@Nullable @Unsigned
 @Nullable IntPtr value)

sourceRaw

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

sourceRaw

public void sourceRaw(@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