Studio::System::update

FMOD Studio API

Firelight Technologies FMOD Studio API

Studio::System::update

Updates the Studio System. This should be called once per 'game' tick, or once per frame in your application.

C++ Syntax

FMOD_RESULT Studio::System::update();

C Syntax

FMOD_RESULT FMOD_Studio_System_Update(FMOD_STUDIO_SYSTEM *system);

C# Syntax

RESULT Studio.System.update();

JavaScript Syntax

System.update();

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

When Studio has been initialized in asynchronous mode, calling update flips a command buffer for commands to be executed on the async thread and then immediately returns. It is very fast since it is not executing any commands itself. When Studio has been initialized with FMOD_STUDIO_INIT_SYNCHRONOUS_UPDATE, update will execute the queued commands before returning.

If you do not call Studio::System::update then previous commands will not be executed. While most of the API hides this behaviour with use of shadowed variables, it can cause unexpected results if waiting in a loop for Studio::EventDescription::getSampleLoadingState or Studio::Bank::getLoadingState without calling update first.

See Also




Version 1.10.03 Built on Feb 1, 2018