Record Class WGPUTexelCopyBufferInfo

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUTexelCopyBufferInfo

All Implemented Interfaces:

IPointer, IWGPUTexelCopyBufferInfo

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUTexelCopyBufferInfo(@NotNull MemorySegment segment)
extends Record
implements IWGPUTexelCopyBufferInfo

Represents a pointer to a WGPUTexelCopyBufferInfo structure in native memory.

Structure

typedef struct WGPUTexelCopyBufferInfo {
    WGPUTexelCopyBufferLayout layout;
    WGPUBuffer buffer;
} WGPUTexelCopyBufferInfo;

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	WGPUTexelCopyBufferInfo.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$buffer
static final StructLayout	LAYOUT$layout
static final long	OFFSET$buffer
static final long	OFFSET$layout
static final MemoryLayout.PathElement	PATH$buffer
static final MemoryLayout.PathElement	PATH$layout
static final long	SIZE$buffer
static final long	SIZE$layout

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUTexelCopyBufferInfo	allocate(Arena arena)
static WGPUTexelCopyBufferInfo.Ptr	allocate(Arena arena, long count)
@Nullable WGPUBuffer	buffer()
WGPUTexelCopyBufferInfo	buffer(@Nullable WGPUBuffer value)
static WGPUTexelCopyBufferInfo	clone(Arena arena, WGPUTexelCopyBufferInfo 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 WGPUTexelCopyBufferLayout	layout()
WGPUTexelCopyBufferInfo	layout(@NotNull WGPUTexelCopyBufferLayout value)
WGPUTexelCopyBufferInfo	layout(Consumer<@NotNull WGPUTexelCopyBufferLayout> consumer)
@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$layout

public static final MemoryLayout.PathElement PATH$layout

PATH$buffer

public static final MemoryLayout.PathElement PATH$buffer

LAYOUT$layout

public static final StructLayout LAYOUT$layout

LAYOUT$buffer

public static final AddressLayout LAYOUT$buffer

SIZE$layout

public static final long SIZE$layout

SIZE$buffer

public static final long SIZE$buffer

OFFSET$layout

public static final long OFFSET$layout

OFFSET$buffer

public static final long OFFSET$buffer

Constructor Details

WGPUTexelCopyBufferInfo

public WGPUTexelCopyBufferInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUTexelCopyBufferInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUTexelCopyBufferInfo allocate(Arena arena)

allocate

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

clone

public static WGPUTexelCopyBufferInfo clone(Arena arena,
 WGPUTexelCopyBufferInfo src)

layout

@NotNull
public @NotNull WGPUTexelCopyBufferLayout layout()

layout

public WGPUTexelCopyBufferInfo layout(@NotNull
 @NotNull WGPUTexelCopyBufferLayout value)

layout

public WGPUTexelCopyBufferInfo layout(Consumer<@NotNull WGPUTexelCopyBufferLayout> consumer)

buffer

@Nullable
public @Nullable WGPUBuffer buffer()

buffer

public WGPUTexelCopyBufferInfo buffer(@Nullable
 @Nullable WGPUBuffer 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