ui/gfx/paint_vector_icon.h

// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_GFX_PAINT_VECTOR_ICON_H_
#define UI_GFX_PAINT_VECTOR_ICON_H_

#include "base/component_export.h"
#include "base/memory/raw_ref.h"
#include "third_party/skia/include/core/SkColor.h"
#include "ui/gfx/color_palette.h"
#include "ui/gfx/image/image_skia.h"

namespace gfx {

class Canvas;
struct VectorIcon;

// Describes an instance of an icon: an icon definition and a set of drawing
// parameters.
struct COMPONENT_EXPORT(GFX) IconDescription {
  IconDescription(const IconDescription& other);

  // If |dip_size| is 0, the default size of |icon| will be used.
  // If |badge_icon| is null, the icon has no badge.
  IconDescription(const VectorIcon& icon,
                  int dip_size = 0,
                  SkColor color = gfx::kPlaceholderColor,
                  const VectorIcon* badge_icon = nullptr);

  ~IconDescription();

  const raw_ref<const VectorIcon> icon;
  int dip_size;
  SkColor color;
  const raw_ref<const VectorIcon> badge_icon;
};

// Draws a vector icon identified by |id| onto |canvas| at (0, 0). |color| is
// used as the fill. The size will come from the .icon file (the 1x version, if
// multiple versions exist).
COMPONENT_EXPORT(GFX)
void PaintVectorIcon(Canvas* canvas, const VectorIcon& icon, SkColor color);

// As above, with a specified size. |dip_size| is the length of a single edge
// of the square icon, in device independent pixels.
COMPONENT_EXPORT(GFX)
void PaintVectorIcon(Canvas* canvas,
                     const VectorIcon& icon,
                     int dip_size,
                     SkColor color);

// Creates an ImageSkia which will render the icon on demand.
// TODO(estade): update clients to use this version and remove the other
// CreateVectorIcon()s.
COMPONENT_EXPORT(GFX) ImageSkia CreateVectorIcon(const IconDescription& params);

// Creates an ImageSkia which will render the icon on demand. The size will come
// from the .icon file (the 1x version, if multiple versions exist).
COMPONENT_EXPORT(GFX)
ImageSkia CreateVectorIcon(const VectorIcon& icon, SkColor color);

// As above, but creates the image at the given size.
COMPONENT_EXPORT(GFX)
ImageSkia CreateVectorIcon(const VectorIcon& icon, int dip_size, SkColor color);

// As above, but also paints a badge defined by |badge_id| on top of the icon.
// The badge uses the same canvas size and default color as the icon.
COMPONENT_EXPORT(GFX)
ImageSkia CreateVectorIconWithBadge(const VectorIcon& icon,
                                    int dip_size,
                                    SkColor color,
                                    const VectorIcon& badge_icon);

#if defined(GFX_VECTOR_ICONS_UNSAFE) || defined(IS_GFX_IMPL)
// Takes a string of the format expected of .icon files and renders onto
// a canvas. This should only be used as a debugging aid and should never be
// used in production code.
COMPONENT_EXPORT(GFX)
ImageSkia CreateVectorIconFromSource(const std::string& source,
                                     int dip_size,
                                     SkColor color);
#endif

}  // namespace gfx

#endif  // UI_GFX_PAINT_VECTOR_ICON_H_