Navigation: Scripting Reference Manual > Functions & Subroutines > SetRayStatus

 

SetRayStatus

 

Contact Us: fredsupport@photonengr.com

 

Description

Modifies the status flags of a specific ray in the 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

oldStatus = SetRayStatus ( id, newStatus )

 

Parameters

oldStatus (Long)

Returns the old status of the ray.

 

id As Long (or Huge_)

The identifier of the ray.

 

newStatus As Long

The new status of the ray.

 

Remarks

This function modifies the status of a specific ray in the ray buffer. This is an advanced function. Contact Photon Engineering for details about ray status flags. If there is a problem, the function sets an error and returns without modifying the ray.

 

See Also

AddRay

GetRay

GetRayCount

GetRayStatus

SetRay

SetRayStatus

Examples

Raydata GetSet

 

 

 

 

 

Copyright © Photon Engineering, LLC