Changeset 110 for trunk/nv/gfx/texture_font.hh

Timestamp:

06/07/13 09:25:32 (12 years ago)

Author:

shark

Message:

• Doing a little documenting.

File:

• trunk/nv/gfx/texture_font.hh (modified) (2 diffs)

trunk/nv/gfx/texture_font.hh

@@ -18 +18 @@
         struct texture_glyph
         {
-                uint16 charcode;
-                glm::ivec2 size;
-                glm::ivec2 offset;
-                glm::vec2 advance;
-                glm::vec2 tl;
-                glm::vec2 br;
-                std::unordered_map< uint16, float > kerning;
+                uint16 charcode; ///< Character code value.
+                glm::ivec2 size; ///< Width and height of the glyph.
+                glm::ivec2 offset; ///< Offset of the glyph's position from the base line.
+                glm::vec2 advance; ///< Cursor advance distance.
+                glm::vec2 tl; ///< Top-left of the glyph's bounding box.
+                glm::vec2 br; ///< Bottom-right of the glyph's bounding box.
+                std::unordered_map< uint16, float > kerning; ///< Kerning space between other characters.
 
+                /**
+                 *Creates a new texture_glyph.
+                 */
                 texture_glyph();
-                float get_kerning( const uint16 charcode );
+
+                /**
+                 *Gets the kerning space between this character and the requested character.
+                 *
+                 *@param charcode The character to get the spacing for.
+                 *@returns The amount of space for kerning.
+                 */
+                float get_kerning( const uint16 charcode ); 
         };
 
@@ -40 +50 @@
                         void generate_kerning();
                 private:
-                        std::unordered_map< uint16, texture_glyph > m_glyphs;
-                        texture_atlas* m_atlas;
-                        std::string m_filename;
-                        float m_size;
-                        float m_height;
-                        float m_linegap;
-                        float m_ascender;
-                        float m_descender;
-                        bool m_hinting;
-                        bool m_filtering;
-                        uint8 m_lcd_weights[5];
-                        void* m_rlibrary;
-                        void* m_rface;
+                        std::unordered_map< uint16, texture_glyph > m_glyphs; ///< Hash table of glyphs for this font.
+                        texture_atlas* m_atlas; ///< Atlas Image object for this font.
+                        std::string m_filename; ///< Name of the file.
+                        float m_size; ///< Font size.
+                        float m_height; ///< Height of the font. (x-height?)
+                        float m_linegap; ///< Amount of space between lines.
+                        float m_ascender; ///< Height of ascender lines (lines extending above the glyph's x-height).
+                        float m_descender; ///< Height of descender lines (lines extending below the glyph's x-height).
+                        bool m_hinting; ///< Whether or not glyph hints are used.
+                        bool m_filtering; ///< Whether or not glyphs are color filtered for LCD displays.
+                        uint8 m_lcd_weights[5]; ///< Color filtering weights.
+                        void* m_rlibrary; ///< Pointer to the library.
+                        void* m_rface; ///< Pointer to the font face.
         };
 }