Skip to content

Add note on emscripten_set_main_loop with Wasm EH #16871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 5, 2022
Merged

Add note on emscripten_set_main_loop with Wasm EH #16871

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c77d168
Add note on emscripten_set_main_loop with Wasm EH
aheejin May 3, 2022
613d074
Address comment
aheejin May 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions site/source/docs/api_reference/emscripten.h.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,8 @@ Functions

.. note:: Calling this function overrides the effect of any previous calls to :c:func:`emscripten_set_main_loop_timing` in the calling thread by applying the timing mode specified by the parameter ``fps``. To specify a different timing mode for the current thread, call the function :c:func:`emscripten_set_main_loop_timing` after setting up the main loop.

.. note:: Currently, ``simulate_infinite_loop`` == true does not work yet with `the new Wasm exception handling <https://emscripten.org/docs/porting/exceptions.html#webassembly-exception-handling-proposal>`_; your program may crash with memory errors.
Copy link
Collaborator

@sbc100 sbc100 May 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps mention "does not work in C++ projects that have objects with destructors on the stack at the time of the call"?

Copy link
Member Author

@aheejin aheejin May 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


:param em_callback_func func: C function to set as main event loop for the calling thread.
:param int fps: Number of frames per second that the JavaScript will call the function. Setting ``int <=0`` (recommended) uses the browser’s ``requestAnimationFrame`` mechanism to call the function.
:param int simulate_infinite_loop: If true, this function will throw an exception in order to stop execution of the caller.
Expand Down