Record Class CLDevicePciBusInfoKhr

java.lang.Object

java.lang.Record

club.doki7.opencl.datatype.CLDevicePciBusInfoKhr

All Implemented Interfaces:

IPointer, ICLDevicePciBusInfoKhr

@ValueBasedCandidate
@UnsafeConstructor
public record CLDevicePciBusInfoKhr(@NotNull MemorySegment segment)
extends Record
implements ICLDevicePciBusInfoKhr

Represents a pointer to a cl_device_pci_bus_info_khr structure in native memory.

Structure

typedef struct cl_device_pci_bus_info_khr {
    cl_uint pciDomain;
    cl_uint pciBus;
    cl_uint pciDevice;
    cl_uint pciFunction;
} cl_device_pci_bus_info_khr;

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_device_pci_bus_info_khr

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$pciBus
static final ValueLayout.OfInt	LAYOUT$pciDevice
static final ValueLayout.OfInt	LAYOUT$pciDomain
static final ValueLayout.OfInt	LAYOUT$pciFunction
static final long	OFFSET$pciBus
static final long	OFFSET$pciDevice
static final long	OFFSET$pciDomain
static final long	OFFSET$pciFunction
static final MemoryLayout.PathElement	PATH$pciBus
static final MemoryLayout.PathElement	PATH$pciDevice
static final MemoryLayout.PathElement	PATH$pciDomain
static final MemoryLayout.PathElement	PATH$pciFunction
static final long	SIZE$pciBus
static final long	SIZE$pciDevice
static final long	SIZE$pciDomain
static final long	SIZE$pciFunction

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CLDevicePciBusInfoKhr	allocate(Arena arena)
static CLDevicePciBusInfoKhr.Ptr	allocate(Arena arena, long count)
static CLDevicePciBusInfoKhr	clone(Arena arena, CLDevicePciBusInfoKhr 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	pciBus()
CLDevicePciBusInfoKhr	pciBus(int value)
int	pciDevice()
CLDevicePciBusInfoKhr	pciDevice(int value)
int	pciDomain()
CLDevicePciBusInfoKhr	pciDomain(int value)
int	pciFunction()
CLDevicePciBusInfoKhr	pciFunction(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$pciDomain

public static final MemoryLayout.PathElement PATH$pciDomain

PATH$pciBus

public static final MemoryLayout.PathElement PATH$pciBus

PATH$pciDevice

public static final MemoryLayout.PathElement PATH$pciDevice

PATH$pciFunction

public static final MemoryLayout.PathElement PATH$pciFunction

LAYOUT$pciDomain

public static final ValueLayout.OfInt LAYOUT$pciDomain

LAYOUT$pciBus

public static final ValueLayout.OfInt LAYOUT$pciBus

LAYOUT$pciDevice

public static final ValueLayout.OfInt LAYOUT$pciDevice

LAYOUT$pciFunction

public static final ValueLayout.OfInt LAYOUT$pciFunction

SIZE$pciDomain

public static final long SIZE$pciDomain

SIZE$pciBus

public static final long SIZE$pciBus

SIZE$pciDevice

public static final long SIZE$pciDevice

SIZE$pciFunction

public static final long SIZE$pciFunction

OFFSET$pciDomain

public static final long OFFSET$pciDomain

OFFSET$pciBus

public static final long OFFSET$pciBus

OFFSET$pciDevice

public static final long OFFSET$pciDevice

OFFSET$pciFunction

public static final long OFFSET$pciFunction

Constructor Details

CLDevicePciBusInfoKhr

public CLDevicePciBusInfoKhr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a CLDevicePciBusInfoKhr record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static CLDevicePciBusInfoKhr allocate(Arena arena)

allocate

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

clone

public static CLDevicePciBusInfoKhr clone(Arena arena,
 CLDevicePciBusInfoKhr src)

pciDomain

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

pciDomain

public CLDevicePciBusInfoKhr pciDomain(@NativeType("cl_uint") @Unsigned
 int value)

pciBus

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

pciBus

public CLDevicePciBusInfoKhr pciBus(@NativeType("cl_uint") @Unsigned
 int value)

pciDevice

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

pciDevice

public CLDevicePciBusInfoKhr pciDevice(@NativeType("cl_uint") @Unsigned
 int value)

pciFunction

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

pciFunction

public CLDevicePciBusInfoKhr pciFunction(@NativeType("cl_uint") @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 IPointer

Returns:

the value of the segment record component