ILGPU  0.9.0
ILGPU.Backends.EntryPoints.EntryPoint Class Reference

Represents a kernel entry point. More...

Inheritance diagram for ILGPU.Backends.EntryPoints.EntryPoint:
ILGPU.Backends.EntryPoints.SeparateViewEntryPoint

Public Member Functions

 EntryPoint (in EntryPointDescription description, in SharedMemorySpecification sharedMemory, in KernelSpecialization specialization)
 Constructs a new entry point targeting the given method. More...
 

Public Attributes

MethodInfo MethodInfo => Description.MethodSource
 Returns the associated method info. More...
 
IndexType IndexType => Description.IndexType
 Returns the index type of the index parameter. More...
 
int KernelIndexParameterOffset => Description.KernelIndexParameterOffset
 Returns the offset for the actual parameter values while taking an implicit index argument into account. More...
 
bool IsExplicitlyGrouped => IndexType == IndexType.KernelConfig
 Returns true if the entry point represents an explicitly grouped kernel. More...
 
bool IsImplictlyGrouped => !IsExplicitlyGrouped
 Returns true if the entry point represents an implicitly grouped kernel. More...
 
ParameterCollection Parameters => Description.Parameters
 Returns the parameter specification of arguments that are passed to the kernel. More...
 
bool HasSpecializedParameters => Parameters.HasSpecializedParameters
 Returns true if this entry point uses specialized parameters. More...
 

Properties

EntryPointDescription Description [get]
 Returns the associated description instance. More...
 
Type KernelIndexType [get]
 Returns the index type of the index parameter. This can also return the KernelConfig type in the case of an explicitly grouped kernel. More...
 
bool HasByRefParameters [get]
 Returns true if the parameter specification contains by reference parameters. More...
 
KernelSpecialization Specialization [get]
 Returns the associated launch specification. More...
 
int NumFlattendedIndexParameters [get]
 Returns the number of index parameters when all structures are flattened into scalar parameters. More...
 
SharedMemorySpecification SharedMemory [get]
 Returns the associated shared memory specification. More...
 

Detailed Description

Represents a kernel entry point.

Constructor & Destructor Documentation

ILGPU.Backends.EntryPoints.EntryPoint.EntryPoint ( in EntryPointDescription  description,
in SharedMemorySpecification  sharedMemory,
in KernelSpecialization  specialization 
)

Constructs a new entry point targeting the given method.

Parameters
descriptionThe entry point description.
sharedMemoryThe shared memory specification.
specializationThe kernel specialization.

Member Data Documentation

bool ILGPU.Backends.EntryPoints.EntryPoint.HasSpecializedParameters => Parameters.HasSpecializedParameters

Returns true if this entry point uses specialized parameters.

IndexType ILGPU.Backends.EntryPoints.EntryPoint.IndexType => Description.IndexType

Returns the index type of the index parameter.

bool ILGPU.Backends.EntryPoints.EntryPoint.IsExplicitlyGrouped => IndexType == IndexType.KernelConfig

Returns true if the entry point represents an explicitly grouped kernel.

bool ILGPU.Backends.EntryPoints.EntryPoint.IsImplictlyGrouped => !IsExplicitlyGrouped

Returns true if the entry point represents an implicitly grouped kernel.

int ILGPU.Backends.EntryPoints.EntryPoint.KernelIndexParameterOffset => Description.KernelIndexParameterOffset

Returns the offset for the actual parameter values while taking an implicit index argument into account.

MethodInfo ILGPU.Backends.EntryPoints.EntryPoint.MethodInfo => Description.MethodSource

Returns the associated method info.

ParameterCollection ILGPU.Backends.EntryPoints.EntryPoint.Parameters => Description.Parameters

Returns the parameter specification of arguments that are passed to the kernel.

Property Documentation

EntryPointDescription ILGPU.Backends.EntryPoints.EntryPoint.Description
get

Returns the associated description instance.

bool ILGPU.Backends.EntryPoints.EntryPoint.HasByRefParameters
get

Returns true if the parameter specification contains by reference parameters.

Type ILGPU.Backends.EntryPoints.EntryPoint.KernelIndexType
get

Returns the index type of the index parameter. This can also return the KernelConfig type in the case of an explicitly grouped kernel.

int ILGPU.Backends.EntryPoints.EntryPoint.NumFlattendedIndexParameters
get

Returns the number of index parameters when all structures are flattened into scalar parameters.

SharedMemorySpecification ILGPU.Backends.EntryPoints.EntryPoint.SharedMemory
get

Returns the associated shared memory specification.

KernelSpecialization ILGPU.Backends.EntryPoints.EntryPoint.Specialization
get

Returns the associated launch specification.


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