Older Newer
Fri, 20 Dec 2019 13:30:53 . . . . SyneRyder [Initial function definition]


Changes by last author:

Added:
= __fputArray =

== Syntax ==

double __fputArray (int nr, int x, int y, int z, double dval)

== Arguments ==

:nr

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

: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.

:dval

::Floating-point value that will be stored at the specified coordinates in the array.

== Return ==

Returns 1 if the function succeeded, or 0 if there are more than 4 bytes per array cell. Warning: If the specified coordinates lie outside the array, the plug-in may crash.

== Description ==

Lets you store a floating-point value in an array. This is a fast version of fputArray without any error checking or memory checking. As it does not do any border checking, it may produce error messages or even crashes if not used properly.

When storing a value into an Array with byte-size 2, the value will be converted to 16-bit half. For an Array of byte-size 4, the value is converted to a 32-bit float. If the byte-size is not 2, 4, or 8, a value of 0 is returned to indicate failure.

== Example ==

See fgetArray.

== See Also ==

__putArray, __fputArray, allocArray, freeArray, putArray, getArrayDim, copyArray