Docs: Mouse events in device orientation and device motion callbacks?

emscripten/site/source/docs/api_reference/html5.h.rst

Lines 799 to 803 in 0029627

    
           .. c:function:: EMSCRIPTEN_RESULT emscripten_get_deviceorientation_status(EmscriptenDeviceOrientationEvent *orientationState) 
        
             Returns the most recently received ``deviceorientation`` event state. 
        
             Note that for this function call to succeed, :c:func:`emscripten_set_deviceorientation_callback` must have first been called with one of the mouse event types and a non-zero callback function pointer to enable the ``deviceorientation`` state capture.

The docs suggest you need to use to pass mouse events into the device orientation callback. This is a typo, right?

Same thing with device motion:

emscripten/site/source/docs/api_reference/html5.h.rst

Lines 891 to 895 in 0029627

    
           .. c:function:: EMSCRIPTEN_RESULT emscripten_get_devicemotion_status(EmscriptenDeviceMotionEvent *motionState) 
        
             Returns the most recently received `devicemotion <http://w3c.github.io/deviceorientation/spec-source-orientation.html#devicemotion>`_ event state. 
        
             Note that for this function call to succeed, :c:func:`emscripten_set_devicemotion_callback` must have first been called with one of the mouse event types and a non-zero callback function pointer to enable the ``devicemotion`` state capture.

Looks like a typo yes. Would you have time to send a PR?

#23919

[docs] Fix typo about devicemotion and deviceorientation events in ht…

Navigation Menu

Repository navigation

Docs: Mouse events in device orientation and device motion callbacks? #23915

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	.. c:function:: EMSCRIPTEN_RESULT emscripten_get_deviceorientation_status(EmscriptenDeviceOrientationEvent *orientationState)

	Returns the most recently received ``deviceorientation`` event state.

	Note that for this function call to succeed, :c:func:`emscripten_set_deviceorientation_callback` must have first been called with one of the mouse event types and a non-zero callback function pointer to enable the ``deviceorientation`` state capture.

	.. c:function:: EMSCRIPTEN_RESULT emscripten_get_devicemotion_status(EmscriptenDeviceMotionEvent *motionState)

	Returns the most recently received `devicemotion <http://w3c.github.io/deviceorientation/spec-source-orientation.html#devicemotion>`_ event state.

	Note that for this function call to succeed, :c:func:`emscripten_set_devicemotion_callback` must have first been called with one of the mouse event types and a non-zero callback function pointer to enable the ``devicemotion`` state capture.

Docs: Mouse events in device orientation and device motion callbacks? #23915

Description

Activity

sbc100 commented on Mar 13, 2025

davidhiberbom commented on Mar 13, 2025

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions