Record Class WGPUStorageTextureBindingLayout

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUStorageTextureBindingLayout

All Implemented Interfaces:

IPointer, IWGPUStorageTextureBindingLayout

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUStorageTextureBindingLayout(@NotNull MemorySegment segment)
extends Record
implements IWGPUStorageTextureBindingLayout

Represents a pointer to a WGPUStorageTextureBindingLayout structure in native memory.

Structure

typedef struct WGPUStorageTextureBindingLayout {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUStorageTextureAccess access;
    WGPUTextureFormat format;
    WGPUTextureViewDimension viewDimension;
} WGPUStorageTextureBindingLayout;

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	WGPUStorageTextureBindingLayout.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$access
static final ValueLayout.OfInt	LAYOUT$format
static final AddressLayout	LAYOUT$nextInChain
static final ValueLayout.OfInt	LAYOUT$viewDimension
static final long	OFFSET$access
static final long	OFFSET$format
static final long	OFFSET$nextInChain
static final long	OFFSET$viewDimension
static final MemoryLayout.PathElement	PATH$access
static final MemoryLayout.PathElement	PATH$format
static final MemoryLayout.PathElement	PATH$nextInChain
static final MemoryLayout.PathElement	PATH$viewDimension
static final long	SIZE$access
static final long	SIZE$format
static final long	SIZE$nextInChain
static final long	SIZE$viewDimension

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	access()
WGPUStorageTextureBindingLayout	access(int value)
static WGPUStorageTextureBindingLayout	allocate(Arena arena)
static WGPUStorageTextureBindingLayout.Ptr	allocate(Arena arena, long count)
static WGPUStorageTextureBindingLayout	clone(Arena arena, WGPUStorageTextureBindingLayout src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	format()
WGPUStorageTextureBindingLayout	format(int value)
final int	hashCode()	Returns a hash code value for this object.
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUStorageTextureBindingLayout	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.
int	viewDimension()
WGPUStorageTextureBindingLayout	viewDimension(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$nextInChain

public static final MemoryLayout.PathElement PATH$nextInChain

PATH$access

public static final MemoryLayout.PathElement PATH$access

PATH$format

public static final MemoryLayout.PathElement PATH$format

PATH$viewDimension

public static final MemoryLayout.PathElement PATH$viewDimension

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$access

public static final ValueLayout.OfInt LAYOUT$access

LAYOUT$format

public static final ValueLayout.OfInt LAYOUT$format

LAYOUT$viewDimension

public static final ValueLayout.OfInt LAYOUT$viewDimension

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$access

public static final long SIZE$access

SIZE$format

public static final long SIZE$format

SIZE$viewDimension

public static final long SIZE$viewDimension

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$access

public static final long OFFSET$access

OFFSET$format

public static final long OFFSET$format

OFFSET$viewDimension

public static final long OFFSET$viewDimension

Constructor Details

WGPUStorageTextureBindingLayout

public WGPUStorageTextureBindingLayout(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUStorageTextureBindingLayout record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUStorageTextureBindingLayout allocate(Arena arena)

allocate

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

clone

public static WGPUStorageTextureBindingLayout clone(Arena arena,
 WGPUStorageTextureBindingLayout src)

nextInChain

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

access

@EnumType(WGPUStorageTextureAccess.class)
public int access()

access

public WGPUStorageTextureBindingLayout access(@EnumType(WGPUStorageTextureAccess.class)
 int value)

format

@EnumType(WGPUTextureFormat.class)
public int format()

format

public WGPUStorageTextureBindingLayout format(@EnumType(WGPUTextureFormat.class)
 int value)

viewDimension

@EnumType(WGPUTextureViewDimension.class)
public int viewDimension()

viewDimension

public WGPUStorageTextureBindingLayout viewDimension(@EnumType(WGPUTextureViewDimension.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