Description

Retrieves a previously stored snapshot (in memory), i.e. sets all valuator to the corresponding values stored in that snaphot.

Syntax

inumsnap FLgetsnap index [, igroup]

Initialization

inumsnap -- current number of snapshots.

index -- a number referring unequivocally to a snapshot. Several snapshots can be stored in the same bank.

igroup -- (optional) an integer number referring to a snapshot-related group of widget. It allows to get/set, or to load/save the state of a subset of valuators. Default value is zero that refers to the first group. The group number is determined by the opcode FLsetSnapGroup.

	Note
	The igroup parameter has not been yet fully implemented in the current version of csound. Please do not rely on it yet.

Performance

FLgetsnap retrieves a previously stored snapshot (in memory), i.e. sets all valuator to the corresponding values stored in that snapshot. The index argument unequivocally must refer to an already existing snapshot. If the index argument refers to an empty snapshot or to a snapshot that doesn't exist, no action is done. FLsetsnap outputs the current number of snapshots (inumsnap argument).

For purposes of snapshot saving, widgets can be grouped, so that snapshots affect only a defined group of widgets. The opcode FLsetSnapGroup is used to specify the group for all widgets declared after it, until the next FLsetSnapGroup statement.

See Also

FLloadsnap, FLrun, FLsavesnap, FLsetsnap, FLsetSnapGroup, FLupdate

Credits

Author: Gabriel Maldonado

New in version 4.22