summaryrefslogtreecommitdiff
path: root/include/mbgl/renderer/renderer_observer.hpp
blob: 1a9d3ff9bce63c590caa88c47e8f7dbdc8850f49 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
#pragma once

#include <cstdint>
#include <exception>

namespace mbgl {

class RendererObserver {
public:
    virtual ~RendererObserver() = default;

    enum class RenderMode : uint32_t {
        Partial,
        Full
    };

    // Signals that a repaint is required
    virtual void onInvalidate() {}

    // Resource failed to download / parse
    virtual void onResourceError(std::exception_ptr) {}

    // First frame
    virtual void onWillStartRenderingMap() {}

    // Start of frame, initial is the first frame for this map
    virtual void onWillStartRenderingFrame() {}

    // End of frame, boolean flags that a repaint is required
    virtual void onDidFinishRenderingFrame(RenderMode, bool) {}

    // Final frame
    virtual void onDidFinishRenderingMap() {}

    // Style is missing an image
    using StyleImageMissingCallback = std::function<void()>;
    virtual void onStyleImageMissing(const std::string&, StyleImageMissingCallback done) { done(); }
};

} // namespace mbgl