2016-06-18 12:46:12 +00:00
|
|
|
/*************************************************************************/
|
|
|
|
/* dynamic_font.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 12:11:45 +00:00
|
|
|
/* https://godotengine.org */
|
2016-06-18 12:46:12 +00:00
|
|
|
/*************************************************************************/
|
2017-01-01 21:01:57 +00:00
|
|
|
/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
|
2017-04-07 22:45:00 +00:00
|
|
|
/* Copyright (c) 2014-2017 Godot Engine contributors (cf. AUTHORS.md) */
|
2016-06-18 12:46:12 +00:00
|
|
|
/* */
|
|
|
|
/* 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. */
|
|
|
|
/*************************************************************************/
|
2016-05-29 14:37:26 +00:00
|
|
|
#ifndef DYNAMIC_FONT_H
|
|
|
|
#define DYNAMIC_FONT_H
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2016-05-29 14:37:26 +00:00
|
|
|
#ifdef FREETYPE_ENABLED
|
2016-05-02 02:12:30 +00:00
|
|
|
#include "io/resource_loader.h"
|
2017-03-18 23:36:26 +00:00
|
|
|
#include "os/thread_safe.h"
|
|
|
|
#include "scene/resources/font.h"
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2016-05-29 14:37:26 +00:00
|
|
|
#include <ft2build.h>
|
|
|
|
#include FT_FREETYPE_H
|
|
|
|
|
2016-05-02 02:12:30 +00:00
|
|
|
class DynamicFontAtSize;
|
|
|
|
class DynamicFont;
|
|
|
|
|
|
|
|
class DynamicFontData : public Resource {
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
OBJ_TYPE(DynamicFontData, Resource);
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2016-08-02 14:00:32 +00:00
|
|
|
public:
|
2017-03-18 23:36:26 +00:00
|
|
|
struct CacheID {
|
2016-08-02 14:00:32 +00:00
|
|
|
|
|
|
|
int size;
|
|
|
|
bool mipmaps;
|
|
|
|
bool filter;
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
bool operator<(CacheID right) const;
|
|
|
|
CacheID() {
|
|
|
|
size = 16;
|
|
|
|
mipmaps = false;
|
|
|
|
filter = false;
|
|
|
|
}
|
2016-08-02 14:00:32 +00:00
|
|
|
};
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2016-08-02 14:00:32 +00:00
|
|
|
private:
|
2016-05-29 14:37:26 +00:00
|
|
|
const uint8_t *font_mem;
|
|
|
|
int font_mem_size;
|
|
|
|
bool force_autohinter;
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2016-05-29 14:37:26 +00:00
|
|
|
String font_path;
|
2017-03-18 23:36:26 +00:00
|
|
|
Map<CacheID, DynamicFontAtSize *> size_cache;
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2016-05-29 14:37:26 +00:00
|
|
|
friend class DynamicFontAtSize;
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
friend class DynamicFont;
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2016-08-02 14:00:32 +00:00
|
|
|
Ref<DynamicFontAtSize> _get_dynamic_font_at_size(CacheID p_cache);
|
2016-06-18 22:03:53 +00:00
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
protected:
|
2016-06-18 22:03:53 +00:00
|
|
|
static void _bind_methods();
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
public:
|
|
|
|
void set_font_ptr(const uint8_t *p_font_mem, int p_font_mem_size);
|
|
|
|
void set_font_path(const String &p_path);
|
2016-06-18 22:03:53 +00:00
|
|
|
String get_font_path() const;
|
2016-05-29 14:37:26 +00:00
|
|
|
void set_force_autohinter(bool p_force);
|
|
|
|
|
2016-05-02 02:12:30 +00:00
|
|
|
DynamicFontData();
|
|
|
|
~DynamicFontData();
|
|
|
|
};
|
|
|
|
|
|
|
|
class DynamicFontAtSize : public Reference {
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
OBJ_TYPE(DynamicFontAtSize, Reference)
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2016-05-29 14:37:26 +00:00
|
|
|
_THREAD_SAFE_CLASS_
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
FT_Library library; /* handle to library */
|
|
|
|
FT_Face face; /* handle to face object */
|
2016-05-29 14:37:26 +00:00
|
|
|
FT_StreamRec stream;
|
|
|
|
|
|
|
|
int ascent;
|
|
|
|
int descent;
|
|
|
|
int linegap;
|
2016-05-02 02:12:30 +00:00
|
|
|
int rect_margin;
|
|
|
|
|
2016-08-02 07:01:51 +00:00
|
|
|
uint32_t texture_flags;
|
|
|
|
|
2016-05-29 14:37:26 +00:00
|
|
|
bool valid;
|
|
|
|
|
2016-05-02 02:12:30 +00:00
|
|
|
struct CharTexture {
|
|
|
|
|
|
|
|
DVector<uint8_t> imgdata;
|
|
|
|
int texture_size;
|
|
|
|
Vector<int> offsets;
|
|
|
|
Ref<ImageTexture> texture;
|
|
|
|
};
|
|
|
|
|
|
|
|
Vector<CharTexture> textures;
|
|
|
|
|
|
|
|
struct Character {
|
|
|
|
|
2016-05-30 22:41:32 +00:00
|
|
|
bool found;
|
2016-05-02 02:12:30 +00:00
|
|
|
int texture_idx;
|
|
|
|
Rect2 rect;
|
|
|
|
float v_align;
|
|
|
|
float h_align;
|
|
|
|
float advance;
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
Character() {
|
|
|
|
texture_idx = 0;
|
|
|
|
v_align = 0;
|
|
|
|
}
|
2016-05-02 02:12:30 +00:00
|
|
|
};
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
static unsigned long _ft_stream_io(FT_Stream stream, unsigned long offset, unsigned char *buffer, unsigned long count);
|
|
|
|
static void _ft_stream_close(FT_Stream stream);
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
HashMap<CharType, Character> char_map;
|
2016-05-02 02:12:30 +00:00
|
|
|
|
|
|
|
_FORCE_INLINE_ void _update_char(CharType p_char);
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
friend class DynamicFontData;
|
2016-05-02 02:12:30 +00:00
|
|
|
Ref<DynamicFontData> font;
|
2016-08-02 14:00:32 +00:00
|
|
|
DynamicFontData::CacheID id;
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
static HashMap<String, Vector<uint8_t> > _fontdata;
|
2016-05-29 14:37:26 +00:00
|
|
|
Error _load();
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
protected:
|
2016-05-02 02:12:30 +00:00
|
|
|
public:
|
|
|
|
float get_height() const;
|
|
|
|
|
|
|
|
float get_ascent() const;
|
|
|
|
float get_descent() const;
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
Size2 get_char_size(CharType p_char, CharType p_next, const Vector<Ref<DynamicFontAtSize> > &p_fallbacks) const;
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
float draw_char(RID p_canvas_item, const Point2 &p_pos, CharType p_char, CharType p_next, const Color &p_modulate, const Vector<Ref<DynamicFontAtSize> > &p_fallbacks) const;
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2016-08-02 07:01:51 +00:00
|
|
|
void set_texture_flags(uint32_t p_flags);
|
2016-05-02 02:12:30 +00:00
|
|
|
|
|
|
|
DynamicFontAtSize();
|
|
|
|
~DynamicFontAtSize();
|
|
|
|
};
|
|
|
|
|
|
|
|
///////////////
|
|
|
|
|
|
|
|
class DynamicFont : public Font {
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
OBJ_TYPE(DynamicFont, Font);
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2016-08-02 10:05:20 +00:00
|
|
|
public:
|
2017-03-18 23:36:26 +00:00
|
|
|
enum SpacingType {
|
2016-08-02 10:05:20 +00:00
|
|
|
SPACING_TOP,
|
|
|
|
SPACING_BOTTOM,
|
|
|
|
SPACING_CHAR,
|
|
|
|
SPACING_SPACE
|
|
|
|
};
|
|
|
|
|
|
|
|
private:
|
2016-08-02 07:01:51 +00:00
|
|
|
Ref<DynamicFontData> data;
|
2016-05-02 02:12:30 +00:00
|
|
|
Ref<DynamicFontAtSize> data_at_size;
|
2016-05-30 22:41:32 +00:00
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
Vector<Ref<DynamicFontData> > fallbacks;
|
|
|
|
Vector<Ref<DynamicFontAtSize> > fallback_data_at_size;
|
2016-05-30 22:41:32 +00:00
|
|
|
|
2016-08-02 14:00:32 +00:00
|
|
|
DynamicFontData::CacheID cache_id;
|
2016-05-29 14:37:26 +00:00
|
|
|
bool valid;
|
2016-08-02 10:05:20 +00:00
|
|
|
int spacing_top;
|
|
|
|
int spacing_bottom;
|
|
|
|
int spacing_char;
|
|
|
|
int spacing_space;
|
2016-05-02 02:12:30 +00:00
|
|
|
|
|
|
|
protected:
|
2016-08-02 14:00:32 +00:00
|
|
|
void _reload_cache();
|
2016-08-02 07:01:51 +00:00
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
bool _set(const StringName &p_name, const Variant &p_value);
|
|
|
|
bool _get(const StringName &p_name, Variant &r_ret) const;
|
|
|
|
void _get_property_list(List<PropertyInfo> *p_list) const;
|
2016-05-30 22:41:32 +00:00
|
|
|
|
2016-05-02 02:12:30 +00:00
|
|
|
static void _bind_methods();
|
|
|
|
|
|
|
|
public:
|
2017-03-18 23:36:26 +00:00
|
|
|
void set_font_data(const Ref<DynamicFontData> &p_data);
|
2016-05-02 02:12:30 +00:00
|
|
|
Ref<DynamicFontData> get_font_data() const;
|
|
|
|
|
|
|
|
void set_size(int p_size);
|
|
|
|
int get_size() const;
|
|
|
|
|
2016-08-02 07:01:51 +00:00
|
|
|
bool get_use_mipmaps() const;
|
|
|
|
void set_use_mipmaps(bool p_enable);
|
|
|
|
|
|
|
|
bool get_use_filter() const;
|
|
|
|
void set_use_filter(bool p_enable);
|
2016-05-30 22:41:32 +00:00
|
|
|
|
2016-08-02 10:05:20 +00:00
|
|
|
int get_spacing(int p_type) const;
|
|
|
|
void set_spacing(int p_type, int p_value);
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
void add_fallback(const Ref<DynamicFontData> &p_data);
|
|
|
|
void set_fallback(int p_idx, const Ref<DynamicFontData> &p_data);
|
2016-05-30 22:41:32 +00:00
|
|
|
int get_fallback_count() const;
|
|
|
|
Ref<DynamicFontData> get_fallback(int p_idx) const;
|
|
|
|
void remove_fallback(int p_idx);
|
|
|
|
|
2016-05-02 02:12:30 +00:00
|
|
|
virtual float get_height() const;
|
|
|
|
|
|
|
|
virtual float get_ascent() const;
|
|
|
|
virtual float get_descent() const;
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
virtual Size2 get_char_size(CharType p_char, CharType p_next = 0) const;
|
2016-05-02 02:12:30 +00:00
|
|
|
|
|
|
|
virtual bool is_distance_field_hint() const;
|
|
|
|
|
2017-03-18 23:36:26 +00:00
|
|
|
virtual float draw_char(RID p_canvas_item, const Point2 &p_pos, CharType p_char, CharType p_next = 0, const Color &p_modulate = Color(1, 1, 1)) const;
|
2016-05-02 02:12:30 +00:00
|
|
|
|
|
|
|
DynamicFont();
|
|
|
|
~DynamicFont();
|
|
|
|
};
|
|
|
|
|
|
|
|
/////////////
|
|
|
|
|
|
|
|
class ResourceFormatLoaderDynamicFont : public ResourceFormatLoader {
|
|
|
|
public:
|
2017-03-18 23:36:26 +00:00
|
|
|
virtual RES load(const String &p_path, const String &p_original_path = "", Error *r_error = NULL);
|
2016-05-02 02:12:30 +00:00
|
|
|
virtual void get_recognized_extensions(List<String> *p_extensions) const;
|
2017-03-18 23:36:26 +00:00
|
|
|
virtual bool handles_type(const String &p_type) const;
|
2016-05-02 02:12:30 +00:00
|
|
|
virtual String get_resource_type(const String &p_path) const;
|
|
|
|
};
|
|
|
|
|
2016-05-29 14:37:26 +00:00
|
|
|
#endif
|
2016-05-02 02:12:30 +00:00
|
|
|
|
2016-05-29 14:37:26 +00:00
|
|
|
#endif
|