Record Class WGPUPipelineLayoutExtras

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUPipelineLayoutExtras

All Implemented Interfaces:

IPointer, IWGPUPipelineLayoutExtras

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUPipelineLayoutExtras(@NotNull MemorySegment segment)
extends Record
implements IWGPUPipelineLayoutExtras

Represents a pointer to a WGPUPipelineLayoutExtras structure in native memory.

Structure

typedef struct WGPUPipelineLayoutExtras {
    WGPUChainedStruct chain;
    size_t pushConstantRangeCount;
    WGPUPushConstantRange const* pushConstantRanges;
} WGPUPipelineLayoutExtras;

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	WGPUPipelineLayoutExtras.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$pushConstantRanges
static final long	OFFSET$chain
static final long	OFFSET$pushConstantRangeCount
static final long	OFFSET$pushConstantRanges
static final MemoryLayout.PathElement	PATH$chain
static final MemoryLayout.PathElement	PATH$pushConstantRangeCount
static final MemoryLayout.PathElement	PATH$pushConstantRanges
static final long	SIZE$chain
static final long	SIZE$pushConstantRangeCount
static final long	SIZE$pushConstantRanges

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUPipelineLayoutExtras	allocate(Arena arena)
static WGPUPipelineLayoutExtras.Ptr	allocate(Arena arena, long count)
@NotNull WGPUChainedStruct	chain()
WGPUPipelineLayoutExtras	chain(@NotNull WGPUChainedStruct value)
WGPUPipelineLayoutExtras	chain(Consumer<@NotNull WGPUChainedStruct> consumer)
static WGPUPipelineLayoutExtras	clone(Arena arena, WGPUPipelineLayoutExtras 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.
long	pushConstantRangeCount()
WGPUPipelineLayoutExtras	pushConstantRangeCount(long value)
@Nullable WGPUPushConstantRange	pushConstantRanges()
WGPUPushConstantRange.Ptr	pushConstantRanges(int assumedCount)
WGPUPipelineLayoutExtras	pushConstantRanges(@Nullable IWGPUPushConstantRange value)
@NotNull MemorySegment	pushConstantRangesRaw()
void	pushConstantRangesRaw(@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$chain

public static final MemoryLayout.PathElement PATH$chain

PATH$pushConstantRangeCount

public static final MemoryLayout.PathElement PATH$pushConstantRangeCount

PATH$pushConstantRanges

public static final MemoryLayout.PathElement PATH$pushConstantRanges

LAYOUT$chain

public static final StructLayout LAYOUT$chain

LAYOUT$pushConstantRanges

public static final AddressLayout LAYOUT$pushConstantRanges

SIZE$chain

public static final long SIZE$chain

SIZE$pushConstantRangeCount

public static final long SIZE$pushConstantRangeCount

SIZE$pushConstantRanges

public static final long SIZE$pushConstantRanges

OFFSET$chain

public static final long OFFSET$chain

OFFSET$pushConstantRangeCount

public static final long OFFSET$pushConstantRangeCount

OFFSET$pushConstantRanges

public static final long OFFSET$pushConstantRanges

Constructor Details

WGPUPipelineLayoutExtras

public WGPUPipelineLayoutExtras(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUPipelineLayoutExtras record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUPipelineLayoutExtras allocate(Arena arena)

allocate

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

clone

public static WGPUPipelineLayoutExtras clone(Arena arena,
 WGPUPipelineLayoutExtras src)

chain

@NotNull
public @NotNull WGPUChainedStruct chain()

chain

public WGPUPipelineLayoutExtras chain(@NotNull
 @NotNull WGPUChainedStruct value)

chain

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

pushConstantRangeCount

@Unsigned
public long pushConstantRangeCount()

pushConstantRangeCount

public WGPUPipelineLayoutExtras pushConstantRangeCount(@Unsigned
 long value)

pushConstantRanges

public WGPUPipelineLayoutExtras pushConstantRanges(@Nullable
 @Nullable IWGPUPushConstantRange value)

pushConstantRanges

@Unsafe
@Nullable
public WGPUPushConstantRange.Ptr pushConstantRanges(int assumedCount)

pushConstantRanges

@Nullable
public @Nullable WGPUPushConstantRange pushConstantRanges()

pushConstantRangesRaw

@Pointer(target=WGPUPushConstantRange.class)
@NotNull
public @NotNull MemorySegment pushConstantRangesRaw()

pushConstantRangesRaw

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