77 lines
2.6 KiB
C++
77 lines
2.6 KiB
C++
#pragma once
|
|
|
|
#include <mbgl/style/layer.hpp>
|
|
#include <mbgl/style/layers/custom_layer_render_parameters.hpp>
|
|
|
|
#include <array>
|
|
#include <memory>
|
|
|
|
namespace mbgl {
|
|
|
|
namespace style {
|
|
|
|
class CustomLayerHost {
|
|
public:
|
|
virtual ~CustomLayerHost() = default;
|
|
/**
|
|
* Initialize any GL/Metal state needed by the custom layer. This method is called
|
|
* once, from the main thread, at a point when the GL context is active but
|
|
* before rendering for the first time.
|
|
*
|
|
* Resources that are acquired in this method must be released in the
|
|
* `deinitialize` function.
|
|
*/
|
|
virtual void initialize() = 0;
|
|
|
|
/**
|
|
* Render the layer. This method is called once per frame. The
|
|
* implementation should not make any assumptions about the GL/Metal state (other
|
|
* than that the correct context is active). It may make changes to the
|
|
* state, and is not required to reset values such as the depth mask,
|
|
* stencil mask, and corresponding test flags to their original values. Make
|
|
* sure that you are drawing your fragments with a z value of 1 to take
|
|
* advantage of the opaque fragment culling in case there are opaque layers
|
|
* above your custom layer.
|
|
*/
|
|
virtual void render(const mbgl::style::CustomLayerRenderParameters&) = 0;
|
|
|
|
/**
|
|
* Called when the system has destroyed the underlying GL/Metal context. The
|
|
* `deinitialize` function will not be called in this case, however
|
|
* `initialize` will be called instead to prepare for a new render.
|
|
*
|
|
*/
|
|
virtual void contextLost() = 0;
|
|
|
|
/**
|
|
* Destroy any GL/Metal state needed by the custom layer, and deallocate context,
|
|
* if necessary. This method is called once, from the main thread, at a
|
|
* point when the GL/Metal context is active.
|
|
*
|
|
* Note that it may be called even when the `initialize` function has not
|
|
* been called.
|
|
*/
|
|
virtual void deinitialize() = 0;
|
|
};
|
|
|
|
class CustomLayer final : public Layer {
|
|
public:
|
|
CustomLayer(const std::string& id, std::unique_ptr<CustomLayerHost> host);
|
|
|
|
CustomLayer(const CustomLayer&) = delete;
|
|
~CustomLayer() final;
|
|
class Impl;
|
|
const Impl& impl() const;
|
|
Mutable<Impl> mutableImpl() const;
|
|
|
|
private:
|
|
std::optional<conversion::Error> setPropertyInternal(const std::string& name,
|
|
const conversion::Convertible& value) final;
|
|
StyleProperty getProperty(const std::string&) const final;
|
|
std::unique_ptr<Layer> cloneRef(const std::string& id) const final;
|
|
Mutable<Layer::Impl> mutableBaseImpl() const final;
|
|
};
|
|
|
|
} // namespace style
|
|
} // namespace mbgl
|