Module club.doki7.opencl

Package club.doki7.opencl.datatype

Record Class CLImageDescBufferOrMemObject

java.lang.Object

java.lang.Record

club.doki7.opencl.datatype.CLImageDescBufferOrMemObject

All Implemented Interfaces:

club.doki7.ffm.IPointer, ICLImageDescBufferOrMemObject

@ValueBasedCandidate
@UnsafeConstructor
public record CLImageDescBufferOrMemObject(@NotNull MemorySegment segment)
extends Record
implements ICLImageDescBufferOrMemObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CLImageDescBufferOrMemObject.Ptr

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final UnionLayout	LAYOUT
static final AddressLayout	LAYOUT$buffer
static final AddressLayout	LAYOUT$memObject
static final long	OFFSET$buffer
static final long	OFFSET$memObject
static final MemoryLayout.PathElement	PATH$buffer
static final MemoryLayout.PathElement	PATH$memObject
static final long	SIZE$buffer
static final long	SIZE$memObject

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CLImageDescBufferOrMemObject	allocate(Arena arena)
static CLImageDescBufferOrMemObject.Ptr	allocate(Arena arena, long count)
@Nullable CLMem	buffer()
CLImageDescBufferOrMemObject	buffer(@Nullable CLMem value)
static CLImageDescBufferOrMemObject	clone(Arena arena, CLImageDescBufferOrMemObject 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 CLMem	memObject()
CLImageDescBufferOrMemObject	memObject(@Nullable CLMem value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
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 UnionLayout LAYOUT

BYTES

public static final long BYTES

PATH$buffer

public static final MemoryLayout.PathElement PATH$buffer

PATH$memObject

public static final MemoryLayout.PathElement PATH$memObject

LAYOUT$buffer

public static final AddressLayout LAYOUT$buffer

LAYOUT$memObject

public static final AddressLayout LAYOUT$memObject

SIZE$buffer

public static final long SIZE$buffer

SIZE$memObject

public static final long SIZE$memObject

OFFSET$buffer

public static final long OFFSET$buffer

OFFSET$memObject

public static final long OFFSET$memObject

Constructor Details

CLImageDescBufferOrMemObject

public CLImageDescBufferOrMemObject(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a CLImageDescBufferOrMemObject record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static CLImageDescBufferOrMemObject allocate(Arena arena)

allocate

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

clone

public static CLImageDescBufferOrMemObject clone(Arena arena,
 CLImageDescBufferOrMemObject src)

buffer

@Nullable
public @Nullable CLMem buffer()

buffer

public CLImageDescBufferOrMemObject buffer(@Nullable
 @Nullable CLMem value)

memObject

@Nullable
public @Nullable CLMem memObject()

memObject

public CLImageDescBufferOrMemObject memObject(@Nullable
 @Nullable CLMem 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 club.doki7.ffm.IPointer

Returns:

the value of the segment record component