ILGPU  0.9.0
ILGPU.Backends.EntryPoints.ParameterCollection Struct Reference

The parameter specification of an entry point. More...

Inheritance diagram for ILGPU.Backends.EntryPoints.ParameterCollection:

Classes

struct  Enumerator
 Returns an enumerator to enumerate all types in the collection. More...
 
struct  SpecializedParameter
 Represents a parameter that is annotated with the help of the SpecializedValue<T> structure to enable dynamic specialization of kernels. More...
 

Public Member Functions

bool IsByRef (int parameterIndex)
 Returns true if the specified parameter is passed by reference. More...
 
void CopyTo (Type[] target, int offset)
 Copies the parameter types to the given array. More...
 
Enumerator GetEnumerator ()
 Returns an enumerator to enumerate all types in the collection. More...
 
IEnumerator< Type > IEnumerable< Type >. GetEnumerator ()
 Returns an enumerator to enumerate all types in the collection. More...
 
IEnumerator IEnumerable. GetEnumerator ()
 Returns an enumerator to enumerate all types in the collection. More...
 

Public Attributes

int Count => ParameterTypes.Length
 Returns the number of parameter types. More...
 
bool HasSpecializedParameters => SpecializedParameters.Length > 0
 Returns true if this collection has specialized parameters. More...
 

Properties

ImmutableArray< Type > ParameterTypes [get]
 Returns the desired kernel launcher parameter types (including references). More...
 
ImmutableArray< SpecializedParameterSpecializedParameters [get]
 Returns the desired kernel launcher parameter types (including references). More...
 
Type this[int index] [get]
 Returns the underlying parameter type (without references). More...
 

Detailed Description

The parameter specification of an entry point.

Member Function Documentation

void ILGPU.Backends.EntryPoints.ParameterCollection.CopyTo ( Type[]  target,
int  offset 
)

Copies the parameter types to the given array.

Parameters
targetThe target array.
offsetThe target offset to copy to.
Enumerator ILGPU.Backends.EntryPoints.ParameterCollection.GetEnumerator ( )

Returns an enumerator to enumerate all types in the collection.

Returns
The enumerator.
IEnumerator<Type> IEnumerable<Type>. ILGPU.Backends.EntryPoints.ParameterCollection.GetEnumerator ( )

Returns an enumerator to enumerate all types in the collection.

Returns
The enumerator.
IEnumerator IEnumerable. ILGPU.Backends.EntryPoints.ParameterCollection.GetEnumerator ( )

Returns an enumerator to enumerate all types in the collection.

Returns
The enumerator.
bool ILGPU.Backends.EntryPoints.ParameterCollection.IsByRef ( int  parameterIndex)

Returns true if the specified parameter is passed by reference.

Parameters
parameterIndexThe parameter index.
Returns
True, if the specified parameter is passed by reference.

Member Data Documentation

int ILGPU.Backends.EntryPoints.ParameterCollection.Count => ParameterTypes.Length

Returns the number of parameter types.

bool ILGPU.Backends.EntryPoints.ParameterCollection.HasSpecializedParameters => SpecializedParameters.Length > 0

Returns true if this collection has specialized parameters.

Property Documentation

ImmutableArray<Type> ILGPU.Backends.EntryPoints.ParameterCollection.ParameterTypes
get

Returns the desired kernel launcher parameter types (including references).

ImmutableArray<SpecializedParameter> ILGPU.Backends.EntryPoints.ParameterCollection.SpecializedParameters
get

Returns the desired kernel launcher parameter types (including references).

Type ILGPU.Backends.EntryPoints.ParameterCollection.this[int index]
get

Returns the underlying parameter type (without references).

Parameters
indexThe parameter index.
Returns
The desired parameter type.

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