src/hb-ot-var.h

   1 /*
   2  * Copyright © 2017  Google, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Red Hat Author(s): Behdad Esfahbod
  25  */
  26
  27 #ifndef HB_OT_H_IN
  28 #error "Include <hb-ot.h> instead."
  29 #endif
  30
  31 #ifndef HB_OT_VAR_H
  32 #define HB_OT_VAR_H
  33
  34 #include "hb.h"
  35
  36 HB_BEGIN_DECLS
  37
  38
  39 #define HB_OT_TAG_VAR_AXIS_ITALIC       HB_TAG('i','t','a','l')
  40 #define HB_OT_TAG_VAR_AXIS_OPTICAL_SIZE HB_TAG('o','p','s','z')
  41 #define HB_OT_TAG_VAR_AXIS_SLANT        HB_TAG('s','l','n','t')
  42 #define HB_OT_TAG_VAR_AXIS_WIDTH        HB_TAG('w','d','t','h')
  43 #define HB_OT_TAG_VAR_AXIS_WEIGHT       HB_TAG('w','g','h','t')
  44
  45
  46 /*
  47  * fvar / avar
  48  */
  49
  50 HB_EXTERN hb_bool_t
  51 hb_ot_var_has_data (hb_face_t *face);
  52
  53
  54 /*
  55  * Variation axes.
  56  */
  57
  58
  59 HB_EXTERN unsigned int
  60 hb_ot_var_get_axis_count (hb_face_t *face);
  61
  62 /**
  63  * hb_ot_var_axis_flags_t:
  64  * @HB_OT_VAR_AXIS_FLAG_HIDDEN: The axis should not be exposed directly in user interfaces.
  65  *
  66  * Since: 2.2.0
  67  */
  68 typedef enum { /*< flags >*/
  69   HB_OT_VAR_AXIS_FLAG_HIDDEN    = 0x00000001u,
  70
  71   _HB_OT_VAR_AXIS_FLAG_MAX_VALUE= 0x7FFFFFFFu /*< skip >*/
  72 } hb_ot_var_axis_flags_t;
  73
  74 /**
  75  * hb_ot_var_axis_info_t:
  76  *
  77  * Since: 2.2.0
  78  */
  79 typedef struct hb_ot_var_axis_info_t
  80 {
  81   unsigned int                  axis_index;
  82   hb_tag_t                      tag;
  83   hb_ot_name_id_t               name_id;
  84   hb_ot_var_axis_flags_t        flags;
  85   float                         min_value;
  86   float                         default_value;
  87   float                         max_value;
  88   /*< private >*/
  89   unsigned int                  reserved;
  90 } hb_ot_var_axis_info_t;
  91
  92 HB_EXTERN unsigned int
  93 hb_ot_var_get_axis_infos (hb_face_t             *face,
  94                           unsigned int           start_offset,
  95                           unsigned int          *axes_count /* IN/OUT */,
  96                           hb_ot_var_axis_info_t *axes_array /* OUT */);
  97
  98 HB_EXTERN hb_bool_t
  99 hb_ot_var_find_axis_info (hb_face_t             *face,
 100                           hb_tag_t               axis_tag,
 101                           hb_ot_var_axis_info_t *axis_info);
 102
 103
 104 /*
 105  * Named instances.
 106  */
 107
 108 HB_EXTERN unsigned int
 109 hb_ot_var_get_named_instance_count (hb_face_t *face);
 110
 111 HB_EXTERN hb_ot_name_id_t
 112 hb_ot_var_named_instance_get_subfamily_name_id (hb_face_t   *face,
 113                                                 unsigned int instance_index);
 114
 115 HB_EXTERN hb_ot_name_id_t
 116 hb_ot_var_named_instance_get_postscript_name_id (hb_face_t  *face,
 117                                                 unsigned int instance_index);
 118
 119 HB_EXTERN unsigned int
 120 hb_ot_var_named_instance_get_design_coords (hb_face_t    *face,
 121                                             unsigned int  instance_index,
 122                                             unsigned int *coords_length, /* IN/OUT */
 123                                             float        *coords         /* OUT */);
 124
 125
 126 /*
 127  * Conversions.
 128  */
 129
 130 HB_EXTERN void
 131 hb_ot_var_normalize_variations (hb_face_t            *face,
 132                                 const hb_variation_t *variations, /* IN */
 133                                 unsigned int          variations_length,
 134                                 int                  *coords, /* OUT */
 135                                 unsigned int          coords_length);
 136
 137 HB_EXTERN void
 138 hb_ot_var_normalize_coords (hb_face_t    *face,
 139                             unsigned int coords_length,
 140                             const float *design_coords, /* IN */
 141                             int *normalized_coords /* OUT */);
 142
 143
 144 HB_END_DECLS
 145
 146 #endif /* HB_OT_VAR_H */