Record Class WGPUTexelCopyTextureInfo

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUTexelCopyTextureInfo

All Implemented Interfaces:

IPointer, IWGPUTexelCopyTextureInfo

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUTexelCopyTextureInfo(@NotNull MemorySegment segment)
extends Record
implements IWGPUTexelCopyTextureInfo

Represents a pointer to a WGPUTexelCopyTextureInfo structure in native memory.

Structure

typedef struct WGPUTexelCopyTextureInfo {
    WGPUTexture texture;
    uint32_t mipLevel;
    WGPUOrigin3d origin;
    WGPUTextureAspect aspect;
} WGPUTexelCopyTextureInfo;

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	WGPUTexelCopyTextureInfo.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.OfInt	LAYOUT$aspect
static final ValueLayout.OfInt	LAYOUT$mipLevel
static final StructLayout	LAYOUT$origin
static final AddressLayout	LAYOUT$texture
static final long	OFFSET$aspect
static final long	OFFSET$mipLevel
static final long	OFFSET$origin
static final long	OFFSET$texture
static final MemoryLayout.PathElement	PATH$aspect
static final MemoryLayout.PathElement	PATH$mipLevel
static final MemoryLayout.PathElement	PATH$origin
static final MemoryLayout.PathElement	PATH$texture
static final long	SIZE$aspect
static final long	SIZE$mipLevel
static final long	SIZE$origin
static final long	SIZE$texture

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUTexelCopyTextureInfo	allocate(Arena arena)
static WGPUTexelCopyTextureInfo.Ptr	allocate(Arena arena, long count)
int	aspect()
WGPUTexelCopyTextureInfo	aspect(int value)
static WGPUTexelCopyTextureInfo	clone(Arena arena, WGPUTexelCopyTextureInfo 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	mipLevel()
WGPUTexelCopyTextureInfo	mipLevel(int value)
@NotNull WGPUOrigin3d	origin()
WGPUTexelCopyTextureInfo	origin(@NotNull WGPUOrigin3d value)
WGPUTexelCopyTextureInfo	origin(Consumer<@NotNull WGPUOrigin3d> consumer)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable WGPUTexture	texture()
WGPUTexelCopyTextureInfo	texture(@Nullable WGPUTexture 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$texture

public static final MemoryLayout.PathElement PATH$texture

PATH$mipLevel

public static final MemoryLayout.PathElement PATH$mipLevel

PATH$origin

public static final MemoryLayout.PathElement PATH$origin

PATH$aspect

public static final MemoryLayout.PathElement PATH$aspect

LAYOUT$texture

public static final AddressLayout LAYOUT$texture

LAYOUT$mipLevel

public static final ValueLayout.OfInt LAYOUT$mipLevel

LAYOUT$origin

public static final StructLayout LAYOUT$origin

LAYOUT$aspect

public static final ValueLayout.OfInt LAYOUT$aspect

SIZE$texture

public static final long SIZE$texture

SIZE$mipLevel

public static final long SIZE$mipLevel

SIZE$origin

public static final long SIZE$origin

SIZE$aspect

public static final long SIZE$aspect

OFFSET$texture

public static final long OFFSET$texture

OFFSET$mipLevel

public static final long OFFSET$mipLevel

OFFSET$origin

public static final long OFFSET$origin

OFFSET$aspect

public static final long OFFSET$aspect

Constructor Details

WGPUTexelCopyTextureInfo

public WGPUTexelCopyTextureInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUTexelCopyTextureInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUTexelCopyTextureInfo allocate(Arena arena)

allocate

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

clone

public static WGPUTexelCopyTextureInfo clone(Arena arena,
 WGPUTexelCopyTextureInfo src)

texture

@Nullable
public @Nullable WGPUTexture texture()

texture

public WGPUTexelCopyTextureInfo texture(@Nullable
 @Nullable WGPUTexture value)

mipLevel

@Unsigned
public int mipLevel()

mipLevel

public WGPUTexelCopyTextureInfo mipLevel(@Unsigned
 int value)

origin

@NotNull
public @NotNull WGPUOrigin3d origin()

origin

public WGPUTexelCopyTextureInfo origin(@NotNull
 @NotNull WGPUOrigin3d value)

origin

public WGPUTexelCopyTextureInfo origin(Consumer<@NotNull WGPUOrigin3d> consumer)

aspect

@EnumType(WGPUTextureAspect.class)
public int aspect()

aspect

public WGPUTexelCopyTextureInfo aspect(@EnumType(WGPUTextureAspect.class)
 int 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