Merge branch 'cad_large_texture_streaming'

Author: Erfan-Ahmadi

examples_tests

@@ -23,7 +23,7 @@ This can then be processed using smoothstep to provide anti-alising when renderi
 @params:
 - msdfSample: sampled SNORM value from the MSDF texture generated by msdfgen library.
 
-- pixelRange = msdfPixelRange * screenPxRangeValue, It is the value to convert snorm distance to screen space distance
+- pixelRange = screenPxRangeValue * msdfPixelRange * 0.5, It is the value to convert snorm distance to screen space distance
     - msdfPixelRange: specifies the width of the range around the shape between the minimum and maximum representable signed distance in shape units or distance field pixels, respectivelly.
         for example if msdfPixelRange is 4, then the range of distance values are [-2, +2], and it can be computed by snormValue * MSDFPixelRange/2.0
         so an snorm value of 1.0 means a distance of 2 pixels outside the shape (in msdf texture space)
@@ -34,7 +34,7 @@ This can then be processed using smoothstep to provide anti-alising when renderi
          where GlyphTextureSpaceSize is the size of the glyph inside the msdf texture/atlas
 */
 float msdfDistance(float3 msdfSample, float pixelRange) {
-    return median(msdfSample.r, msdfSample.g, msdfSample.b) * pixelRange / 2.0f;
+    return median(msdfSample.r, msdfSample.g, msdfSample.b) * pixelRange;
 }
 
 }

include/nbl/builtin/hlsl/text_rendering/msdf.hlsl

@@ -14,6 +14,9 @@
 #include <nbl/builtin/hlsl/cpp_compat/vector.hlsl>
 #include FT_FREETYPE_H
 #include FT_OUTLINE_H
+#include FT_TRUETYPE_TABLES_H
+#include FT_SFNT_NAMES_H
+#include FT_MULTIPLE_MASTERS_H 
 
 using namespace nbl;
 using namespace nbl::core;
@@ -90,14 +93,14 @@ class FontFace : public nbl::core::IReferenceCounted
 		float64_t2 size;
 	};
 
-	FontFace(core::smart_refctd_ptr<TextRenderer>&& textRenderer, const std::string& path)
+	static core::smart_refctd_ptr<FontFace> create(core::smart_refctd_ptr<TextRenderer>&& textRenderer, const std::string& path, int faceIdx = 0)
 	{
-		m_textRenderer = std::move(textRenderer);
-
-		auto error = FT_New_Face(m_textRenderer->m_ftLibrary, path.c_str(), 0, &m_ftFace);
-		assert(!error);
+		FT_Face face;
+		FT_Error res = FT_New_Face(textRenderer->m_ftLibrary, path.c_str(), faceIdx, &face);
+		if (res != 0)
+			return nullptr;
 
-		m_hash = std::hash<std::string>{}(path);
+		return core::smart_refctd_ptr<FontFace>(new FontFace(std::move(textRenderer), face, path), core::dont_grab);
 	}
 
 	~FontFace()
@@ -131,7 +134,7 @@ class FontFace : public nbl::core::IReferenceCounted
 	// transforms uv in glyph space to uv in the actual texture
 	float32_t2 getUV(float32_t2 uv, float32_t2 glyphSize, uint32_t2 textureExtents, uint32_t msdfPixelRange);
 
-	size_t getHash() { return m_hash; }
+	core::blake3_hash_t getHash() { return m_hash; }
 
 	// TODO: make these protected, it's only used for customized tests such as building shapes for hatches
 	FT_GlyphSlot getGlyphSlot(uint32_t glyphId)
@@ -140,14 +143,88 @@ class FontFace : public nbl::core::IReferenceCounted
 		assert(!error);
 		return m_ftFace->glyph;
 	}
-	FT_Face& getFreetypeFace() { return m_ftFace; }
+	
+	FT_Face getFreetypeFace() { return m_ftFace; }
+
 	msdfgen::Shape generateGlyphShape(uint32_t glyphId);
+	
+	// Functions to Set and Query Masters:
+	
+	bool hasMultipleMasters() const
+	{
+		return FT_HAS_MULTIPLE_MASTERS(m_ftFace);
+	}
+
+	uint32_t getMastersCount() const
+	{
+		uint32_t numMasters = 0u;
+		if (hasMultipleMasters())
+		{
+			FT_MM_Var* multipleMasterData;
+			FT_Error res = FT_Get_MM_Var(m_ftFace, &multipleMasterData);
+			if (res == 0)
+			{
+				numMasters = multipleMasterData->num_namedstyles;
+				FT_Done_MM_Var(m_textRenderer->m_ftLibrary, multipleMasterData);
+			}
+		}
+		return numMasters;
+	}
+
+	bool setMasterIndex(uint32_t index)
+	{
+		FT_Error res = FT_Set_Named_Instance(m_ftFace, index);
+		if (res == 0)
+		{
+			calculateFaceHash();
+			return true;
+		}
+		return false;
+	}
+
+	// bits [0,15] are for faceIndex given to create function / constructor
+	// bits [16,30] are for masterIndex given to `setMasterIndex` if it was ever called successfully
+	// bit 31 is always 0
+	// See FreeType documentation: https://freetype.org/freetype2/docs/reference/ft2-face_creation.html#ft_face
+	int32_t getFaceIndex() const
+	{
+		return static_cast<int32_t>(m_ftFace->face_index);
+	}
+
+	// Each face may have multiple masters. to change face index you need to recreate your face and use `int faceIdx` param
+	uint32_t getNumFaces() const { return m_ftFace->num_faces; }
+	
+	// Names:
+	const char* getFontFamilyName() const { return m_ftFace->family_name; }
+	const char* getStyleName() const { return m_ftFace->style_name; }
 
 protected:
 
+	void calculateFaceHash()
+	{
+		core::blake3_hasher hasher;
+		hasher.update(&m_ftFace->face_index, sizeof(FT_Long));
+		hasher.update(&m_pathHash, sizeof(core::blake3_hash_t));
+		m_hash = static_cast<blake3_hash_t>(hasher);
+	}
+	
+	FontFace(core::smart_refctd_ptr<TextRenderer>&& textRenderer, FT_Face face, const std::string& path)
+	{
+		m_textRenderer = std::move(textRenderer);
+		m_ftFace = face;
+
+		// calculate hash path and store it
+		core::blake3_hasher hasher;
+		hasher.update(path.data(), path.size());
+		m_pathHash = static_cast<blake3_hash_t>(hasher);
+		// calculate final hash with faceIdx
+		calculateFaceHash();
+	}
+
 	core::smart_refctd_ptr<TextRenderer> m_textRenderer;
 	FT_Face m_ftFace;
-	size_t m_hash;
+	core::blake3_hash_t m_pathHash;
+	core::blake3_hash_t m_hash;
 };
 
 // Helper class for building an msdfgen shape from a glyph
@@ -213,5 +290,4 @@ class GlyphShapeBuilder {
 }
 }
 }
-
 #endif

include/nbl/ext/TextRendering/TextRendering.h

@@ -119,9 +119,6 @@ core::smart_refctd_ptr<ICPUImage> FontFace::generateGlyphMSDF(uint32_t baseMSDFP
 		// and we can't deep clone it
 		auto shape = generateGlyphShape(glyphId);
 
-		// Empty shapes should've been filtered sooner
-		assert(!shape.contours.empty());
-
 		uint32_t mipW = textureExtents.x / (1 << i);
 		uint32_t mipH = textureExtents.y / (1 << i);
 
@@ -136,6 +133,12 @@ core::smart_refctd_ptr<ICPUImage> FontFace::generateGlyphMSDF(uint32_t baseMSDFP
 		region.imageOffset = { 0u,0u,0u };
 		region.imageExtent = { mipW, mipH, 1u };
 
+		if (shape.contours.empty())
+		{
+			_NBL_DEBUG_BREAK_IF(true); // glyph id has no contours in it's shape for this font
+			return nullptr;
+		}
+
 		auto shapeBounds = shape.getBounds();
 
 		float32_t2 mipExtents = float32_t2(float(mipW), float(mipH));
@@ -166,7 +169,7 @@ core::smart_refctd_ptr<ICPUImage> FontFace::generateGlyphMSDF(uint32_t baseMSDFP
 	assert(bufferOffset <= buffer->getCreationParams().size);
 	image->setBufferAndRegions(std::move(buffer), std::move(regions));
 
-	return std::move(image);
+	return image;
 }
 
 float32_t2 FontFace::getUV(float32_t2 uv, float32_t2 glyphSize, uint32_t2 textureExtents, uint32_t msdfPixelRange)