Magnum NaCl Application

Initialization...

@endcode You can modify all the files to your liking, but the HTML file must contain at least the `<embed>` enclosed in listener `<div>`. The JavaScript file contains event listeners which print loading status on the page. The status displayed in the remaining two `<div>`s, if they are available. The CSS file contains rudimentary style to avoid eye bleeding. The `<embed>` file references NMF file which you need to provide too. If you target @ref CORRADE_TARGET_NACL_NEWLIB "newlib", the file is pretty simple, for example (change `<application>` to name of your executable): @code { "program": { "x86-32": {"url": "-x86-32.nexe"}, "x86-64": {"url": "-x86-64.nexe"} } } @endcode If you target @ref CORRADE_TARGET_NACL_GLIBC "glibc", you need to specify also all additional dependencies. See [Native Client](https://developers.google.com/native-client/) documentation for more information. @section NaClApplication-console Redirecting output to Chrome's JavaScript console The application redirects @ref Corrade::Utility::Debug "Debug", @ref Corrade::Utility::Warning "Warning" and @ref Corrade::Utility::Error "Error" output to JavaScript console. See also @ref Corrade::Utility::NaClConsoleStreamBuffer for more information. */ class NaClApplication: public pp::Instance, public pp::Graphics3DClient, public pp::MouseLock { public: /** @brief Application arguments */ typedef PP_Instance Arguments; class Configuration; class InputEvent; class KeyEvent; class MouseEvent; class MouseMoveEvent; /** @copydoc GlutApplication::GlutApplication(const Arguments&, const Configuration&) */ #ifdef DOXYGEN_GENERATING_OUTPUT explicit NaClApplication(const Arguments& arguments, const Configuration& configuration = Configuration()); #else /* To avoid "invalid use of incomplete type" */ explicit NaClApplication(const Arguments& arguments, const Configuration& configuration); explicit NaClApplication(const Arguments& arguments); #endif /** @copydoc GlutApplication::GlutApplication(const Arguments&, std::nullptr_t) */ explicit NaClApplication(const Arguments& arguments, std::nullptr_t); /** @brief Whether the application runs fullscreen */ bool isFullscreen(); /** * @brief Set fullscreen * @return `False` if switch to opposite mode is in progress or if the * switch is not possible, `true` otherwise. * * The switch is done asynchronously, during the switch no event * processing is done. */ bool setFullscreen(bool enabled); protected: /* Nobody will need to have (and delete) NaClApplication*, thus this is faster than public pure virtual destructor */ ~NaClApplication(); /** @copydoc GlutApplication::createContext() */ void createContext(const Configuration& configuration); /** @copydoc GlutApplication::tryCreateContext() */ bool tryCreateContext(const Configuration& configuration); /** @{ @name Drawing functions */ /** @copydoc GlutApplication::viewportEvent() */ virtual void viewportEvent(const Vector2i& size) = 0; /** @copydoc GlutApplication::drawEvent() */ virtual void drawEvent() = 0; /** @copydoc GlutApplication::swapBuffers() */ void swapBuffers(); /** @copydoc GlutApplication::redraw() */ void redraw() { flags |= Flag::Redraw; } /*@}*/ /** @{ @name Keyboard handling */ /** * @brief Key press event * * Called when an key is pressed. Default implementation does nothing. * If you accept the event, call @ref InputEvent::setAccepted() "setAccepted()" * on it, otherwise the event will be propagated to the browser. */ virtual void keyPressEvent(KeyEvent& event); /** * @brief Key release event * * Called when an key is released. Default implementation does nothing. * If you accept the event, call @ref InputEvent::setAccepted() "setAccepted()" * on it, otherwise the event will be propagated to the browser. */ virtual void keyReleaseEvent(KeyEvent& event); /*@}*/ /** @{ @name Mouse handling */ public: /** @brief Whether mouse is locked */ bool isMouseLocked() const { return flags & Flag::MouseLocked; } /** * @brief Enable or disable mouse locking * * When mouse is locked, the cursor is hidden and only * MouseMoveEvent::relativePosition() is changing, absolute position * stays the same. */ void setMouseLocked(bool enabled); protected: /** * @brief Mouse press event * * Called when mouse button is pressed. Default implementation does * nothing. If you accept the event, call @ref InputEvent::setAccepted() "setAccepted()" * on it, otherwise the event will be propagated to the browser. */ virtual void mousePressEvent(MouseEvent& event); /** * @brief Mouse release event * * Called when mouse button is released. Default implementation does * nothing. If you accept the event, call @ref InputEvent::setAccepted() "setAccepted()" * on it, otherwise the event will be propagated to the browser. */ virtual void mouseReleaseEvent(MouseEvent& event); /** * @brief Mouse move event * * Called when mouse is moved. Default implementation does nothing. If * you accept the event, call @ref InputEvent::setAccepted() "setAccepted()" * on it, otherwise the event will be propagated to the browser. */ virtual void mouseMoveEvent(MouseMoveEvent& event); /*@}*/ private: struct ConsoleDebugOutput; enum class Flag: UnsignedByte { SwapInProgress = 1 << 0, Redraw = 1 << 1, FullscreenSwitchInProgress = 1 << 2, WillBeFullscreen = 1 << 3, MouseLocked = 1 << 4 }; typedef Containers::EnumSet Flags; void Graphics3DContextLost() override { CORRADE_ASSERT(false, "NaClApplication: context unexpectedly lost", ); } void MouseLockLost() override { flags &= ~Flag::MouseLocked; } void DidChangeView(const pp::View& view) override; bool HandleInputEvent(const pp::InputEvent& event) override; static void swapCallback(void* applicationInstance, std::int32_t); static void mouseLockCallback(void* applicationInstance, std::int32_t); pp::Graphics3D* graphics; pp::Fullscreen* fullscreen; Context* c; Vector2i viewportSize; Flags flags; ConsoleDebugOutput* debugOutput; CORRADE_ENUMSET_FRIEND_OPERATORS(Flags) }; /** @brief %Configuration Double-buffered RGBA canvas with depth and stencil buffers. @see NaClApplication(), createContext() */ class NaClApplication::Configuration { Configuration(const Configuration&) = delete; Configuration(Configuration&&) = delete; Configuration& operator=(const Configuration&) = delete; Configuration& operator=(Configuration&&) = delete; public: constexpr /*implicit*/ Configuration(): _size(640, 480), _sampleCount(0) {} /** @brief Window size */ Vector2i size() const { return _size; } /** * @brief Set window size * @return Reference to self (for method chaining) * * Default is `{640, 480}`. */ Configuration& setSize(const Vector2i& size) { _size = size; return *this; } /** @brief Sample count */ Int sampleCount() const { return _sampleCount; } /** * @brief Set sample count * @return Reference to self (for method chaining) * * Default is `0`, thus no multisampling. See also * @ref Renderer::Feature::Multisampling. */ Configuration& setSampleCount(Int count) { _sampleCount = count; return *this; } private: Vector2i _size; Int _sampleCount; }; /** @brief Base for input events If you accept the event, call setAccepted(), otherwise the event will be propagated to the browser. @see KeyEvent, MouseEvent, MouseMoveEvent, keyPressEvent(), keyReleaseEvent(), mousePressEvent(), mouseReleaseEvent(), mouseMoveEvent() */ class NaClApplication::InputEvent { InputEvent(const InputEvent&) = delete; InputEvent(InputEvent&&) = delete; InputEvent& operator=(const InputEvent&) = delete; InputEvent& operator=(InputEvent&&) = delete; public: /** * @brief %Modifier * * @todo AltGr + PP_INPUTEVENT_MODIFIER_ISKEYPAD, PP_INPUTEVENT_MODIFIER_ISAUTOREPEAT * @see Modifiers, modifiers() */ enum class Modifier: std::uint32_t { Shift = PP_INPUTEVENT_MODIFIER_SHIFTKEY, /**< Shift */ Ctrl = PP_INPUTEVENT_MODIFIER_CONTROLKEY, /**< Ctrl */ Alt = PP_INPUTEVENT_MODIFIER_ALTKEY, /**< Alt */ Meta = PP_INPUTEVENT_MODIFIER_METAKEY, /**< Meta */ #ifdef MAGNUM_BUILD_DEPRECATED /** * @copybrief Button::Left * @deprecated Use @ref Magnum::Platform::NaClApplication::InputEvent::buttons() "buttons()" * and @ref Magnum::Platform::NaClApplication::InputEvent::Button::Left "Button::Left" * instead. */ LeftButton = PP_INPUTEVENT_MODIFIER_LEFTBUTTONDOWN, /** * @copybrief Button::Middle * @deprecated Use @ref Magnum::Platform::NaClApplication::InputEvent::buttons() "buttons()" * and @ref Magnum::Platform::NaClApplication::InputEvent::Button::Middle "Button::Middle" * instead. */ MiddleButton = PP_INPUTEVENT_MODIFIER_MIDDLEBUTTONDOWN, /** * @copybrief Button::Right * @deprecated Use @ref Magnum::Platform::NaClApplication::InputEvent::buttons() "buttons()" * and @ref Magnum::Platform::NaClApplication::InputEvent::Button::Right "Button::Right" * instead. */ RightButton = PP_INPUTEVENT_MODIFIER_RIGHTBUTTONDOWN, #endif CapsLock = PP_INPUTEVENT_MODIFIER_CAPSLOCKKEY, /**< Caps lock */ NumLock = PP_INPUTEVENT_MODIFIER_NUMLOCKKEY /**< Num lock */ }; /** * @brief Set of modifiers * * @see modifiers() */ typedef Containers::EnumSet Modifiers; /** * @brief Mouse button * * @see @ref Buttons, @ref buttons() */ enum class Button: std::uint32_t { Left = PP_INPUTEVENT_MODIFIER_LEFTBUTTONDOWN, /**< Left button */ Middle = PP_INPUTEVENT_MODIFIER_MIDDLEBUTTONDOWN, /**< Middle button */ Right = PP_INPUTEVENT_MODIFIER_RIGHTBUTTONDOWN /**< Right button */ }; /** * @brief Set of mouse buttons * * @see @ref buttons() */ typedef Containers::EnumSet Buttons; /** @brief Modifiers */ constexpr Modifiers modifiers() const { return _modifiers; } /** @brief Mouse buttons */ constexpr Buttons buttons() const { return Button(static_cast(_modifiers)); } /** * @brief Set event as accepted * * If the event is ignored (i.e., not set as accepted), it is * propagated elsewhere (e.g. to the browser). By default is each * event ignored. */ void setAccepted(bool accepted = true) { _accepted = accepted; } /** @brief Whether the event is accepted */ constexpr bool isAccepted() const { return _accepted; } #ifndef DOXYGEN_GENERATING_OUTPUT protected: constexpr InputEvent(Modifiers modifiers): _accepted(false), _modifiers(modifiers) {} ~InputEvent() = default; #endif private: bool _accepted; const Modifiers _modifiers; }; /** @brief Key event See InputEvent for more information. @see keyPressEvent(), keyReleaseEvent() */ class NaClApplication::KeyEvent: public NaClApplication::InputEvent { friend class NaClApplication; public: /** * @brief Key * * @todo Slash, percent, equal to be compatible with *XApplication * @see key() */ enum class Key: std::uint32_t { Enter = 0x0D, /**< Enter */ Esc = 0x1B, /**< Escape */ Up = 0x26, /**< Up arrow */ Down = 0x28, /**< Down arrow */ Left = 0x25, /**< Left arrow */ Right = 0x27, /**< Right arrow */ F1 = 0x70, /**< F1 */ F2 = 0x71, /**< F2 */ F3 = 0x72, /**< F3 */ F4 = 0x73, /**< F4 */ F5 = 0x74, /**< F5 */ F6 = 0x75, /**< F6 */ F7 = 0x76, /**< F7 */ F8 = 0x77, /**< F8 */ F9 = 0x78, /**< F9 */ F10 = 0x79, /**< F10 */ F11 = 0x7A, /**< F11 */ F12 = 0x7B, /**< F12 */ Home = 0x24, /**< Home */ End = 0x23, /**< End */ PageUp = 0x21, /**< Page up */ PageDown = 0x22, /**< Page down */ Space = 0x20, /**< Space */ Comma = 0xBC, /**< Comma */ Period = 0xBE, /**< Period */ Minus = 0xBD, /**< Minus */ Plus = 0xBB, /**< Plus */ Zero = '0', /**< Zero */ One = '1', /**< One */ Two = '2', /**< Two */ Three = '3', /**< Three */ Four = '4', /**< Four */ Five = '5', /**< Five */ Six = '6', /**< Six */ Seven = '7', /**< Seven */ Eight = '8', /**< Eight */ Nine = '9', /**< Nine */ A = 'A', /**< Letter A */ B = 'B', /**< Letter B */ C = 'C', /**< Letter C */ D = 'D', /**< Letter D */ E = 'E', /**< Letter E */ F = 'F', /**< Letter F */ G = 'G', /**< Letter G */ H = 'H', /**< Letter H */ I = 'I', /**< Letter I */ J = 'J', /**< Letter J */ K = 'K', /**< Letter K */ L = 'L', /**< Letter L */ M = 'M', /**< Letter M */ N = 'N', /**< Letter N */ O = 'O', /**< Letter O */ P = 'P', /**< Letter P */ Q = 'Q', /**< Letter Q */ R = 'R', /**< Letter R */ S = 'S', /**< Letter S */ T = 'T', /**< Letter T */ U = 'U', /**< Letter U */ V = 'V', /**< Letter V */ W = 'W', /**< Letter W */ X = 'X', /**< Letter X */ Y = 'Y', /**< Letter Y */ Z = 'Z' /**< Letter Z */ }; /** @brief Key */ constexpr Key key() const { return _key; } private: constexpr KeyEvent(Key key, Modifiers modifiers): InputEvent(modifiers), _key(key) {} const Key _key; }; /** @brief Mouse event See InputEvent for more information. @see MouseMoveEvent, mousePressEvent(), mouseReleaseEvent() */ class NaClApplication::MouseEvent: public NaClApplication::InputEvent { friend class NaClApplication; public: /** * @brief Button * * @see button() */ enum class Button: unsigned int { Left = PP_INPUTEVENT_MOUSEBUTTON_LEFT, /**< Left button */ Middle = PP_INPUTEVENT_MOUSEBUTTON_MIDDLE, /**< Middle button */ Right = PP_INPUTEVENT_MOUSEBUTTON_RIGHT /**< Right button */ }; /** @brief Button */ constexpr Button button() const { return _button; } /** @brief Position */ constexpr Vector2i position() const { return _position; } private: constexpr MouseEvent(Button button, const Vector2i& position, Modifiers modifiers): InputEvent(modifiers), _button(button), _position(position) {} const Button _button; const Vector2i _position; }; /** @brief Mouse move event See InputEvent for more information. @see MouseEvent, mouseMoveEvent() */ class NaClApplication::MouseMoveEvent: public NaClApplication::InputEvent { friend class NaClApplication; public: /** @brief Position */ constexpr Vector2i position() const { return _position; } /** * @brief Relative position * * Position relative to previous event. */ constexpr Vector2i relativePosition() const { return _relativePosition; } private: constexpr MouseMoveEvent(const Vector2i& position, const Vector2i& relativePosition, Modifiers modifiers): InputEvent(modifiers), _position(position), _relativePosition(relativePosition) {} const Vector2i _position, _relativePosition; }; CORRADE_ENUMSET_OPERATORS(NaClApplication::Flags) namespace Implementation { template class NaClModule: public pp::Module { public: ~NaClModule() { glTerminatePPAPI(); } bool Init() override { return glInitializePPAPI(get_browser_interface()); } pp::Instance* CreateInstance(PP_Instance instance) { return new Application(instance); } }; } /** @hideinitializer @brief Entry point for NaCl application @param application Application class name See NaClApplication and @ref portability-applications for more information. When no other application header is included this macro is also aliased to `MAGNUM_APPLICATION_MAIN()`. */ /* look at that insane placement of __attribute__. WTF. */ #define MAGNUM_NACLAPPLICATION_MAIN(application) \ namespace pp { \ Module __attribute__ ((visibility ("default"))) * CreateModule(); \ Module __attribute__ ((visibility ("default"))) * CreateModule() { \ return new Magnum::Platform::Implementation::NaClModule(); \ } \ } #ifndef DOXYGEN_GENERATING_OUTPUT #ifndef MAGNUM_APPLICATION_MAIN typedef NaClApplication Application; typedef BasicScreen Screen; typedef BasicScreenedApplication ScreenedApplication; #define MAGNUM_APPLICATION_MAIN(className) MAGNUM_NACLAPPLICATION_MAIN(className) #else #undef MAGNUM_APPLICATION_MAIN #endif #endif CORRADE_ENUMSET_OPERATORS(NaClApplication::InputEvent::Modifiers) CORRADE_ENUMSET_OPERATORS(NaClApplication::InputEvent::Buttons) }} #endif