Module club.doki7.opencl

Package club.doki7.opencl.datatype

Record Class CLImageFormat

java.lang.Object

java.lang.Record

club.doki7.opencl.datatype.CLImageFormat

All Implemented Interfaces:

club.doki7.ffm.IPointer, ICLImageFormat

@ValueBasedCandidate
@UnsafeConstructor
public record CLImageFormat(@NotNull MemorySegment segment)
extends Record
implements ICLImageFormat

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CLImageFormat.Ptr

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$imageChannelDataType
static final ValueLayout.OfInt	LAYOUT$imageChannelOrder
static final long	OFFSET$imageChannelDataType
static final long	OFFSET$imageChannelOrder
static final MemoryLayout.PathElement	PATH$imageChannelDataType
static final MemoryLayout.PathElement	PATH$imageChannelOrder
static final long	SIZE$imageChannelDataType
static final long	SIZE$imageChannelOrder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CLImageFormat	allocate(Arena arena)
static CLImageFormat.Ptr	allocate(Arena arena, long count)
static CLImageFormat	clone(Arena arena, CLImageFormat 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	imageChannelDataType()
CLImageFormat	imageChannelDataType(int value)
int	imageChannelOrder()
CLImageFormat	imageChannelOrder(int 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 StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$imageChannelOrder

public static final MemoryLayout.PathElement PATH$imageChannelOrder

PATH$imageChannelDataType

public static final MemoryLayout.PathElement PATH$imageChannelDataType

LAYOUT$imageChannelOrder

public static final ValueLayout.OfInt LAYOUT$imageChannelOrder

LAYOUT$imageChannelDataType

public static final ValueLayout.OfInt LAYOUT$imageChannelDataType

SIZE$imageChannelOrder

public static final long SIZE$imageChannelOrder

SIZE$imageChannelDataType

public static final long SIZE$imageChannelDataType

OFFSET$imageChannelOrder

public static final long OFFSET$imageChannelOrder

OFFSET$imageChannelDataType

public static final long OFFSET$imageChannelDataType

Constructor Details

CLImageFormat

public CLImageFormat(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a CLImageFormat record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static CLImageFormat allocate(Arena arena)

allocate

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

clone

public static CLImageFormat clone(Arena arena,
 CLImageFormat src)

imageChannelOrder

@NativeType("cl_channel_order")
@Unsigned
public int imageChannelOrder()

imageChannelOrder

public CLImageFormat imageChannelOrder(@NativeType("cl_channel_order") @Unsigned
 int value)

imageChannelDataType

@NativeType("cl_channel_type")
@Unsigned
public int imageChannelDataType()

imageChannelDataType

public CLImageFormat imageChannelDataType(@NativeType("cl_channel_type") @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 club.doki7.ffm.IPointer

Returns:

the value of the segment record component