1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/*
* fractal_rendering_parameters.h -- part of FractalNow
*
* Copyright (c) 2011 Marc Pegon <pe.marc@free.fr>
*
* This program 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.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/**
* \file fractal_rendering_parameters.h
* \brief Header file related to rendering parameters.
* \author Marc Pegon
*/
#ifndef __FRACTAL_RENDERING_PARAMETERS_H__
#define __FRACTAL_RENDERING_PARAMETERS_H__
#include "color.h"
#include "gradient.h"
#include "float_precision.h"
#include "fractal_addend_function.h"
#include "fractal_coloring.h"
#include "fractal_iteration_count.h"
#include "fractal_transfer_function.h"
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* \struct RenderingParameters
* \brief Structure for handling fractal rendering parameters.
*/
/**
* \typedef RenderingParameters
* \brief Convenient typedef for struct RenderingParameters.
*/
typedef struct RenderingParameters {
uint_fast8_t bytesPerComponent;
/*!< Bytes per component matching gradient colors'.*/
Color spaceColor;
/*!< Fractal space color.*/
IterationCount iterationCount;
/*!< Fractal iteration count enum value.*/
ColoringMethod coloringMethod;
/*!< Fractal coloring method.*/
AddendFunction addendFunction;
/*!< Fractal addend function (used only for average coloring method).*/
uint_fast32_t stripeDensity;
/*!< Stripe density (used only for AF_STRIPE addend function).*/
InterpolationMethod interpolationMethod;
/*!< Fractal interpolation method (used only for average coloring method).*/
TransferFunction transferFunction;
/*!< Fractal transfer function enum value (to make the values fit the gradient better).*/
TransferFunctionPtr transferFunctionPtr;
/*!< Transfer function ptr.*/
double multiplier;
/*!< Value with which fractal values will be multiplied (to make the values fit the gradient better).*/
double offset;
/*!< Offset for mapping value to gradient.*/
Gradient gradient;
/*!< Gradient for mapping float values to colors.*/
/* For internal use.*/
double realMultiplier;
/*!< Real multiplier (scaled according to gradient size).*/
double realOffset;
/*!< Real offset (scaled according to gradient size).*/
} RenderingParameters;
/**
* \fn void InitRenderingParameters(RenderingParameters *param, uint_fast8_t bytesPerComponent, Color spaceColor, IterationCount iterationCount, ColoringMethod coloringMethod, AddendFunction addendFunction, uint_fast32_t stripeDensity, InterpolationMethod interpolationMethod, TransferFunction transferFunction, double multiplier, double offset, Gradient gradient)
* \brief Initialize rendering parameters.
*
* Bytes per component *must* agree with space color and gradient colors :
* this is *not* checked by the function.\n
* Gradient will be owned by rendering parameters, and free'd when
* rendering parameters are free'd.
*
* \param param Pointer to structure to initialize.
* \param bytesPerComponent Bytes per component for colors of rendering.
* \param spaceColor The color for fractal space.
* \param iterationCount Fractal iteration count.
* \param coloringMethod Fractal coloring method.
* \param addendFunction Fractal addend function (used only for average coloring method).
* \param stripeDensity Stripe density (used only for AF_STRIPE addend function).
* \param interpolationMethod Fractal interpolation method (used only for average coloring method).
* \param transferFunction Fractal transfer function (to make the values fit the gradient better).
* \param multiplier Value with which fractal values will be multiplied (to make the values fit the gradient better).
* \param offset Offset for mapping value to gradient.
* \param gradient Gradient for mapping float values to colors.
*/
void InitRenderingParameters(RenderingParameters *param, uint_fast8_t bytesPerComponent, Color spaceColor,
IterationCount iterationCount, ColoringMethod coloringMethod,
AddendFunction addendFunction, uint_fast32_t stripeDensity,
InterpolationMethod interpolationMethod, TransferFunction transferFunction,
double multiplier, double offset, Gradient gradient);
/**
* \fn RenderingParameters CopyRenderingParameters(const RenderingParameters *render)
* \brief Copy rendering parameters.
*
* \param render Pointer to rendering parameters to copy.
* \return Copy of rendering parameters.
*/
RenderingParameters CopyRenderingParameters(const RenderingParameters *param);
/**
* \fn void ResetGradient(RenderingParameters *param, Gradient gradient)
* \brief Reset gradient.
*
* Gradient will be owned by rendering parameters, and will be free'd
* when rendering parameters are free'd.
*
* \param param Rendering parameters to be changed.
* \param gradient New Gradient.
*/
void ResetGradient(RenderingParameters *param, Gradient gradient);
/**
* \fn int isSupportedRenderingFile(const char *fileName)
* \brief Check whether a file is a supported rendering file.
*
* \param fileName File name.
* \return 1 if file is a supported rendering file, 0 otherwise.
*/
int isSupportedRenderingFile(const char *fileName);
/**
* \fn int ReadRenderingFileBody(RenderingParameters *param, const char *fileName, FILE *file, const char *format)
* \brief Read fractal rendering parameters from rendering file body.
*
* The body of a rendering file is everything that comes after
* the format version.\n
* fileName is used only for error messages.\n
* This function should only be used internally by the library.
*
* \param param Pointer to the rendering parameters structure to create.
* \param fileName Rendering file name.
* \param file Pointer to opened file, positioned at the beginning of the body.
* \param format Rendering file format.
* \return 0 in case of success, 1 in case of failure.
*/
int ReadRenderingFileBody(RenderingParameters *param, const char *fileName,
FILE *file, const char *format);
/**
* \fn int ReadRenderingFile(RenderingParameters *param, const char *fileName)
* \brief Read and parse fractal rendering parameters file.
*
* \param param Pointer to the structure to store rendering parameters.
* \param fileName Rendering file name.
* \return 0 in case of success, 1 in case of failure.
*/
int ReadRenderingFile(RenderingParameters *param, const char *fileName);
/**
* \fn int WriteRenderingFileBody(const RenderingParameters *param, const char *fileName, FILE *file, const char *format)
* \brief Write rendering parameters into file.
*
* The body of a rendering file is everything that comes after
* the format version.\n
* fileName is used only for error messages.\n
* This function should only be used internally by the library.
*
* \param param Rendering parameters to write.
* \param fileName Rendering file name.
* \param file Pointer to opened file, positioned at the beginning of the body.
* \param format Rendering file format.
* \return 0 in case of success, 1 in case of failure.
*/
int WriteRenderingFileBody(const RenderingParameters *param, const char *fileName,
FILE *file, const char *format);
/**
* \fn int WriteRenderingFile(const RenderingParameters *param, const char *fileName)
* \brief Write rendering parameters into file.
*
* \param param Rendering parameters to write.
* \param fileName Rendering file name.
* \return 0 in case of success, 1 in case of failure.
*/
int WriteRenderingFile(const RenderingParameters *param, const char *fileName);
/**
* \fn void FreeRenderingParameters(RenderingParameters param)
* \brief Free a RenderingParameters structure.
*
* \param param RenderingParameters structure to be freed.
*/
void FreeRenderingParameters(RenderingParameters param);
#ifdef __cplusplus
}
#endif
#endif
|
