theme_image.hpp

Go to the documentation of this file.

/*
    Copyright 2026 JigSawFr
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
        http://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/
 
#pragma once
 
#include <nanovg.h>
 
#include <functional>
#include <memory>
#include <string>
#include <aurore/core/event.hpp>
#include <aurore/core/theme.hpp>
 
namespace aurore
{
 
struct ThemeImageOptions
{
    int flags   = 0; // NVG_IMAGE_* (NVG_IMAGE_REPEATX...)
    int maxSide = 0; // made smaller to fit in maxSide x maxSide; 0: MAX_WIDTH x MAX_HEIGHT
    // A mask: white, its alpha the picture's, to be tinted when drawn (a
    // picture with no transparent pixel: its dark parts, by luminance)
    bool mask = false;
};
 
struct ThemeImage
{
    enum class State
    {
        LOADING,
        READY,
        FAILED, // cannot be read or decoded: draws nothing
    };
 
    std::string path; // as Theme::resolveAsset() made it
    int flags   = 0; // NVG_IMAGE_* it was made with
    int maxSide = 0; // its ThemeImageOptions
    bool mask   = false;
    State state = State::LOADING;
    int texture = 0; // 0 until READY
    int width = 0, height = 0; // the texture's, after downscaling
    NVGcolor mean {}; // its average colour, opaque, once READY
 
    bool ready() const { return this->state == State::READY; }
 
    bool draw(NVGcontext* vg, float x, float y, float width, float height, BackgroundFit fit,
        const NVGcolor* tint = nullptr, float alpha = 1.0f, float corner = 0.0f) const;
 
    ThemeImage()                             = default;
    ThemeImage(const ThemeImage&)            = delete;
    ThemeImage& operator=(const ThemeImage&) = delete;
    // Deletes the texture: the last owner lets it go on the UI thread
    ~ThemeImage();
};
 
class ThemeImages
{
  public:
    static constexpr int MAX_WIDTH  = 1920;
    static constexpr int MAX_HEIGHT = 1080;
    // The largest side of a theme's logo, of its icons and of its preview
    // (ThemeImageOptions::maxSide): what the screens draw them at, with room
    // for a 1080p screen
    static constexpr int LOGO_SIZE    = 256;
    static constexpr int ICON_SIZE    = 128;
    static constexpr int PREVIEW_SIZE = 128;
 
    static std::shared_ptr<ThemeImage> load(const std::string& path, int flags = 0);
 
    static std::shared_ptr<ThemeImage> load(const std::string& path, const ThemeImageOptions& options);
 
    static Event<const ThemeImage*>* getLoadedEvent();
 
    static bool meanColor(const std::string& path, NVGcolor* color);
 
    static bool knownMeanColor(const std::string& path, NVGcolor* color);
 
    static bool exists(const std::string& path);
 
    static int decoding();
 
    static void releaseAll();
};
 
} // namespace aurore