copy of docs from 2.4x for python modules that have been kept
[blender-staging.git] / source / blender / render / intern / include / strand.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: none of this file.
24  *
25  * Contributor(s): Brecht Van Lommel.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef STRAND_H
31 #define STRAND_H 
32
33 struct StrandVert;
34 struct StrandRen;
35 struct StrandBuffer;
36 struct ShadeSample;
37 struct StrandPart;
38 struct Render;
39 struct RenderPart;
40 struct RenderBuckets;
41 struct RenderPrimitiveIterator;
42 struct ZSpan;
43 struct ObjectInstanceRen;
44 struct StrandSurface;
45 struct DerivedMesh;
46 struct ObjectRen;
47
48 typedef struct StrandPoint {
49         /* position within segment */
50         float t;
51
52         /* camera space */
53         float co[3];
54         float nor[3];
55         float tan[3];
56         float strandco;
57         float width;
58
59         /* derivatives */
60         float dtco[3], dsco[3];
61         float dtstrandco;
62
63         /* outer points */
64         float co1[3], co2[3];
65         float hoco1[4], hoco2[4];
66         float zco1[3], zco2[3];
67         int clip1, clip2;
68
69         /* screen space */
70         float hoco[4];
71         float x, y;
72
73         /* simplification */
74         float alpha;
75 } StrandPoint;
76
77 typedef struct StrandSegment {
78         struct StrandVert *v[4];
79         struct StrandRen *strand;
80         struct StrandBuffer *buffer;
81         struct ObjectInstanceRen *obi;
82         float sqadaptcos;
83
84         StrandPoint point1, point2;
85         int shaded;
86 } StrandSegment;
87
88 struct StrandShadeCache;
89 typedef struct StrandShadeCache StrandShadeCache;
90
91 void strand_eval_point(StrandSegment *sseg, StrandPoint *spoint);
92 void render_strand_segment(struct Render *re, float winmat[][4], struct StrandPart *spart, struct ZSpan *zspan, int totzspan, StrandSegment *sseg);
93 void strand_minmax(struct StrandRen *strand, float *min, float *max);
94
95 struct StrandSurface *cache_strand_surface(struct Render *re, struct ObjectRen *obr, struct DerivedMesh *dm, float mat[][4], int timeoffset);
96 void free_strand_surface(struct Render *re);
97
98 struct StrandShadeCache *strand_shade_cache_create(void);
99 void strand_shade_cache_free(struct StrandShadeCache *cache);
100 void strand_shade_segment(struct Render *re, struct StrandShadeCache *cache, struct StrandSegment *sseg, struct ShadeSample *ssamp, float t, float s, int addpassflag);
101 void strand_shade_unref(struct StrandShadeCache *cache, struct StrandVert *svert);
102
103 struct RenderBuckets *init_buckets(struct Render *re);
104 void add_buckets_primitive(struct RenderBuckets *buckets, float *min, float *max, void *prim);
105 void free_buckets(struct RenderBuckets *buckets);
106 void project_hoco_to_bucket(struct RenderBuckets *buckets, float *hoco, float *bucketco);
107
108 struct RenderPrimitiveIterator *init_primitive_iterator(struct Render *re, struct RenderBuckets *buckets, struct RenderPart *pa);
109 void *next_primitive_iterator(struct RenderPrimitiveIterator *iter);
110 void free_primitive_iterator(struct RenderPrimitiveIterator *iter);
111
112 #endif
113