Record Class CLQueueFamilyPropertiesIntel

java.lang.Object

java.lang.Record

club.doki7.opencl.datatype.CLQueueFamilyPropertiesIntel

All Implemented Interfaces:

IPointer, ICLQueueFamilyPropertiesIntel

@ValueBasedCandidate
@UnsafeConstructor
public record CLQueueFamilyPropertiesIntel(@NotNull MemorySegment segment)
extends Record
implements ICLQueueFamilyPropertiesIntel

Represents a pointer to a cl_queue_family_properties_intel structure in native memory.

Structure

typedef struct cl_queue_family_properties_intel {
    cl_command_queue_properties properties;
    cl_command_queue_capabilities_intel capabilities;
    cl_uint count;
    char[CL_QUEUE_FAMILY_MAX_NAME_SIZE_INTEL] name;
} cl_queue_family_properties_intel;

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_queue_family_properties_intel

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfLong	LAYOUT$capabilities
static final ValueLayout.OfInt	LAYOUT$count
static final SequenceLayout	LAYOUT$name
static final ValueLayout.OfLong	LAYOUT$properties
static final long	OFFSET$capabilities
static final long	OFFSET$count
static final long	OFFSET$name
static final long	OFFSET$properties
static final MemoryLayout.PathElement	PATH$capabilities
static final MemoryLayout.PathElement	PATH$count
static final MemoryLayout.PathElement	PATH$name
static final MemoryLayout.PathElement	PATH$properties
static final long	SIZE$capabilities
static final long	SIZE$count
static final long	SIZE$name
static final long	SIZE$properties

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CLQueueFamilyPropertiesIntel	allocate(Arena arena)
static CLQueueFamilyPropertiesIntel.Ptr	allocate(Arena arena, long count)
long	capabilities()
CLQueueFamilyPropertiesIntel	capabilities(long value)
static CLQueueFamilyPropertiesIntel	clone(Arena arena, CLQueueFamilyPropertiesIntel src)
int	count()
CLQueueFamilyPropertiesIntel	count(int value)
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.
BytePtr	name()
CLQueueFamilyPropertiesIntel	name(BytePtr value)
CLQueueFamilyPropertiesIntel	name(@NotNull Consumer<BytePtr> consumer)
@NotNull MemorySegment	nameRaw()
long	properties()
CLQueueFamilyPropertiesIntel	properties(long 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$properties

public static final MemoryLayout.PathElement PATH$properties

PATH$capabilities

public static final MemoryLayout.PathElement PATH$capabilities

PATH$count

public static final MemoryLayout.PathElement PATH$count

PATH$name

public static final MemoryLayout.PathElement PATH$name

LAYOUT$properties

public static final ValueLayout.OfLong LAYOUT$properties

LAYOUT$capabilities

public static final ValueLayout.OfLong LAYOUT$capabilities

LAYOUT$count

public static final ValueLayout.OfInt LAYOUT$count

LAYOUT$name

public static final SequenceLayout LAYOUT$name

SIZE$properties

public static final long SIZE$properties

SIZE$capabilities

public static final long SIZE$capabilities

SIZE$count

public static final long SIZE$count

SIZE$name

public static final long SIZE$name

OFFSET$properties

public static final long OFFSET$properties

OFFSET$capabilities

public static final long OFFSET$capabilities

OFFSET$count

public static final long OFFSET$count

OFFSET$name

public static final long OFFSET$name

Constructor Details

CLQueueFamilyPropertiesIntel

public CLQueueFamilyPropertiesIntel(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a CLQueueFamilyPropertiesIntel record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static CLQueueFamilyPropertiesIntel allocate(Arena arena)

allocate

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

clone

public static CLQueueFamilyPropertiesIntel clone(Arena arena,
 CLQueueFamilyPropertiesIntel src)

properties

@NativeType("cl_command_queue_properties")
@Unsigned
public long properties()

properties

public CLQueueFamilyPropertiesIntel properties(@NativeType("cl_command_queue_properties") @Unsigned
 long value)

capabilities

@NativeType("cl_command_queue_capabilities_intel")
@Unsigned
public long capabilities()

capabilities

public CLQueueFamilyPropertiesIntel capabilities(@NativeType("cl_command_queue_capabilities_intel") @Unsigned
 long value)

count

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

count

public CLQueueFamilyPropertiesIntel count(@NativeType("cl_uint") @Unsigned
 int value)

name

public BytePtr name()

name

public CLQueueFamilyPropertiesIntel name(@NotNull
 @NotNull Consumer<BytePtr> consumer)

name

public CLQueueFamilyPropertiesIntel name(BytePtr value)

nameRaw

@NotNull
public @NotNull MemorySegment nameRaw()

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