Record Class WGPUSurfaceSourceXcbWindow

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUSurfaceSourceXcbWindow

All Implemented Interfaces:

IPointer, IWGPUSurfaceSourceXcbWindow

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUSurfaceSourceXcbWindow(@NotNull MemorySegment segment)
extends Record
implements IWGPUSurfaceSourceXcbWindow

Represents a pointer to a WGPUSurfaceSourceXcbWindow structure in native memory.

Structure

typedef struct WGPUSurfaceSourceXcbWindow {
    WGPUChainedStruct chain;
    void* connection;
    uint32_t window;
} WGPUSurfaceSourceXcbWindow;

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	WGPUSurfaceSourceXcbWindow.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 StructLayout	LAYOUT$chain
static final AddressLayout	LAYOUT$connection
static final ValueLayout.OfInt	LAYOUT$window
static final long	OFFSET$chain
static final long	OFFSET$connection
static final long	OFFSET$window
static final MemoryLayout.PathElement	PATH$chain
static final MemoryLayout.PathElement	PATH$connection
static final MemoryLayout.PathElement	PATH$window
static final long	SIZE$chain
static final long	SIZE$connection
static final long	SIZE$window

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUSurfaceSourceXcbWindow	allocate(Arena arena)
static WGPUSurfaceSourceXcbWindow.Ptr	allocate(Arena arena, long count)
@NotNull WGPUChainedStruct	chain()
WGPUSurfaceSourceXcbWindow	chain(@NotNull WGPUChainedStruct value)
WGPUSurfaceSourceXcbWindow	chain(Consumer<@NotNull WGPUChainedStruct> consumer)
static WGPUSurfaceSourceXcbWindow	clone(Arena arena, WGPUSurfaceSourceXcbWindow src)
@NotNull MemorySegment	connection()
WGPUSurfaceSourceXcbWindow	connection(@Nullable IPointer pointer)
WGPUSurfaceSourceXcbWindow	connection(@NotNull MemorySegment value)
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.
final String	toString()	Returns a string representation of this record class.
int	window()
WGPUSurfaceSourceXcbWindow	window(int 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$chain

public static final MemoryLayout.PathElement PATH$chain

PATH$connection

public static final MemoryLayout.PathElement PATH$connection

PATH$window

public static final MemoryLayout.PathElement PATH$window

LAYOUT$chain

public static final StructLayout LAYOUT$chain

LAYOUT$connection

public static final AddressLayout LAYOUT$connection

LAYOUT$window

public static final ValueLayout.OfInt LAYOUT$window

SIZE$chain

public static final long SIZE$chain

SIZE$connection

public static final long SIZE$connection

SIZE$window

public static final long SIZE$window

OFFSET$chain

public static final long OFFSET$chain

OFFSET$connection

public static final long OFFSET$connection

OFFSET$window

public static final long OFFSET$window

Constructor Details

WGPUSurfaceSourceXcbWindow

public WGPUSurfaceSourceXcbWindow(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUSurfaceSourceXcbWindow record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUSurfaceSourceXcbWindow allocate(Arena arena)

allocate

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

clone

public static WGPUSurfaceSourceXcbWindow clone(Arena arena,
 WGPUSurfaceSourceXcbWindow src)

chain

@NotNull
public @NotNull WGPUChainedStruct chain()

chain

public WGPUSurfaceSourceXcbWindow chain(@NotNull
 @NotNull WGPUChainedStruct value)

chain

public WGPUSurfaceSourceXcbWindow chain(Consumer<@NotNull WGPUChainedStruct> consumer)

connection

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

connection

public WGPUSurfaceSourceXcbWindow connection(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

connection

public WGPUSurfaceSourceXcbWindow connection(@Nullable
 @Nullable IPointer pointer)

window

@Unsigned
public int window()

window

public WGPUSurfaceSourceXcbWindow window(@Unsigned
 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