harfbuzz/src/hb-ot-color.cc

184 lines
5.8 KiB
C++
Raw Normal View History

2016-04-25 18:20:57 +02:00
/*
* Copyright © 2016 Google, Inc.
* Copyright © 2018 Ebrahim Byagowi
2016-04-25 18:20:57 +02:00
*
* This is part of HarfBuzz, a text shaping library.
*
* Permission is hereby granted, without written agreement and without
* license or royalty fees, to use, copy, modify, and distribute this
* software and its documentation for any purpose, provided that the
* above copyright notice and the following two paragraphs appear in
* all copies of this software.
*
* IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
* DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
* ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
* IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
* THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
* ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
* PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
*
* Google Author(s): Sascha Brawer
*/
#include "hb-open-type-private.hh"
2018-02-28 10:49:40 +01:00
#include "hb-ot-colr-table.hh"
2016-04-25 18:20:57 +02:00
#include "hb-ot-cpal-table.hh"
#include "hb-ot.h"
#include <stdlib.h>
#include <string.h>
#include "hb-ot-layout-private.hh"
#include "hb-shaper-private.hh"
#if 0
2016-04-25 18:20:57 +02:00
HB_MARK_AS_FLAG_T (hb_ot_color_palette_flags_t)
//HB_SHAPER_DATA_ENSURE_DECLARE(ot, face) Hmm?
2016-04-25 18:20:57 +02:00
2018-02-28 10:49:40 +01:00
static inline const OT::COLR&
_get_colr (hb_face_t *face)
{
if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return OT::Null(OT::COLR);
hb_ot_layout_t * layout = hb_ot_layout_from_face (face);
return *(layout->colr.get ());
}
2016-04-25 18:20:57 +02:00
static inline const OT::CPAL&
_get_cpal (hb_face_t *face)
{
if (unlikely (!hb_ot_shaper_face_data_ensure (face))) return OT::Null(OT::CPAL);
2016-04-25 18:20:57 +02:00
hb_ot_layout_t * layout = hb_ot_layout_from_face (face);
return *(layout->cpal.get ());
2016-04-25 18:20:57 +02:00
}
/**
* hb_ot_color_get_palette_count:
* @face: a font face.
*
* Returns: the number of color palettes in @face, or zero if @face has
* no colors.
*
* Since: REPLACEME
2016-04-25 18:20:57 +02:00
*/
unsigned int
hb_ot_color_get_palette_count (hb_face_t *face)
{
const OT::CPAL& cpal = _get_cpal (face);
return cpal.get_palette_count ();
2016-04-25 18:20:57 +02:00
}
/**
* hb_ot_color_get_palette_name_id:
* @face: a font face.
* @palette: the index of the color palette whose name is being requested.
*
* Retrieves the name id of a color palette. For example, a color font can
* have themed palettes like "Spring", "Summer", "Fall", and "Winter".
*
* Returns: an identifier within @face's `name` table.
* If the requested palette has no name, or if @face has no colors,
* or if @palette is not between 0 and hb_ot_color_get_palette_count(),
* the result is 0xFFFF. The implementation does not check whether
* the returned palette name id is actually in @face's `name` table.
2016-04-25 18:20:57 +02:00
*
* Since: REPLACEME
2016-04-25 18:20:57 +02:00
*/
unsigned int
hb_ot_color_get_palette_name_id (hb_face_t *face, unsigned int palette)
{
const OT::CPAL& cpal = _get_cpal (face);
return cpal.get_palette_name_id (palette);
2016-04-25 18:20:57 +02:00
}
/**
* hb_ot_color_get_palette_flags:
* @face: a font face
* @palette: the index of the color palette whose flags are being requested
*
* Returns: the flags for the requested color palette. If @face has no colors,
* or if @palette is not between 0 and hb_ot_color_get_palette_count(),
* the result is #HB_OT_COLOR_PALETTE_FLAG_DEFAULT.
*
* Since: REPLACEME
2016-04-25 18:20:57 +02:00
*/
hb_ot_color_palette_flags_t
hb_ot_color_get_palette_flags (hb_face_t *face, unsigned int palette)
{
const OT::CPAL& cpal = _get_cpal(face);
return cpal.get_palette_flags (palette);
2016-04-25 18:20:57 +02:00
}
/**
* hb_ot_color_get_palette_colors:
* @face: a font face.
* @palette: the index of the color palette whose colors
* are being requested.
* @start_offset: the index of the first color being requested.
* @color_count: (inout) (optional): on input, how many colors
* can be maximally stored into the @colors array;
* on output, how many colors were actually stored.
* @colors: (array length=color_count) (optional):
2016-04-25 18:20:57 +02:00
* an array of #hb_ot_color_t records. After calling
* this function, @colors will be filled with
* the palette colors. If @colors is NULL, the function
* will just return the number of total colors
* without storing any actual colors; this can be used
* for allocating a buffer of suitable size before calling
* hb_ot_color_get_palette_colors() a second time.
*
* Retrieves the colors in a color palette.
*
* Returns: the total number of colors in the palette. All palettes in
* a font have the same number of colors. If @face has no colors, or if
* @palette is not between 0 and hb_ot_color_get_palette_count(),
* the result is zero.
*
* Since: REPLACEME
2016-04-25 18:20:57 +02:00
*/
unsigned int
hb_ot_color_get_palette_colors (hb_face_t *face,
unsigned int palette, /* default=0 */
unsigned int start_offset,
unsigned int *color_count /* IN/OUT */,
hb_ot_color_t *colors /* OUT */)
{
const OT::CPAL& cpal = _get_cpal(face);
if (unlikely (palette >= cpal.numPalettes))
2016-04-25 18:20:57 +02:00
{
if (color_count) *color_count = 0;
return 0;
}
const OT::ColorRecord* crec = &cpal.offsetFirstColorRecord (&cpal);
crec += cpal.colorRecordIndices[palette];
unsigned int num_results = 0;
if (likely (color_count && colors))
{
for (unsigned int i = start_offset;
i < cpal.numPaletteEntries && num_results < *color_count; ++i)
{
hb_ot_color_t* result = &colors[num_results];
result->red = crec[i].red;
result->green = crec[i].green;
result->blue = crec[i].blue;
result->alpha = crec[i].alpha;
++num_results;
}
}
if (likely (color_count)) *color_count = num_results;
return cpal.numPaletteEntries;
}
#endif