/* This file is part of Magnum. Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Vladimír Vondruš Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #include "DistanceFieldGlyphCache.h" #include "Magnum/Image.h" #include "Magnum/ImageView.h" #include "Magnum/PixelFormat.h" #include "Magnum/GL/Context.h" #include "Magnum/GL/Extensions.h" #ifndef CORRADE_NO_ASSERT #include "Magnum/GL/PixelFormat.h" #endif #include "Magnum/GL/TextureFormat.h" #include "Magnum/Math/Range.h" #include "Magnum/TextureTools/DistanceField.h" namespace Magnum { namespace Text { DistanceFieldGlyphCache::DistanceFieldGlyphCache(const Vector2i& sourceSize, const Vector2i& size, const UnsignedInt radius): #if !(defined(MAGNUM_TARGET_GLES) && defined(MAGNUM_TARGET_GLES2)) GlyphCache(GL::TextureFormat::R8, sourceSize, size, Vector2i(radius)), #elif !defined(MAGNUM_TARGET_WEBGL) /* Luminance is not renderable in most cases */ GlyphCache(GL::Context::current().isExtensionSupported() ? GL::TextureFormat::R8 : GL::TextureFormat::RGB8, sourceSize, size, Vector2i(radius)), #else GlyphCache(GL::TextureFormat::RGB, sourceSize, size, Vector2i(radius)), #endif _size{size}, _distanceField{radius} { #ifndef MAGNUM_TARGET_GLES MAGNUM_ASSERT_GL_EXTENSION_SUPPORTED(GL::Extensions::ARB::texture_rg); #endif /* Replicating the assertion from TextureTools::DistanceField so it gets checked during construction already instead of only later during the setImage() call */ CORRADE_ASSERT(sourceSize % size == Vector2i{0} && (sourceSize/size) % 2 == Vector2i{0}, "Text::DistanceFieldGlyphCache: expected source and destination size ratio to be a multiple of 2, got" << Debug::packed << sourceSize << "and" << Debug::packed << size, ); #if defined(MAGNUM_TARGET_GLES2) && !defined(MAGNUM_TARGET_WEBGL) /* Luminance is not renderable in most cases */ if(!GL::Context::current().isExtensionSupported()) Warning() << "Text::DistanceFieldGlyphCache:" << GL::Extensions::EXT::texture_rg::string() << "not supported, using inefficient RGB format for glyph cache texture"; #endif } GlyphCacheFeatures DistanceFieldGlyphCache::doFeatures() const { return GlyphCacheFeature::ImageProcessing #ifndef MAGNUM_TARGET_GLES |GlyphCacheFeature::ProcessedImageDownload #endif ; } void DistanceFieldGlyphCache::doSetImage(const Vector2i& offset, const ImageView2D& image) { GL::Texture2D input; input.setWrapping(GL::SamplerWrapping::ClampToEdge) .setMinificationFilter(GL::SamplerFilter::Linear) .setMagnificationFilter(GL::SamplerFilter::Linear); /* Upload the input texture and create a distance field from it */ const Vector2 scale = Vector2{_size}/Vector2{size().xy()}; /* On ES2 without EXT_unpack_subimage and on WebGL 1 there's no possibility to upload just a slice of the input, upload the whole image instead by ignoring the PixelStorage properties of the input and also process it as a whole. */ #ifdef MAGNUM_TARGET_GLES2 #ifndef MAGNUM_TARGET_WEBGL if(!GL::Context::current().isExtensionSupported()) #endif { input.setImage(0, GL::textureFormat(image.format()), ImageView2D{image.format(), size().xy(), image.data()}); _distanceField(input, texture(), {{}, size().xy()*scale}, size().xy()); #ifdef MAGNUM_TARGET_WEBGL static_cast(offset); #endif } #ifndef MAGNUM_TARGET_WEBGL else #endif #endif #if !(defined(MAGNUM_TARGET_GLES2) && defined(MAGNUM_TARGET_WEBGL)) { /* Create an image view that includes the distance field radius as well, to be sure the edges are processed appropriately as well */ /** @todo this feels more like a hack than a real solution, any better idea? Tried to make TextureTools::DistanceField pad the processing area on its own, but eventually gave up as it would (a) made the processing do more work than necessary in many cases, with no easy way to opt out of that, (b) wasn't really working if the input didn't have a black strip around the edge on platforms that don't support border clamp, (c) required the input texture to have certain wrapping mode set */ CORRADE_INTERNAL_ASSERT(image.storage().skip().xy() == offset); const Vector2i paddedMin = Math::max(Vector2i{0}, image.storage().skip().xy() - padding()); const Vector2i paddedMax = Math::min(size().xy(), image.size() + image.storage().skip().xy() + padding()); const ImageView2D paddedImage{ PixelStorage{image.storage()} .setSkip({paddedMin, image.storage().skip().z()}), image.format(), paddedMax - paddedMin, image.data()}; input.setImage(0, GL::textureFormat(paddedImage.format()), paddedImage); _distanceField(input, texture(), Range2Di::fromSize(paddedMin*scale, paddedImage.size()*scale), paddedImage.size()); } #endif } void DistanceFieldGlyphCache::setDistanceFieldImage(const Vector2i& offset, const ImageView2D& image) { CORRADE_ASSERT((offset >= Vector2i{} && offset + image.size() <= _size).all(), "Text::DistanceFieldGlyphCache::setDistanceFieldImage():" << Range2Di::fromSize(offset, image.size()) << "out of range for texture size" << _size, ); #ifndef CORRADE_NO_ASSERT const GL::PixelFormat format = GL::pixelFormat(image.format()); #endif #if !(defined(MAGNUM_TARGET_GLES) && defined(MAGNUM_TARGET_GLES2)) CORRADE_ASSERT(format == GL::PixelFormat::Red, "Text::DistanceFieldGlyphCache::setDistanceFieldImage(): expected" << GL::PixelFormat::Red << "but got" << format, ); #else #ifndef MAGNUM_TARGET_WEBGL if(GL::Context::current().isExtensionSupported()) CORRADE_ASSERT(format == GL::PixelFormat::Red, "Text::DistanceFieldGlyphCache::setDistanceFieldImage(): expected" << GL::PixelFormat::Red << "but got" << format, ); else #endif { /* Luminance is not renderable in most cases */ CORRADE_ASSERT(format == GL::PixelFormat::RGB, "Text::DistanceFieldGlyphCache::setDistanceFieldImage(): expected" << GL::PixelFormat::RGB << "but got" << format, ); } #endif texture().setSubImage(0, offset, image); } #ifndef MAGNUM_TARGET_GLES Image3D DistanceFieldGlyphCache::doProcessedImage() { Image2D out = _texture.image(0, PixelFormat::R8Unorm); return Image3D{out.format(), {out.size(), 1}, out.release()}; } #endif }}