Record Class CLMemAndroidNativeBufferHostPtr

java.lang.Object

java.lang.Record

club.doki7.opencl.datatype.CLMemAndroidNativeBufferHostPtr

All Implemented Interfaces:

IPointer, ICLMemAndroidNativeBufferHostPtr

@ValueBasedCandidate
@UnsafeConstructor
public record CLMemAndroidNativeBufferHostPtr(@NotNull MemorySegment segment)
extends Record
implements ICLMemAndroidNativeBufferHostPtr

Represents a pointer to a cl_mem_android_native_buffer_host_ptr structure in native memory.

Structure

typedef struct cl_mem_android_native_buffer_host_ptr {
    cl_mem_ext_host_ptr extHostPtr;
    void* anbPtr;
} cl_mem_android_native_buffer_host_ptr;

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_mem_android_native_buffer_host_ptr

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$anbPtr
static final StructLayout	LAYOUT$extHostPtr
static final long	OFFSET$anbPtr
static final long	OFFSET$extHostPtr
static final MemoryLayout.PathElement	PATH$anbPtr
static final MemoryLayout.PathElement	PATH$extHostPtr
static final long	SIZE$anbPtr
static final long	SIZE$extHostPtr

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CLMemAndroidNativeBufferHostPtr	allocate(Arena arena)
static CLMemAndroidNativeBufferHostPtr.Ptr	allocate(Arena arena, long count)
@NotNull MemorySegment	anbPtr()
CLMemAndroidNativeBufferHostPtr	anbPtr(@Nullable IPointer pointer)
CLMemAndroidNativeBufferHostPtr	anbPtr(@NotNull MemorySegment value)
static CLMemAndroidNativeBufferHostPtr	clone(Arena arena, CLMemAndroidNativeBufferHostPtr src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull CLMemExtHostPtr	extHostPtr()
CLMemAndroidNativeBufferHostPtr	extHostPtr(@NotNull CLMemExtHostPtr value)
CLMemAndroidNativeBufferHostPtr	extHostPtr(Consumer<@NotNull CLMemExtHostPtr> consumer)
final int	hashCode()	Returns a hash code value for this object.
@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$extHostPtr

public static final MemoryLayout.PathElement PATH$extHostPtr

PATH$anbPtr

public static final MemoryLayout.PathElement PATH$anbPtr

LAYOUT$extHostPtr

public static final StructLayout LAYOUT$extHostPtr

LAYOUT$anbPtr

public static final AddressLayout LAYOUT$anbPtr

SIZE$extHostPtr

public static final long SIZE$extHostPtr

SIZE$anbPtr

public static final long SIZE$anbPtr

OFFSET$extHostPtr

public static final long OFFSET$extHostPtr

OFFSET$anbPtr

public static final long OFFSET$anbPtr

Constructor Details

CLMemAndroidNativeBufferHostPtr

public CLMemAndroidNativeBufferHostPtr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a CLMemAndroidNativeBufferHostPtr record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static CLMemAndroidNativeBufferHostPtr allocate(Arena arena)

allocate

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

clone

public static CLMemAndroidNativeBufferHostPtr clone(Arena arena,
 CLMemAndroidNativeBufferHostPtr src)

extHostPtr

@NotNull
public @NotNull CLMemExtHostPtr extHostPtr()

extHostPtr

public CLMemAndroidNativeBufferHostPtr extHostPtr(@NotNull
 @NotNull CLMemExtHostPtr value)

extHostPtr

public CLMemAndroidNativeBufferHostPtr extHostPtr(Consumer<@NotNull CLMemExtHostPtr> consumer)

anbPtr

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment anbPtr()

anbPtr

public CLMemAndroidNativeBufferHostPtr anbPtr(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

anbPtr

public CLMemAndroidNativeBufferHostPtr anbPtr(@Nullable
 @Nullable IPointer pointer)

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