| /* |
| * Copyright 2016 Google Inc. |
| * |
| * Use of this source code is governed by a BSD-style license that can be |
| * found in the LICENSE file. |
| */ |
| |
| #ifndef Window_DEFINED |
| #define Window_DEFINED |
| |
| #include "include/core/SkRect.h" |
| #include "include/core/SkTypes.h" |
| #include "include/private/SkTDArray.h" |
| #include "tools/InputState.h" |
| #include "tools/ModifierKey.h" |
| #include "tools/sk_app/DisplayParams.h" |
| |
| class GrContext; |
| class SkCanvas; |
| class SkSurface; |
| class SkSurfaceProps; |
| |
| namespace sk_app { |
| |
| class WindowContext; |
| |
| class Window { |
| public: |
| static Window* CreateNativeWindow(void* platformData); |
| |
| virtual ~Window(); |
| |
| virtual void setTitle(const char*) = 0; |
| virtual void show() = 0; |
| |
| // JSON-formatted UI state for Android. Do nothing by default |
| virtual void setUIState(const char*) {} |
| |
| // Shedules an invalidation event for window if one is not currently pending. |
| // Make sure that either onPaint or markInvalReceived is called when the client window consumes |
| // the the inval event. They unset fIsContentInvalided which allow future onInval. |
| void inval(); |
| |
| virtual bool scaleContentToFit() const { return false; } |
| |
| enum BackendType { |
| kNativeGL_BackendType, |
| #if SK_ANGLE && defined(SK_BUILD_FOR_WIN) |
| kANGLE_BackendType, |
| #endif |
| #ifdef SK_DAWN |
| kDawn_BackendType, |
| #endif |
| #ifdef SK_VULKAN |
| kVulkan_BackendType, |
| #endif |
| #if SK_METAL && defined(SK_BUILD_FOR_MAC) |
| kMetal_BackendType, |
| #endif |
| kRaster_BackendType, |
| |
| kLast_BackendType = kRaster_BackendType |
| }; |
| enum { |
| kBackendTypeCount = kLast_BackendType + 1 |
| }; |
| |
| virtual bool attach(BackendType) = 0; |
| void detach(); |
| |
| // input handling |
| enum class Key { |
| kNONE, //corresponds to android's UNKNOWN |
| |
| kLeftSoftKey, |
| kRightSoftKey, |
| |
| kHome, //!< the home key - added to match android |
| kBack, //!< (CLR) |
| kSend, //!< the green (talk) key |
| kEnd, //!< the red key |
| |
| k0, |
| k1, |
| k2, |
| k3, |
| k4, |
| k5, |
| k6, |
| k7, |
| k8, |
| k9, |
| kStar, //!< the * key |
| kHash, //!< the # key |
| |
| kUp, |
| kDown, |
| kLeft, |
| kRight, |
| |
| // Keys needed by ImGui |
| kTab, |
| kPageUp, |
| kPageDown, |
| kDelete, |
| kEscape, |
| kShift, |
| kCtrl, |
| kOption, // AKA Alt |
| kA, |
| kC, |
| kV, |
| kX, |
| kY, |
| kZ, |
| |
| kOK, //!< the center key |
| |
| kVolUp, //!< volume up - match android |
| kVolDown, //!< volume down - same |
| kPower, //!< power button - same |
| kCamera, //!< camera - same |
| |
| kLast = kCamera |
| }; |
| static const int kKeyCount = static_cast<int>(Key::kLast) + 1; |
| |
| class Layer { |
| public: |
| Layer() : fActive(true) {} |
| virtual ~Layer() = default; |
| |
| bool getActive() { return fActive; } |
| void setActive(bool active) { fActive = active; } |
| |
| // return value of 'true' means 'I have handled this event' |
| virtual void onBackendCreated() {} |
| virtual void onAttach(Window* window) {} |
| virtual bool onChar(SkUnichar c, ModifierKey modifiers) { return false; } |
| virtual bool onKey(Key key, InputState state, ModifierKey modifiers) { return false; } |
| virtual bool onMouse(int x, int y, InputState state, ModifierKey modifiers) { return false; } |
| virtual bool onMouseWheel(float delta, ModifierKey modifiers) { return false; } |
| virtual bool onTouch(intptr_t owner, InputState state, float x, float y) { return false; } |
| virtual void onUIStateChanged(const SkString& stateName, const SkString& stateValue) {} |
| virtual void onPrePaint() {} |
| virtual void onPaint(SkSurface*) {} |
| virtual void onResize(int width, int height) {} |
| |
| private: |
| friend class Window; |
| bool fActive; |
| }; |
| |
| void pushLayer(Layer* layer) { |
| layer->onAttach(this); |
| fLayers.push_back(layer); |
| } |
| |
| void onBackendCreated(); |
| bool onChar(SkUnichar c, ModifierKey modifiers); |
| bool onKey(Key key, InputState state, ModifierKey modifiers); |
| bool onMouse(int x, int y, InputState state, ModifierKey modifiers); |
| bool onMouseWheel(float delta, ModifierKey modifiers); |
| bool onTouch(intptr_t owner, InputState state, float x, float y); // multi-owner = multi-touch |
| void onUIStateChanged(const SkString& stateName, const SkString& stateValue); |
| void onPaint(); |
| void onResize(int width, int height); |
| |
| int width() const; |
| int height() const; |
| |
| virtual const DisplayParams& getRequestedDisplayParams() { return fRequestedDisplayParams; } |
| virtual void setRequestedDisplayParams(const DisplayParams&, bool allowReattach = true); |
| |
| // Actual parameters in effect, obtained from the native window. |
| int sampleCount() const; |
| int stencilBits() const; |
| |
| // Returns null if there is not a GPU backend or if the backend is not yet created. |
| GrContext* getGrContext() const; |
| |
| protected: |
| Window(); |
| |
| SkTDArray<Layer*> fLayers; |
| DisplayParams fRequestedDisplayParams; |
| |
| std::unique_ptr<WindowContext> fWindowContext; |
| |
| virtual void onInval() = 0; |
| |
| // Uncheck fIsContentInvalided to allow future inval/onInval. |
| void markInvalProcessed(); |
| |
| bool fIsContentInvalidated = false; // use this to avoid duplicate invalidate events |
| |
| void visitLayers(std::function<void(Layer*)> visitor); |
| bool signalLayers(std::function<bool(Layer*)> visitor); |
| }; |
| |
| } // namespace sk_app |
| #endif |