Record Class WGPUVertexBufferLayout

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUVertexBufferLayout

All Implemented Interfaces:

IPointer, IWGPUVertexBufferLayout

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUVertexBufferLayout(@NotNull MemorySegment segment)
extends Record
implements IWGPUVertexBufferLayout

Represents a pointer to a WGPUVertexBufferLayout structure in native memory.

Structure

typedef struct WGPUVertexBufferLayout {
    WGPUVertexStepMode stepMode;
    uint64_t arrayStride;
    size_t attributeCount;
    WGPUVertexAttribute const* attributes;
} WGPUVertexBufferLayout;

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	WGPUVertexBufferLayout.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 ValueLayout.OfLong	LAYOUT$arrayStride
static final AddressLayout	LAYOUT$attributes
static final ValueLayout.OfInt	LAYOUT$stepMode
static final long	OFFSET$arrayStride
static final long	OFFSET$attributeCount
static final long	OFFSET$attributes
static final long	OFFSET$stepMode
static final MemoryLayout.PathElement	PATH$arrayStride
static final MemoryLayout.PathElement	PATH$attributeCount
static final MemoryLayout.PathElement	PATH$attributes
static final MemoryLayout.PathElement	PATH$stepMode
static final long	SIZE$arrayStride
static final long	SIZE$attributeCount
static final long	SIZE$attributes
static final long	SIZE$stepMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUVertexBufferLayout	allocate(Arena arena)
static WGPUVertexBufferLayout.Ptr	allocate(Arena arena, long count)
long	arrayStride()
WGPUVertexBufferLayout	arrayStride(long value)
long	attributeCount()
WGPUVertexBufferLayout	attributeCount(long value)
@Nullable WGPUVertexAttribute	attributes()
WGPUVertexAttribute.Ptr	attributes(int assumedCount)
WGPUVertexBufferLayout	attributes(@Nullable IWGPUVertexAttribute value)
@NotNull MemorySegment	attributesRaw()
void	attributesRaw(@NotNull MemorySegment value)
static WGPUVertexBufferLayout	clone(Arena arena, WGPUVertexBufferLayout 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 MemorySegment	segment()	Returns the value of the segment record component.
int	stepMode()
WGPUVertexBufferLayout	stepMode(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$stepMode

public static final MemoryLayout.PathElement PATH$stepMode

PATH$arrayStride

public static final MemoryLayout.PathElement PATH$arrayStride

PATH$attributeCount

public static final MemoryLayout.PathElement PATH$attributeCount

PATH$attributes

public static final MemoryLayout.PathElement PATH$attributes

LAYOUT$stepMode

public static final ValueLayout.OfInt LAYOUT$stepMode

LAYOUT$arrayStride

public static final ValueLayout.OfLong LAYOUT$arrayStride

LAYOUT$attributes

public static final AddressLayout LAYOUT$attributes

SIZE$stepMode

public static final long SIZE$stepMode

SIZE$arrayStride

public static final long SIZE$arrayStride

SIZE$attributeCount

public static final long SIZE$attributeCount

SIZE$attributes

public static final long SIZE$attributes

OFFSET$stepMode

public static final long OFFSET$stepMode

OFFSET$arrayStride

public static final long OFFSET$arrayStride

OFFSET$attributeCount

public static final long OFFSET$attributeCount

OFFSET$attributes

public static final long OFFSET$attributes

Constructor Details

WGPUVertexBufferLayout

public WGPUVertexBufferLayout(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUVertexBufferLayout record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUVertexBufferLayout allocate(Arena arena)

allocate

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

clone

public static WGPUVertexBufferLayout clone(Arena arena,
 WGPUVertexBufferLayout src)

stepMode

@EnumType(WGPUVertexStepMode.class)
public int stepMode()

stepMode

public WGPUVertexBufferLayout stepMode(@EnumType(WGPUVertexStepMode.class)
 int value)

arrayStride

@Unsigned
public long arrayStride()

arrayStride

public WGPUVertexBufferLayout arrayStride(@Unsigned
 long value)

attributeCount

@Unsigned
public long attributeCount()

attributeCount

public WGPUVertexBufferLayout attributeCount(@Unsigned
 long value)

attributes

public WGPUVertexBufferLayout attributes(@Nullable
 @Nullable IWGPUVertexAttribute value)

attributes

@Unsafe
@Nullable
public WGPUVertexAttribute.Ptr attributes(int assumedCount)

attributes

@Nullable
public @Nullable WGPUVertexAttribute attributes()

attributesRaw

@Pointer(target=WGPUVertexAttribute.class)
@NotNull
public @NotNull MemorySegment attributesRaw()

attributesRaw

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