Render control feature: shader-level shadowbuffer bias
[blender.git] / source / blender / render / intern / include / shadbuf.h
1 /*
2  * shadbuf_ext.h
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34
35 #ifndef SHADBUF_EXT_H
36 #define SHADBUF_EXT_H
37
38 #include "render_types.h"
39
40 struct ObjectRen;
41
42 /**
43  * Calculates shadowbuffers for a vector of shadow-giving lamps
44  * @param lar The vector of lamps
45  */
46 void makeshadowbuf(struct Render *re, LampRen *lar);
47 void freeshadowbuf(struct LampRen *lar);
48
49 void threaded_makeshadowbufs(struct Render *re);
50
51 /**
52  * Determines the shadow factor for a face and lamp. There is some
53  * communication with global variables here.
54  * @returns The shadow factors: 1.0 for no shadow, 0.0 for complete
55  *          shadow.
56  * @param shb The shadowbuffer to find the shadow factor in.
57  * @param inp The inproduct between viewvector and ?
58  *
59  */
60 float testshadowbuf(struct ShadBuf *shb, float *rco, float *dxco, float *dyco, float inp, float mat_bias);      
61
62 /**
63  * Determines the shadow factor for lamp <lar>, between <p1>
64  * and <p2>. (Which CS?)
65  */
66 float shadow_halo(LampRen *lar, float *p1, float *p2);
67
68 /**
69  * Irregular shadowbuffer
70  */
71
72 struct MemArena;
73 struct APixstr;
74
75 void ISB_create(RenderPart *pa, struct APixstr *apixbuf);
76 void ISB_free(RenderPart *pa);
77 float ISB_getshadow(ShadeInput *shi, ShadBuf *shb);
78
79 /* data structures have to be accessible both in camview(x, y) as in lampview(x, y) */
80 /* since they're created per tile rendered, speed goes over memory requirements */
81
82
83 /* buffer samples, allocated in camera buffer and pointed to in lampbuffer nodes */
84 typedef struct ISBSample {
85         float zco[3];                   /* coordinate in lampview projection */
86         short *shadfac;                 /* initialized zero = full lighted */
87         int obi;                                /* object for face lookup */
88         int facenr;                             /* index in faces list */       
89 } ISBSample;
90
91 /* transparent version of buffer sample */
92 typedef struct ISBSampleA {
93         float zco[3];                           /* coordinate in lampview projection */
94         short *shadfac;                         /* NULL = full lighted */
95         int obi;                                        /* object for face lookup */
96         int facenr;                                     /* index in faces list */       
97         struct ISBSampleA *next;        /* in end, we want the first items to align with ISBSample */
98 } ISBSampleA;
99
100 /* used for transparent storage only */
101 typedef struct ISBShadfacA {
102         struct ISBShadfacA *next;
103         int obi;
104         int facenr;
105         float shadfac;
106 } ISBShadfacA;
107
108 /* What needs to be stored to evaluate shadow, for each thread in ShadBuf */
109 typedef struct ISBData {
110         short *shadfacs;                                /* simple storage for solid only */
111         ISBShadfacA **shadfaca;
112         struct MemArena *memarena;
113         int minx, miny, rectx, recty;   /* copy from part disprect */
114 } ISBData;
115
116 #endif /* SHADBUF_EXT_H */
117