Record Class WGPUBufferMapCallbackInfo

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUBufferMapCallbackInfo

All Implemented Interfaces:

IPointer, IWGPUBufferMapCallbackInfo

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUBufferMapCallbackInfo(@NotNull MemorySegment segment)
extends Record
implements IWGPUBufferMapCallbackInfo

Represents a pointer to a WGPUBufferMapCallbackInfo structure in native memory.

Structure

typedef struct WGPUBufferMapCallbackInfo {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUCallbackMode mode;
    WGPUBufferMapCallback callback; // optional
    void* userdata1; // optional
    void* userdata2; // optional
} WGPUBufferMapCallbackInfo;

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	WGPUBufferMapCallbackInfo.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 AddressLayout	LAYOUT$callback
static final ValueLayout.OfInt	LAYOUT$mode
static final AddressLayout	LAYOUT$nextInChain
static final AddressLayout	LAYOUT$userdata1
static final AddressLayout	LAYOUT$userdata2
static final long	OFFSET$callback
static final long	OFFSET$mode
static final long	OFFSET$nextInChain
static final long	OFFSET$userdata1
static final long	OFFSET$userdata2
static final MemoryLayout.PathElement	PATH$callback
static final MemoryLayout.PathElement	PATH$mode
static final MemoryLayout.PathElement	PATH$nextInChain
static final MemoryLayout.PathElement	PATH$userdata1
static final MemoryLayout.PathElement	PATH$userdata2
static final long	SIZE$callback
static final long	SIZE$mode
static final long	SIZE$nextInChain
static final long	SIZE$userdata1
static final long	SIZE$userdata2

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUBufferMapCallbackInfo	allocate(Arena arena)
static WGPUBufferMapCallbackInfo.Ptr	allocate(Arena arena, long count)
@NotNull MemorySegment	callback()
WGPUBufferMapCallbackInfo	callback(@Nullable IPointer pointer)
WGPUBufferMapCallbackInfo	callback(@NotNull WGPUFunctionTypes.IWGPUBufferMapCallback value)
WGPUBufferMapCallbackInfo	callback(@NotNull Arena arena, @NotNull WGPUFunctionTypes.IWGPUBufferMapCallback value)
WGPUBufferMapCallbackInfo	callback(@NotNull MemorySegment value)
static WGPUBufferMapCallbackInfo	clone(Arena arena, WGPUBufferMapCallbackInfo 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.
int	mode()
WGPUBufferMapCallbackInfo	mode(int value)
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUBufferMapCallbackInfo	nextInChain(@Nullable IWGPUChainedStruct value)
@NotNull MemorySegment	nextInChainRaw()
void	nextInChainRaw(@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.
@NotNull MemorySegment	userdata1()
WGPUBufferMapCallbackInfo	userdata1(@Nullable IPointer pointer)
WGPUBufferMapCallbackInfo	userdata1(@NotNull MemorySegment value)
@NotNull MemorySegment	userdata2()
WGPUBufferMapCallbackInfo	userdata2(@Nullable IPointer pointer)
WGPUBufferMapCallbackInfo	userdata2(@NotNull MemorySegment value)

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$nextInChain

public static final MemoryLayout.PathElement PATH$nextInChain

PATH$mode

public static final MemoryLayout.PathElement PATH$mode

PATH$callback

public static final MemoryLayout.PathElement PATH$callback

PATH$userdata1

public static final MemoryLayout.PathElement PATH$userdata1

PATH$userdata2

public static final MemoryLayout.PathElement PATH$userdata2

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$mode

public static final ValueLayout.OfInt LAYOUT$mode

LAYOUT$callback

public static final AddressLayout LAYOUT$callback

LAYOUT$userdata1

public static final AddressLayout LAYOUT$userdata1

LAYOUT$userdata2

public static final AddressLayout LAYOUT$userdata2

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$mode

public static final long SIZE$mode

SIZE$callback

public static final long SIZE$callback

SIZE$userdata1

public static final long SIZE$userdata1

SIZE$userdata2

public static final long SIZE$userdata2

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$mode

public static final long OFFSET$mode

OFFSET$callback

public static final long OFFSET$callback

OFFSET$userdata1

public static final long OFFSET$userdata1

OFFSET$userdata2

public static final long OFFSET$userdata2

Constructor Details

WGPUBufferMapCallbackInfo

public WGPUBufferMapCallbackInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUBufferMapCallbackInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUBufferMapCallbackInfo allocate(Arena arena)

allocate

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

clone

public static WGPUBufferMapCallbackInfo clone(Arena arena,
 WGPUBufferMapCallbackInfo src)

nextInChain

public WGPUBufferMapCallbackInfo nextInChain(@Nullable
 @Nullable IWGPUChainedStruct value)

nextInChain

@Unsafe
@Nullable
public WGPUChainedStruct.Ptr nextInChain(int assumedCount)

nextInChain

@Nullable
public @Nullable WGPUChainedStruct nextInChain()

nextInChainRaw

@Pointer(target=WGPUChainedStruct.class)
@NotNull
public @NotNull MemorySegment nextInChainRaw()

nextInChainRaw

public void nextInChainRaw(@Pointer(target=WGPUChainedStruct.class) @NotNull
 @NotNull MemorySegment value)

mode

@EnumType(WGPUCallbackMode.class)
public int mode()

mode

public WGPUBufferMapCallbackInfo mode(@EnumType(WGPUCallbackMode.class)
 int value)

callback

@Pointer(comment="WGPUBufferMapCallback")
@NotNull
public @NotNull MemorySegment callback()

callback

public WGPUBufferMapCallbackInfo callback(@Pointer(comment="WGPUBufferMapCallback") @NotNull
 @NotNull MemorySegment value)

callback

public WGPUBufferMapCallbackInfo callback(@NotNull
 @NotNull WGPUFunctionTypes.IWGPUBufferMapCallback value)

callback

public WGPUBufferMapCallbackInfo callback(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull WGPUFunctionTypes.IWGPUBufferMapCallback value)

callback

public WGPUBufferMapCallbackInfo callback(@Nullable
 @Nullable IPointer pointer)

userdata1

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment userdata1()

userdata1

public WGPUBufferMapCallbackInfo userdata1(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

userdata1

public WGPUBufferMapCallbackInfo userdata1(@Nullable
 @Nullable IPointer pointer)

userdata2

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment userdata2()

userdata2

public WGPUBufferMapCallbackInfo userdata2(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

userdata2

public WGPUBufferMapCallbackInfo userdata2(@Nullable
 @Nullable IPointer pointer)

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