Navigation: Scripting Reference Manual > Functions & Subroutines > AddSourceUserRay

 

AddSourceUserRay

 

Contact Us: fredsupport@photonengr.com

 

Description

Appends one user ray to a specified source with user rays.  Depending on the number of rays traced, it may be necessary to dimension ray index and ray counter variables as data type Huge_ instead of Long.  Please see Multi-threaded Raytracing for more information.

 

Syntax

rayNum = AddSourceUserRay ( n, ray )

 

Parameters

rayNum (Long or Huge_)

Ray index (as presented in the source dialog) of the user ray added to the source.

 

n As Long

Node number of the source.

 

ray As T_SOURCEUSERRAY

Structure containing data for the ray to be added.

 

Remarks

This function appends one user ray to a specified source in the associated FRED document. If there is a problem, the function returns -1 and does not set an error.

 

See Also

T_SOURCEUSERRAY

AddSourceUserRays

GetSourceUserRayCount

SetSourceIthUserRay

GetSourceIthUserRay

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC