From 97c10ba7d73ed0e7505ad2f804fe79aec4f55239 Mon Sep 17 00:00:00 2001 From: Tavian Barnes Date: Thu, 2 Dec 2010 17:28:08 -0500 Subject: Split pigments and finishes into their own headers/sources. --- libdimension/dimension/pigment.h | 83 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 libdimension/dimension/pigment.h (limited to 'libdimension/dimension/pigment.h') diff --git a/libdimension/dimension/pigment.h b/libdimension/dimension/pigment.h new file mode 100644 index 0000000..946cf5b --- /dev/null +++ b/libdimension/dimension/pigment.h @@ -0,0 +1,83 @@ +/************************************************************************* + * Copyright (C) 2009-2010 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 + * Object pigments. + */ + +#ifndef DIMENSION_PIGMENT_H +#define DIMENSION_PIGMENT_H + +/* Forward-declare dmnsn_pigment */ +typedef struct dmnsn_pigment dmnsn_pigment; + +/** + * Pigment callback. + * @param[in] pigment The pigment itself. + * @param[in] v The point to color. + * @return The color of the pigment at \p v. + */ +typedef dmnsn_color dmnsn_pigment_fn(const dmnsn_pigment *pigment, + dmnsn_vector v); + +/** + * Pigment initializer callback. + * @param[in,out] pigment The pigment to initialize. + */ +typedef void dmnsn_pigment_initialize_fn(dmnsn_pigment *pigment); + +/** A pigment. */ +struct dmnsn_pigment { + dmnsn_pigment_fn *pigment_fn; /**< The pigment callback. */ + dmnsn_pigment_initialize_fn *initialize_fn; /**< The initializer callback. */ + dmnsn_free_fn *free_fn; /**< The destructor callback. */ + + dmnsn_matrix trans; /**< Transformation matrix. */ + dmnsn_matrix trans_inv; /**< The inverse of the transformation matrix. */ + + /** Quick color -- used for low-quality renders. */ + dmnsn_color quick_color; + + /** Generic pointer. */ + void *ptr; +}; + +/** + * Allocate a new dummy pigment. + * @return The allocated pigment. + */ +dmnsn_pigment *dmnsn_new_pigment(void); + +/** + * Delete a pigment. + * @param[in,out] pigment The pigment to delete. + */ +void dmnsn_delete_pigment(dmnsn_pigment *pigment); + +/** + * Initialize a pigment. Pigments should not be used before being initialized, + * but should not be modified after being initialized. Pigments are generally + * initialized for you. + * @param[in,out] pigment The pigment to initialize. + */ +void dmnsn_initialize_pigment(dmnsn_pigment *pigment); + +#endif /* DIMENSION_PIGMENT_H */ -- cgit v1.2.3