Navigation: Scripting Reference Manual > Functions & Subroutines > CopyRayAuxBufferToBuffer

 

CopyRayAuxBufferToBuffer

 

Contact Us: fredsupport@photonengr.com

 

Description

Copies a specific ray from an auxiliary buffer to a standard ray buffer.  Standard ray buffers are those resulting from a standard FRED raytrace or which have been created manually in the scripting language.  Auxiliary buffers cannot be created by the user but are the result of specialized raytrace functions such as the single raytrace and targeted raytrace.  Note that auxiliary ray buffers are tied to the GUI dialog that generates them and closing the dialog will delete the ray buffer.  Therefore, script commands which access auxiliary ray buffers must be run with the associated GUI dialog still open.

 

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

CopyRayAuxBufferToBuffer iray, auxBufSrc, bufDst

 

Parameters

iRay As Long (or Huge_)

Index of the ray being copied from the auxiliary buffer.

 

auxBufSrc As Long

Index of the auxiliary ray buffer where the ray being copied exists.  Auxiliary ray buffers are added in the order that the associated GUI dialogs were opened.

 

bufDst As Long

Index of the destination ray buffer where the ray is being copied to.

 

 

See Also

GetAuxRayBufferRayCount

GetAuxRayBufferCount

MoveRayBufferToBuffer

GetActiveRayBufferIndex

 

Examples

Ray Buffer Handling

 

 

 

 

 

Copyright © Photon Engineering, LLC