Record Class WGPUSurfaceTexture

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUSurfaceTexture

All Implemented Interfaces:

IPointer, IWGPUSurfaceTexture

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUSurfaceTexture(@NotNull MemorySegment segment)
extends Record
implements IWGPUSurfaceTexture

Represents a pointer to a WGPUSurfaceTexture structure in native memory.

Structure

typedef struct WGPUSurfaceTexture {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUTexture texture;
    WGPUSurfaceGetCurrentTextureStatus status;
} WGPUSurfaceTexture;

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	WGPUSurfaceTexture.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$nextInChain
static final ValueLayout.OfInt	LAYOUT$status
static final AddressLayout	LAYOUT$texture
static final long	OFFSET$nextInChain
static final long	OFFSET$status
static final long	OFFSET$texture
static final MemoryLayout.PathElement	PATH$nextInChain
static final MemoryLayout.PathElement	PATH$status
static final MemoryLayout.PathElement	PATH$texture
static final long	SIZE$nextInChain
static final long	SIZE$status
static final long	SIZE$texture

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUSurfaceTexture	allocate(Arena arena)
static WGPUSurfaceTexture.Ptr	allocate(Arena arena, long count)
static WGPUSurfaceTexture	clone(Arena arena, WGPUSurfaceTexture 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.
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUSurfaceTexture	nextInChain(@Nullable IWGPUChainedStruct value)
@NotNull MemorySegment	nextInChainRaw()
void	nextInChainRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	status()
WGPUSurfaceTexture	status(int value)
@Nullable WGPUTexture	texture()
WGPUSurfaceTexture	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$nextInChain

public static final MemoryLayout.PathElement PATH$nextInChain

PATH$texture

public static final MemoryLayout.PathElement PATH$texture

PATH$status

public static final MemoryLayout.PathElement PATH$status

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$texture

public static final AddressLayout LAYOUT$texture

LAYOUT$status

public static final ValueLayout.OfInt LAYOUT$status

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$texture

public static final long SIZE$texture

SIZE$status

public static final long SIZE$status

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$texture

public static final long OFFSET$texture

OFFSET$status

public static final long OFFSET$status

Constructor Details

WGPUSurfaceTexture

public WGPUSurfaceTexture(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUSurfaceTexture record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUSurfaceTexture allocate(Arena arena)

allocate

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

clone

public static WGPUSurfaceTexture clone(Arena arena,
 WGPUSurfaceTexture src)

nextInChain

public WGPUSurfaceTexture 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)

texture

@Nullable
public @Nullable WGPUTexture texture()

texture

public WGPUSurfaceTexture texture(@Nullable
 @Nullable WGPUTexture value)

status

@EnumType(WGPUSurfaceGetCurrentTextureStatus.class)
public int status()

status

public WGPUSurfaceTexture status(@EnumType(WGPUSurfaceGetCurrentTextureStatus.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