ILGPU  0.9.0
ILGPU.Runtime.OpenCL.CLAcceleratorId Class Reference

Represents a single OpenCL accelerator reference. More...

Inheritance diagram for ILGPU.Runtime.OpenCL.CLAcceleratorId:
ILGPU.Runtime.AcceleratorId

Public Member Functions

 CLAcceleratorId (IntPtr platformId, IntPtr deviceId)
 Constructs a new OpenCL accelerator reference. More...
 
CLError GetDeviceInfo< T > (CLDeviceInfoType type, out T value)
 Resolves device information as typed structure value of type T . More...
 
GetDeviceInfo< T > (CLDeviceInfoType type)
 Resolves device information as typed structure value of type T . More...
 
bool HasExtension (string extension)
 Returns true if the given extension is supported. More...
 
bool HasAllExtensions< TCollection > (TCollection extensions)
 Returns true if all of the given extensions are supported. More...
 
bool HasAnyExtension< TCollection > (TCollection extensions)
 Returns true if any of the given extensions is supported. More...
 
bool TryGetKernelSubGroupInfo< T > (IntPtr kernel, IntPtr device, CLKernelSubGroupInfoType type, int numInputs, IntPtr *inputs, out T value)
 Tries to resolves kernel sub-group information as typed structure value of type T . More...
 
bool TryGetKernelSubGroupInfo< T > (IntPtr kernel, IntPtr device, CLKernelSubGroupInfoType type, IntPtr[] inputs, out T value)
 Resolves kernel sub-group information as typed structure value of type T . More...
 
override bool Equals (object obj)
 Returns true if the given object is equal to the current accelerator id. More...
 
override int GetHashCode ()
 Returns the hash code of this accelerator id. More...
 
override string ToString ()
 Returns the string representation of this accelerator id. More...
 
- Public Member Functions inherited from ILGPU.Runtime.AcceleratorId
override bool Equals (object obj)
 Returns true if the given object is equal to the current accelerator id. More...
 
override int GetHashCode ()
 Returns the hash code of this accelerator id. More...
 
override string ToString ()
 Returns the string representation of this accelerator id. More...
 

Properties

IntPtr PlatformId [get]
 Returns the OpenCL platform id. More...
 
IntPtr DeviceId [get]
 Returns the OpenCL device id. More...
 
CLDeviceType DeviceType [get]
 Returns the OpenCL device type. More...
 
CLCVersion CVersion [get]
 Returns the supported OpenCL C version. More...
 
ImmutableArray< string > Extensions [get]
 Returns all extensions. More...
 
- Properties inherited from ILGPU.Runtime.AcceleratorId
AcceleratorType AcceleratorType [get]
 Returns the type of the associated accelerator. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ILGPU.Runtime.AcceleratorId
 AcceleratorId (AcceleratorType type)
 Constructs a new accelerator id. More...
 

Detailed Description

Represents a single OpenCL accelerator reference.

Constructor & Destructor Documentation

ILGPU.Runtime.OpenCL.CLAcceleratorId.CLAcceleratorId ( IntPtr  platformId,
IntPtr  deviceId 
)

Constructs a new OpenCL accelerator reference.

Parameters
platformIdThe OpenCL platform id.
deviceIdThe OpenCL device id.

Member Function Documentation

override bool ILGPU.Runtime.OpenCL.CLAcceleratorId.Equals ( object  obj)

Returns true if the given object is equal to the current accelerator id.

Parameters
objThe other object.
Returns
True, if the given object is equal to the current accelerator id.
CLError ILGPU.Runtime.OpenCL.CLAcceleratorId.GetDeviceInfo< T > ( CLDeviceInfoType  type,
out T  value 
)

Resolves device information as typed structure value of type T .

Template Parameters
TThe target type.
Parameters
typeThe information type.
valueThe resolved value.
Returns
The error code.
Type Constraints
T :unmanaged 
T :CLAPI.GetDeviceInfo 
T :DeviceId 
T :type 
T :out 
T :value 
T ILGPU.Runtime.OpenCL.CLAcceleratorId.GetDeviceInfo< T > ( CLDeviceInfoType  type)

Resolves device information as typed structure value of type T .

Template Parameters
TThe target type.
Parameters
typeThe information type.
Returns
The resolved value.
Type Constraints
T :unmanaged 
T :CLAPI.GetDeviceInfo<T> 
T :DeviceId 
T :type 
override int ILGPU.Runtime.OpenCL.CLAcceleratorId.GetHashCode ( )

Returns the hash code of this accelerator id.

Returns
The hash code of this accelerator id.
bool ILGPU.Runtime.OpenCL.CLAcceleratorId.HasAllExtensions< TCollection > ( TCollection  extensions)

Returns true if all of the given extensions are supported.

Parameters
extensionsThe extensions to look for.
Returns
True, if all of the given extensions are supported.
Type Constraints
TCollection :IEnumerable<string> 
bool ILGPU.Runtime.OpenCL.CLAcceleratorId.HasAnyExtension< TCollection > ( TCollection  extensions)

Returns true if any of the given extensions is supported.

Parameters
extensionsThe extensions to look for.
Returns
True, if any of the given extensions is supported.
Type Constraints
TCollection :IEnumerable<string> 
bool ILGPU.Runtime.OpenCL.CLAcceleratorId.HasExtension ( string  extension)

Returns true if the given extension is supported.

Parameters
extensionThe extension to look for.
Returns
True, if the extension is supported.
override string ILGPU.Runtime.OpenCL.CLAcceleratorId.ToString ( )

Returns the string representation of this accelerator id.

Returns
The string representation of this accelerator id.
bool ILGPU.Runtime.OpenCL.CLAcceleratorId.TryGetKernelSubGroupInfo< T > ( IntPtr  kernel,
IntPtr  device,
CLKernelSubGroupInfoType  type,
int  numInputs,
IntPtr *  inputs,
out T  value 
)

Tries to resolves kernel sub-group information as typed structure value of type T .

Template Parameters
TThe target type.
Parameters
kernelThe kernel.
deviceThe device.
typeThe information type.
numInputsThe number of inputs.
inputsAll input values.
valueThe resolved value.
Returns
True, if the value could be resolved.
Type Constraints
T :unmanaged 
bool ILGPU.Runtime.OpenCL.CLAcceleratorId.TryGetKernelSubGroupInfo< T > ( IntPtr  kernel,
IntPtr  device,
CLKernelSubGroupInfoType  type,
IntPtr[]  inputs,
out T  value 
)

Resolves kernel sub-group information as typed structure value of type T .

Template Parameters
TThe target type.
Parameters
kernelThe kernel.
deviceThe device.
typeThe information type.
inputsAll input values.
valueThe resolved value.
Returns
True, if the value could be resolved.
Type Constraints
T :unmanaged 

Property Documentation

CLCVersion ILGPU.Runtime.OpenCL.CLAcceleratorId.CVersion
get

Returns the supported OpenCL C version.

IntPtr ILGPU.Runtime.OpenCL.CLAcceleratorId.DeviceId
get

Returns the OpenCL device id.

CLDeviceType ILGPU.Runtime.OpenCL.CLAcceleratorId.DeviceType
get

Returns the OpenCL device type.

ImmutableArray<string> ILGPU.Runtime.OpenCL.CLAcceleratorId.Extensions
get

Returns all extensions.

IntPtr ILGPU.Runtime.OpenCL.CLAcceleratorId.PlatformId
get

Returns the OpenCL platform id.


The documentation for this class was generated from the following file: