sdl stb font下载-SDL sdl stb font源代码下载

SDL STB字体渲染器

仅使用STB_TRUETYPE在纯SDL2中渲染文本的仅标题库。这是绘制的，即允许快速文本渲染的字形。它还提供了几种简单的方法来渲染一个字符串以使纹理以使更快的文本渲染。

新（2022）！可以使用producerConsumerFrontend.h的多线程环境中的prerender！

新（2021）！也可以使用bgfxFrontend.h在BGFX中渲染！

示例图像：

示例文本测试

示例文本来自http://www.columbia.edu/~fdc/utf8/index.html

示例格式

接触：

liam twigger- @snapperthetwig

特征：

单头库 - 无需构建系统。只需包括然后走！
以纯SDL运行 - 不需要openGL（尽管它可以与OpenGL一起使用）
简单的文本渲染fc.drawText(x, y, string)
呈现纹理fc.renderTextToTexture(string, &widthOut, &heightOut)
形成的文本（如果您有字体！）。请参阅末端附近的格式部分
渲染到纹理对象 - 请参见示例
可以将鼠标的位置转换为字符串中的Caret位置（仅没有新线的字符串）
UTF-8支持
处理新线和标签
后备字体支持 - 可以一次支持许多语言！
仅约1000行代码
除了STB_TRUETYPE，SDL和标准库，没有依赖关系
自动或手动内存管理
可以通过扩展一些课程来支持其他前端（例如DirectX/OpenGL/Vulkan/Whthing Apple推翻我们的喉咙）
公共领域

表现：

在英特尔I7-8750H上：

如果使用纹理（ renderTextToTexture / renderTextToObject ），则示例图像需要0.7ms渲染（〜1400 fps）。速度将是SDL2使您可以在纹理上翻转纹理的最大值。

如果直接呈现（ drawText ），则示例图像需要约5ms渲染（〜200 fps）（〜200 fps）

对于持续多个帧的文本，您应该使用renderTextToTexture或renderTextToObject缓存。

我怎么样？

使用这个库？
加载字体并绘制文本？
获取字体指标
使用后备字体（用于多仪支持）
获取文字的大小
将文字适应宽度
管理内存
缓存导致质地
以白色以外的颜色打印
到达用户单击的字符串中的位置
处理标签
预生化字形
编写自定义前端
从一个线程中生成文本并在另一个线程中渲染
锁定免费生产者消费者队列

格式化文字：

打印格式的文字？
负载粗体/斜体字体变体？
限制

非SDL前端：

BGFX

使用这个库？

这是一个仅标题库 - 无需构建系统

在任何标题中：

# include " path/to/sdlStbFont/sdlStbFont.h "

一个.cpp：

# define SDL_STB_FONT_IMPL
# include " path/to/sdlStbFont/sdlStbFont.h "

该库对STB_TRUETYPE具有依赖性。它将自动包含此。如果您不希望它自动包含它，请使用#define STB_TRUETYPE_INCLUDE_HANDLED ，并处理您自己的stb_truetype.h。

加载字体并绘制文本？

# define SDL_STB_FONT_IMPL
# include " sdlStbFont.h "

...

// Load font
char * ttfFontFromMemory = loadFontFileSomehow( " path/to/file.ttf " );

sdl_stb_font_cache fc;
fc.faceSize = 24 ; // Must be set before loadFont()!
fc.tabWidthInSpaces = 8 ; // Optional
fc.loadFont(ttfFontFromMemory);

...

// Setup renderer
SDL_Renderer * mSdlRenderer = SDL_CreateRenderer( mWindow , SDL_RENDERER_SOFTWARE, 0 );
fc.bindRenderer( mSdlRenderer ); // Must bind a renderer before generating any glyphs

...

// Main loop
SDL_SetRenderDrawColor ( mSdlRenderer , 125 , 125 , 125 , 255 );
SDL_RenderClear ( mSdlRenderer );
fc.drawText( 5 , 5 , " Hello world! " );
SDL_RenderPresent ( mSdlRenderer );

// fc will clean itself up when it falls out of scope
delete[] ttfFontFromMemory; // You must manually remove the char buff when done
// if you want auto management use fc.loadFontManaged(), which will transfer
// ownership of ttfFontFromMemory to fc and be freed when done.

您还可以获取渲染字符串的宽度和高度：

 fc.drawText(5, 5, widthOut, heightOut, "Hello world!");
// Draws "hello world" and sets widthOut and heightOut to the size of the string

获取字体指标

 class sdl_stb_font_cache {
...
public:
  int ascent;
  int descent;
  int lineGap;
  int baseline;
  int rowSize;
  int tabWidth;  // May be changed later
  float scale;
  float underlineThickness;
  float strikethroughThickness;
  float underlinePosition;
  float strikethroughPosition;
  // Must be set before loadFont() is called. Cannot be changed after
  int faceSize;      // Default is 20. All the parameters are calcualted based on this
  int tabWidthInSpaces;  // Default is 8, set this before loadFont(). Max 128. Sets tabWidth when font is loaded
...
  }

使用后备字体（用于多仪支持）

fc.loadFont(ttfFontFromMemory);
fc.addFont(someSecondFontFromMemory);
fc.addFont(someThirdFontFromMemory);
...
etc

首先加载的字体必须带有“ LoadFont”。

请注意，在调用任何绘图功能之前，必须加载所有字体。如果在第一字体中找不到字形，则将搜索第二个字体，等等。

获取文字的大小

 int w, h;
fc.getTextSize(w, h, " Text " ); // Get width and height at same time

// Also
h = fc.getTextHeight( " Text " ); // Faster, if only height is needed
w = fc.getTextWidth( " Text " ); // Internally just a wrapper for getTextSize
int nRows = fc.getTextRows( " Text n More text " ); // UTF8 safe, returns the number of rows of text - here it's 2
int numNewlines = fc.getNumNewLines

提示： drawText()返回绘制字符串或格式的文本对象的末端的X坐标。

将文字适应宽度

对于线条包装，请使用fc.breakString(stringIn, arrayOut, width)功能。这将字符串或格式的文本对象转换为字符串或格式的文本对象的向量每个小于宽度。这将尝试首先打破新线和空格，然后将单词拆分，如果该单词比指定的宽度更长。这是UTF8安全。

管理内存

手册管理：

 char * mFontData = loadFontFromFileSomehow( " path/to/file.ttf " );
fc.loadFont( mFontData );
// You will have to free mFontData when you are done with it
// fc does not copy mFontData internally
// using fc after free'ing mFontData will result in undefined behaviour

自动管理：

filep * file = openFile( " path/to/file " );
sttfont_memory mFontData ;
mFontData .alloc(file_size);
fread (file, & mFontData .data);
fc.loadFontManaged( mFontData );
// fc now owns mFontData's contents and will free it when fc is destroyed
// You can safely let mFontData fall out of scope
// Also addFontManaged is avaliable for adding fallback fonts

缓存导致质地

第一种方法：

 // creating
int RTw, RTh;
SDL_Texture * RT;
RT = fc.renderTextToTexture ( " Text " , &RTw, &RTh);

// Rendering
SDL_Rect r;
r.x = 5 ;
r.y = 5 ;
r.w = RTw;
r.h = RTh;
SDL_RenderCopy ( mSdlRenderer , RT , NULL , &r);

第二种方式（相同效果，但更干净）

 // creating
sdl_stb_prerendered_text prt;
prt. mRenderer = your__SDL_Render__instance;
fc.renderTextToObject(&prt, " Text " ); 
		
// Rendering
prt.draw(x, y);

// Rendering in colour & alpha
prt.drawWithColor(x, y, 255 , 185 , 85 , 255 );

// Cleanup
prt.freeTexture();

提示： prt.draw()返回对象末端的X坐标。

以白色以外的颜色打印

使用带有缓存纹理的SDL_SetTextureColorMod 。或使用sdl_stb_prerendered_text::drawWithColor 。

到达用户单击的字符串中的位置

使用getCaretPos(text, relativeMouseX, relativeMouseY)

请注意，这仅当前仅支持没有新线的字符串中的Carret查找 - 如果您使用多行字符串尝试此操作，则可能会返回不正确的值。

处理标签

TAB宽度由可变fc.tabWidth处理。选项卡之后的字符将与下一个标签位置对齐。

您可以在调用fc.loadFont(...)之前将fc.tabWidthInSpaces = X ，将fc.tabWidth自动设置为空间宽度的某个倍数。默认情况下，字体设置为宽度8个空间。较低的值对单义字体更好，较高的值对于非单调字体的字体更好。

编写自定义前端

该库由两个部分组成 - 字体处理后端（名为sttfont_* ）和SDL渲染前端（ sdl_stb_* ）。

为了使您自己的渲染前端扩展相关的sttfont_*类。有关详细信息，请参见SDL实现。它约200行的代码，您要做的就是取出特定的SDL特定内容并放入渲染器特定的内容中。在您的应用程序中，包括sttFont.h而不是sdlStbFont.h

预生化字形

您可以使用pregenGlyphs function ：

std::vector<sttfont_uint32_t_range> codepoint_ranges;
sttfont_uint32_t_range customRange;
customRange.start = 1337 ; customRange.end = 1444 ; // end is inclusive

sttfont_uint32_t_range::populateRangesLatin (codepoint_ranges); // add the Latin character set
sttfont_uint32_t_range::populateRangesCyrillic (codepoint_ranges); // add the Cyrillic character set
fc.pregenGlyphs(codepoint_ranges, 0 ); // generatess the glyps

如果您是在SDL中渲染的软件，则不需要，只会放慢启动。如果您使用的是使用纹理图集（例如BGFX）的自定义前端，则建议这样做。

从一个线程中生成文本并在另一个线程中渲染

使用producerConsumerExample.h 。有关工作示例，请参见producerConsumerExample.cpp 。

想法是，您实例化生产者和消费者线程之间共享的producer_consumer_font_cache对象。该对象的成员指向消费者使用的实际前端：

近活化：

producer_consumer_font_cache mPcCache ;
sdl_stb_font_cache mSdlFontCache ;


mPcCache .consumer_font_cache = & mSdlFontCache ;
	
sttfont_memory m;
m.data = &fontData[ 0 ];
m.size = fontData.size();
m.ownsData = false ;
	
mPcCache .faceSize = 24 ;		
mPcCache .loadFontManagedBoth(m); // Loads the font into both frontends

生产：

pcfc_prerendered_text prt;
mPcCache .renderTextToObject(&prt, " Prerendered text from Producer Thread! " ); // prt.handle now holds a handle
pcfc_handle h = mPcCache .pushText( 5 , 5 , " Hello World! " ); // use this instead of "drawText"
mPcCache .submitToConsumer(); // sends to consumer

消费：

 // <somehow send prt.handle and h to consumer thread>
// Suggestion: use a concurrentqueue (https://github.com/cameron314/concurrentqueue)
// and/or some kind of command buffer (https://github.com/SnapperTT/nanovg_command_buffer)
mPcCache .receiveFromProducer();
mPcCache .dispatchPrerenderJobs<sdl_stb_prerendered_text>(); // takes the prerended text and creates sdl_stb_prerended_text objects (invokes mPcCache.consumer_font_cache->renderTextToObject)

mPcCache .dispatchSinglePrerendered(prt.handle, 5 , 5 ); // actually draws the prerendered text
mPcCache .dispatchSingleText(h); // Renders "hello world" at 5,5

清理：

 // Cleanup - just let mPcCache fall out of scope
mPcCache .freeStoredPrerenderedText( true ); // deletes all prerendered text objects stored. true == also calls prt->freeTexture() for all prerendered text
										  // this is manual destruction as destroying a large number of objects can be expensive, esp. when you want to exit quickly
// Don't forget to delete mPcCache.consumer_font_cache if it was heap allocated
delete mPcCache .consumer_font_cache;

USERDATA：您可以和文本一起提交原始指针。

 mPcCahce.pushUserdata(void*); // producer
void* foo = mPcCahce.getUserdata(); // consumer

锁定免费生产者消费者队列

如果您不这样做，则使用std::mutex将状态从生产者传递到消费者。暂时缓冲区中只有一个插槽。您必须有一些机械设备才能停止，例如，生产商的运行速度比消费者快。

如果您想使用队列，我建议Moodycamel :: ReaderWriterQueue。您可以使用producer_consumer_font_cache启用它：

 #define SSF_CONCURRENT_QUEUE moodycamel::ReaderWriterQueue

进行更改的投票：

 if (mPcCache.receiveFromProducer()) { // wraps moodycamel::ReaderWriterQueue::try_dequeue()
	// have dequeued!
	}

清理（冲洗队列）

 while (mPcCache.receiveFromProducer()) {
	// pulls stuff from the queue until its empty
	delete mPcCache.getUserdata(); // if we're using heap allocated userdata here is how to clear it
	}

格式的文字

打印格式的文字？

示例格式

首先创建一个sttfont_formatted_text 。上面的示例是由以下示例创建的：

sttfont_formatted_text formattedText;
formattedText << sttfont_format::black << " Plain text "
<< sttfont_format:: bold << " bold text "
<< sttfont_format:: italic << " italic text n "
<< sttfont_format:: underline << sttfont_format::green << " underline text t "
<< sttfont_format::strikethrough << " strikethrough text n "
<< sttfont_format::red << sttfont_format:: bold << " red bold t "
<< sttfont_format:: bold << " not red bold t "
<< sttfont_format::red << " red not bold n "
<< sttfont_format:: bold << sttfont_format:: italic		<< sttfont_format::colour( 255 , 127 , 50 ) << " custom colour t "
<< sttfont_format:: bold << sttfont_format::strikethrough	<< sttfont_format::colour( 127 , 255 , 50 ) << " bold strikethrough n "
<< sttfont_format:: bold << sttfont_format:: underline		<< sttfont_format::colour(  0 , 50 , 200 ) << " bold underline t "
<< sttfont_format:: italic << sttfont_format::strikethrough	<< sttfont_format::colour( 255 , 255 , 50 ) << " italic strikethrough n "
<< sttfont_format:: italic << sttfont_format:: underline		<< sttfont_format::colour( 127 , 50 , 255 ) << " italic underline "

您可以将格式选项与<<运算符相结合。插入字符串后重置格式。

然后，您可以使用用于简单字符串（ drawText(x, y, formattedText)等）的相同功能渲染。这包括使用renderTextToObject呈现纹理。您可以使用一个简单的字符串可以使用相同命名函数（ getTextSize ， getNumRows ， getCaretPos等）来完成的所有操作）

负载粗体/斜体字体变体？

为了使BOLD/斜体变体工作，您必须加载字体的粗体/斜体变体。对于粗体+斜体，您必须加载字体的粗体+斜体变体！该库自动生成了下划线和罢工。

加载变体后，加载基本字体后，使用addFormatFont或addFormatFontManaged 。如果您关心这些字体在BOLD/ITALIC中可用，则也应该为后备字体（用于多语言支持）进行此操作。

fc.loadFontManaged(notoSans);	// First font - loadFont
	fc.addFormatFontManaged(sttfont_format::FORMAT_BOLD, notoSansBold);
	fc.addFormatFontManaged(sttfont_format::FORMAT_ITALIC, notoSansItalic);
	fc.addFormatFontManaged(sttfont_format::FORMAT_BOLD | sttfont_format::FORMAT_ITALIC, notoSansBoldItalic);
fc.addFontManaged(notoSansArmenian);	// Fallback fonts - addFont
	fc.addFormatFontManaged(sttfont_format::FORMAT_BOLD, notoSansArmenianBold);
	fc.addFormatFontManaged(sttfont_format::FORMAT_ITALIC, notoSansArmenianItalic);
	fc.addFormatFontManaged(sttfont_format::FORMAT_BOLD | sttfont_format::FORMAT_ITALIC, notoSansArmenianBoldItalic);