From 7b09710392d35fb55b52031d447a542d99fc6b4b Mon Sep 17 00:00:00 2001 From: Tavian Barnes Date: Tue, 19 Aug 2014 17:10:03 -0400 Subject: Modularize the libdimension codebase. --- libdimension/dimension/model/pigments.h | 66 +++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 libdimension/dimension/model/pigments.h (limited to 'libdimension/dimension/model/pigments.h') diff --git a/libdimension/dimension/model/pigments.h b/libdimension/dimension/model/pigments.h new file mode 100644 index 0000000..100016d --- /dev/null +++ b/libdimension/dimension/model/pigments.h @@ -0,0 +1,66 @@ +/************************************************************************* + * Copyright (C) 2009-2014 Tavian Barnes * + * * + * This file is part of The Dimension Library. * + * * + * The Dimension Library is free software; you can redistribute it and/ * + * or modify it under the terms of the GNU Lesser General Public License * + * as published by the Free Software Foundation; either version 3 of the * + * License, or (at your option) any later version. * + * * + * The Dimension Library is distributed in the hope that it will be * + * useful, but WITHOUT ANY WARRANTY; without even the implied warranty * + * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with this program. If not, see * + * . * + *************************************************************************/ + +/** + * @file + * Pre-defined pigments. + */ + +/** + * A solid color. + * @param[in] pool The memory pool to allocate from. + * @param[in] color The color of the pigment. + * @return A pigment with the color \p color everywhere. + */ +dmnsn_pigment *dmnsn_new_solid_pigment(dmnsn_pool *pool, dmnsn_tcolor color); + +/** + * An image map. The image (regardless of its real dimensions) is projected + * on the x-y plane in tesselating unit squares. + * @param[in] pool The memory pool to allocate from. + * @param[in] canvas The canvas holding the image. + * @return An image-mapped pigment. + */ +dmnsn_pigment *dmnsn_new_canvas_pigment(dmnsn_pool *pool, dmnsn_canvas *canvas); + +/** + * Pigment map flags. + */ +typedef enum dmnsn_pigment_map_flags { + DMNSN_PIGMENT_MAP_REGULAR, /**< Calculate linear color gradients. */ + DMNSN_PIGMENT_MAP_SRGB /**< Calculate sRGB color gradients. */ +} dmnsn_pigment_map_flags; + +/** + * Construct a pigment map. + * @param[in] pool The memory pool to allocate from. + * @return An empty pigment map. + */ +dmnsn_map *dmnsn_new_pigment_map(dmnsn_pool *pool); + +/** + * A pigment-mapped pigment. + * @param[in] pool The memory pool to allocate from. + * @param[in,out] pattern The pattern of the pigment. + * @param[in,out] map The pigment map to apply to the pattern. + * @param[in] flags Gradient flags + * @return A pigment mapping the pattern to other pigments. + */ +dmnsn_pigment *dmnsn_new_pigment_map_pigment(dmnsn_pool *pool, dmnsn_pattern *pattern, dmnsn_map *map, dmnsn_pigment_map_flags flags); -- cgit v1.2.3