Navigation: Scripting Reference Manual > Functions & Subroutines > DeleteRay

 

DeleteRay

 

Contact Us: fredsupport@photonengr.com

 

Description

Deletes a particular ray from the active ray buffer.  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

result = DeleteRay ( id )

 

Parameters

result (Boolean)

Indicates the success (True) or failure (False) of the deletion.

 

id As Long (or Huge_)

The identifier of the ray to be deleted.

 

Remarks

This function deletes a particular ray from the active ray buffer. If there is a problem the function sets an error and returns False.

 

See Also

GetRayCount

GetRayIsFailed

GetRayStatus

DeleteRays

Examples

Ray Data

 

 

 

 

 

Copyright © Photon Engineering, LLC