Record Class CLImageDesc

java.lang.Object

java.lang.Record

club.doki7.opencl.datatype.CLImageDesc

All Implemented Interfaces:

IPointer, ICLImageDesc

@ValueBasedCandidate
@UnsafeConstructor
public record CLImageDesc(@NotNull MemorySegment segment)
extends Record
implements ICLImageDesc

Represents a pointer to a cl_image_desc structure in native memory.

Structure

typedef struct cl_image_desc {
    cl_mem_object_type imageType;
    size_t imageWidth;
    size_t imageHeight;
    size_t imageDepth;
    size_t imageArraySize;
    size_t imageRowPitch;
    size_t imageSlicePitch;
    cl_uint numMipLevels;
    cl_uint numSamples;
    cl_image_desc_buffer_or_mem_object bufferOrMemObject;
} cl_image_desc;

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.

See Also:

• cl_image_desc

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	CLImageDesc.Ptr	Represents a pointer to / an array of cl_image_desc structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final UnionLayout	LAYOUT$bufferOrMemObject
static final ValueLayout.OfInt	LAYOUT$imageType
static final ValueLayout.OfInt	LAYOUT$numMipLevels
static final ValueLayout.OfInt	LAYOUT$numSamples
static final long	OFFSET$bufferOrMemObject
static final long	OFFSET$imageArraySize
static final long	OFFSET$imageDepth
static final long	OFFSET$imageHeight
static final long	OFFSET$imageRowPitch
static final long	OFFSET$imageSlicePitch
static final long	OFFSET$imageType
static final long	OFFSET$imageWidth
static final long	OFFSET$numMipLevels
static final long	OFFSET$numSamples
static final MemoryLayout.PathElement	PATH$bufferOrMemObject
static final MemoryLayout.PathElement	PATH$imageArraySize
static final MemoryLayout.PathElement	PATH$imageDepth
static final MemoryLayout.PathElement	PATH$imageHeight
static final MemoryLayout.PathElement	PATH$imageRowPitch
static final MemoryLayout.PathElement	PATH$imageSlicePitch
static final MemoryLayout.PathElement	PATH$imageType
static final MemoryLayout.PathElement	PATH$imageWidth
static final MemoryLayout.PathElement	PATH$numMipLevels
static final MemoryLayout.PathElement	PATH$numSamples
static final long	SIZE$bufferOrMemObject
static final long	SIZE$imageArraySize
static final long	SIZE$imageDepth
static final long	SIZE$imageHeight
static final long	SIZE$imageRowPitch
static final long	SIZE$imageSlicePitch
static final long	SIZE$imageType
static final long	SIZE$imageWidth
static final long	SIZE$numMipLevels
static final long	SIZE$numSamples

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CLImageDesc	allocate(Arena arena)
static CLImageDesc.Ptr	allocate(Arena arena, long count)
@NotNull CLImageDescBufferOrMemObject	bufferOrMemObject()
CLImageDesc	bufferOrMemObject(@NotNull CLImageDescBufferOrMemObject value)
CLImageDesc	bufferOrMemObject(Consumer<@NotNull CLImageDescBufferOrMemObject> consumer)
static CLImageDesc	clone(Arena arena, CLImageDesc 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.
long	imageArraySize()
CLImageDesc	imageArraySize(long value)
long	imageDepth()
CLImageDesc	imageDepth(long value)
long	imageHeight()
CLImageDesc	imageHeight(long value)
long	imageRowPitch()
CLImageDesc	imageRowPitch(long value)
long	imageSlicePitch()
CLImageDesc	imageSlicePitch(long value)
int	imageType()
CLImageDesc	imageType(int value)
long	imageWidth()
CLImageDesc	imageWidth(long value)
int	numMipLevels()
CLImageDesc	numMipLevels(int value)
int	numSamples()
CLImageDesc	numSamples(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$imageType

public static final MemoryLayout.PathElement PATH$imageType

PATH$imageWidth

public static final MemoryLayout.PathElement PATH$imageWidth

PATH$imageHeight

public static final MemoryLayout.PathElement PATH$imageHeight

PATH$imageDepth

public static final MemoryLayout.PathElement PATH$imageDepth

PATH$imageArraySize

public static final MemoryLayout.PathElement PATH$imageArraySize

PATH$imageRowPitch

public static final MemoryLayout.PathElement PATH$imageRowPitch

PATH$imageSlicePitch

public static final MemoryLayout.PathElement PATH$imageSlicePitch

PATH$numMipLevels

public static final MemoryLayout.PathElement PATH$numMipLevels

PATH$numSamples

public static final MemoryLayout.PathElement PATH$numSamples

PATH$bufferOrMemObject

public static final MemoryLayout.PathElement PATH$bufferOrMemObject

LAYOUT$imageType

public static final ValueLayout.OfInt LAYOUT$imageType

LAYOUT$numMipLevels

public static final ValueLayout.OfInt LAYOUT$numMipLevels

LAYOUT$numSamples

public static final ValueLayout.OfInt LAYOUT$numSamples

LAYOUT$bufferOrMemObject

public static final UnionLayout LAYOUT$bufferOrMemObject

SIZE$imageType

public static final long SIZE$imageType

SIZE$imageWidth

public static final long SIZE$imageWidth

SIZE$imageHeight

public static final long SIZE$imageHeight

SIZE$imageDepth

public static final long SIZE$imageDepth

SIZE$imageArraySize

public static final long SIZE$imageArraySize

SIZE$imageRowPitch

public static final long SIZE$imageRowPitch

SIZE$imageSlicePitch

public static final long SIZE$imageSlicePitch

SIZE$numMipLevels

public static final long SIZE$numMipLevels

SIZE$numSamples

public static final long SIZE$numSamples

SIZE$bufferOrMemObject

public static final long SIZE$bufferOrMemObject

OFFSET$imageType

public static final long OFFSET$imageType

OFFSET$imageWidth

public static final long OFFSET$imageWidth

OFFSET$imageHeight

public static final long OFFSET$imageHeight

OFFSET$imageDepth

public static final long OFFSET$imageDepth

OFFSET$imageArraySize

public static final long OFFSET$imageArraySize

OFFSET$imageRowPitch

public static final long OFFSET$imageRowPitch

OFFSET$imageSlicePitch

public static final long OFFSET$imageSlicePitch

OFFSET$numMipLevels

public static final long OFFSET$numMipLevels

OFFSET$numSamples

public static final long OFFSET$numSamples

OFFSET$bufferOrMemObject

public static final long OFFSET$bufferOrMemObject

Constructor Details

CLImageDesc

public CLImageDesc(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a CLImageDesc record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static CLImageDesc allocate(Arena arena)

allocate

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

clone

public static CLImageDesc clone(Arena arena,
 CLImageDesc src)

imageType

@NativeType("cl_mem_object_type")
@Unsigned
public int imageType()

imageType

public CLImageDesc imageType(@NativeType("cl_mem_object_type") @Unsigned
 int value)

imageWidth

@Unsigned
public long imageWidth()

imageWidth

public CLImageDesc imageWidth(@Unsigned
 long value)

imageHeight

@Unsigned
public long imageHeight()

imageHeight

public CLImageDesc imageHeight(@Unsigned
 long value)

imageDepth

@Unsigned
public long imageDepth()

imageDepth

public CLImageDesc imageDepth(@Unsigned
 long value)

imageArraySize

@Unsigned
public long imageArraySize()

imageArraySize

public CLImageDesc imageArraySize(@Unsigned
 long value)

imageRowPitch

@Unsigned
public long imageRowPitch()

imageRowPitch

public CLImageDesc imageRowPitch(@Unsigned
 long value)

imageSlicePitch

@Unsigned
public long imageSlicePitch()

imageSlicePitch

public CLImageDesc imageSlicePitch(@Unsigned
 long value)

numMipLevels

@NativeType("cl_uint")
@Unsigned
public int numMipLevels()

numMipLevels

public CLImageDesc numMipLevels(@NativeType("cl_uint") @Unsigned
 int value)

numSamples

@NativeType("cl_uint")
@Unsigned
public int numSamples()

numSamples

public CLImageDesc numSamples(@NativeType("cl_uint") @Unsigned
 int value)

bufferOrMemObject

@NotNull
public @NotNull CLImageDescBufferOrMemObject bufferOrMemObject()

bufferOrMemObject

public CLImageDesc bufferOrMemObject(@NotNull
 @NotNull CLImageDescBufferOrMemObject value)

bufferOrMemObject

public CLImageDesc bufferOrMemObject(Consumer<@NotNull CLImageDescBufferOrMemObject> consumer)

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