Record Class WGPUTextureBindingLayout

java.lang.Object

java.lang.Record

club.doki7.webgpu.datatype.WGPUTextureBindingLayout

All Implemented Interfaces:

IPointer, IWGPUTextureBindingLayout

@ValueBasedCandidate
@UnsafeConstructor
public record WGPUTextureBindingLayout(@NotNull MemorySegment segment)
extends Record
implements IWGPUTextureBindingLayout

Represents a pointer to a WGPUTextureBindingLayout structure in native memory.

Structure

typedef struct WGPUTextureBindingLayout {
    WGPUChainedStruct const* nextInChain; // optional
    WGPUTextureSampleType sampleType;
    WGPUTextureViewDimension viewDimension;
    WGPUBool multisampled;
} WGPUTextureBindingLayout;

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static WGPUTextureBindingLayout	allocate(Arena arena)
static WGPUTextureBindingLayout.Ptr	allocate(Arena arena, long count)
static WGPUTextureBindingLayout	clone(Arena arena, WGPUTextureBindingLayout 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	multisampled()
WGPUTextureBindingLayout	multisampled(int value)
@Nullable WGPUChainedStruct	nextInChain()
WGPUChainedStruct.Ptr	nextInChain(int assumedCount)
WGPUTextureBindingLayout	nextInChain(@Nullable IWGPUChainedStruct value)
@NotNull MemorySegment	nextInChainRaw()
void	nextInChainRaw(@NotNull MemorySegment value)
int	sampleType()
WGPUTextureBindingLayout	sampleType(int 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()
WGPUTextureBindingLayout	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$sampleType

public static final MemoryLayout.PathElement PATH$sampleType

PATH$viewDimension

public static final MemoryLayout.PathElement PATH$viewDimension

PATH$multisampled

public static final MemoryLayout.PathElement PATH$multisampled

LAYOUT$nextInChain

public static final AddressLayout LAYOUT$nextInChain

LAYOUT$sampleType

public static final ValueLayout.OfInt LAYOUT$sampleType

LAYOUT$viewDimension

public static final ValueLayout.OfInt LAYOUT$viewDimension

LAYOUT$multisampled

public static final ValueLayout.OfInt LAYOUT$multisampled

SIZE$nextInChain

public static final long SIZE$nextInChain

SIZE$sampleType

public static final long SIZE$sampleType

SIZE$viewDimension

public static final long SIZE$viewDimension

SIZE$multisampled

public static final long SIZE$multisampled

OFFSET$nextInChain

public static final long OFFSET$nextInChain

OFFSET$sampleType

public static final long OFFSET$sampleType

OFFSET$viewDimension

public static final long OFFSET$viewDimension

OFFSET$multisampled

public static final long OFFSET$multisampled

Constructor Details

WGPUTextureBindingLayout

public WGPUTextureBindingLayout(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WGPUTextureBindingLayout record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static WGPUTextureBindingLayout allocate(Arena arena)

allocate

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

clone

public static WGPUTextureBindingLayout clone(Arena arena,
 WGPUTextureBindingLayout src)

nextInChain

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

sampleType

@EnumType(WGPUTextureSampleType.class)
public int sampleType()

sampleType

public WGPUTextureBindingLayout sampleType(@EnumType(WGPUTextureSampleType.class)
 int value)

viewDimension

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

viewDimension

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

multisampled

@NativeType("WGPUBool")
@Unsigned
public int multisampled()

multisampled

public WGPUTextureBindingLayout multisampled(@NativeType("WGPUBool") @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