Older Newer
Sun, 26 Dec 2021 06:52:02 . . . . SyneRyder [Note minimum FM version requirement]


Changes by last author:

Added:
= fgetArray =

Requires FM 1.0 Beta 9.0 (Apr 2008) or newer

== Syntax ==

:double fgetArray (int nr, int x, int y, int z)

== Arguments ==

:nr

::Number of the array. Values from 0 to 99 are acccepted.

:x, y, z

::x, y, and z coordinates of a cell in the array. If you allocated a one-dimensional array, set y and z to zero. If you allocated a two-dimensional array, set z to zero.

== Return ==

:Returns the (double)? floating-point value that was stored at the specified coordinates in the array. If the specified coordinates lie outside the array or the index nr is invalid, the value 0.0 will be returned. The byte-size of the Array must be 2 (half), 4 (float), or 8 (double); otherwise 0.0 will be returned.

== Description ==

:This function lets you read a floating-point value from an array.

== Example ==

:See allocArray

== Also see ==

:allocArray, freeArray, getArray, fgetArray, putArray, fputArray, getArrayDim, copyArray, ffillArray

== Comments ==

:Everyone can add his comments about his experiences with this function here. Tips for using it are welcome, too.