2011-01-06 Zhenyao Mo <zmo@google.com>
[WebKit-https.git] / WebCore / html / canvas / WebGLTexture.cpp
1 /*
2  * Copyright (C) 2009 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27
28 #if ENABLE(3D_CANVAS)
29
30 #include "WebGLTexture.h"
31
32 #include "WebGLFramebuffer.h"
33 #include "WebGLRenderingContext.h"
34
35 namespace WebCore {
36     
37 PassRefPtr<WebGLTexture> WebGLTexture::create(WebGLRenderingContext* ctx)
38 {
39     return adoptRef(new WebGLTexture(ctx));
40 }
41
42 WebGLTexture::WebGLTexture(WebGLRenderingContext* ctx)
43     : WebGLObject(ctx)
44     , m_target(0)
45     , m_minFilter(GraphicsContext3D::NEAREST_MIPMAP_LINEAR)
46     , m_magFilter(GraphicsContext3D::LINEAR)
47     , m_wrapS(GraphicsContext3D::REPEAT)
48     , m_wrapT(GraphicsContext3D::REPEAT)
49     , m_isNPOT(false)
50     , m_isComplete(false)
51     , m_needToUseBlackTexture(false)
52 {
53     setObject(context()->graphicsContext3D()->createTexture());
54 }
55
56 void WebGLTexture::setTarget(unsigned long target, int maxLevel)
57 {
58     if (!object())
59         return;
60     // Target is finalized the first time bindTexture() is called.
61     if (m_target)
62         return;
63     switch (target) {
64     case GraphicsContext3D::TEXTURE_2D:
65         m_target = target;
66         m_info.resize(1);
67         m_info[0].resize(maxLevel);
68         break;
69     case GraphicsContext3D::TEXTURE_CUBE_MAP:
70         m_target = target;
71         m_info.resize(6);
72         for (int ii = 0; ii < 6; ++ii)
73             m_info[ii].resize(maxLevel);
74         break;
75     }
76 }
77
78 void WebGLTexture::setParameteri(unsigned long pname, int param)
79 {
80     if (!object() || !m_target)
81         return;
82     switch (pname) {
83     case GraphicsContext3D::TEXTURE_MIN_FILTER:
84         switch (param) {
85         case GraphicsContext3D::NEAREST:
86         case GraphicsContext3D::LINEAR:
87         case GraphicsContext3D::NEAREST_MIPMAP_NEAREST:
88         case GraphicsContext3D::LINEAR_MIPMAP_NEAREST:
89         case GraphicsContext3D::NEAREST_MIPMAP_LINEAR:
90         case GraphicsContext3D::LINEAR_MIPMAP_LINEAR:
91             m_minFilter = param;
92             break;
93         }
94         break;
95     case GraphicsContext3D::TEXTURE_MAG_FILTER:
96         switch (param) {
97         case GraphicsContext3D::NEAREST:
98         case GraphicsContext3D::LINEAR:
99             m_magFilter = param;
100             break;
101         }
102         break;
103     case GraphicsContext3D::TEXTURE_WRAP_S:
104         switch (param) {
105         case GraphicsContext3D::CLAMP_TO_EDGE:
106         case GraphicsContext3D::MIRRORED_REPEAT:
107         case GraphicsContext3D::REPEAT:
108             m_wrapS = param;
109             break;
110         }
111         break;
112     case GraphicsContext3D::TEXTURE_WRAP_T:
113         switch (param) {
114         case GraphicsContext3D::CLAMP_TO_EDGE:
115         case GraphicsContext3D::MIRRORED_REPEAT:
116         case GraphicsContext3D::REPEAT:
117             m_wrapT = param;
118             break;
119         }
120         break;
121     default:
122         return;
123     }
124     update();
125 }
126
127 void WebGLTexture::setParameterf(unsigned long pname, float param)
128 {
129     if (!object() || !m_target)
130         return;
131     int iparam = static_cast<int>(param);
132     setParameteri(pname, iparam);
133 }
134
135 void WebGLTexture::setLevelInfo(unsigned long target, int level, unsigned long internalFormat, int width, int height, unsigned long type)
136 {
137     if (!object() || !m_target)
138         return;
139     // We assume level, internalFormat, width, height, and type have all been
140     // validated already.
141     int index = mapTargetToIndex(target);
142     if (index < 0)
143         return;
144     m_info[index][level].setInfo(internalFormat, width, height, type);
145     update();
146 }
147
148 void WebGLTexture::generateMipmapLevelInfo()
149 {
150     if (!object() || !m_target)
151         return;
152     if (!canGenerateMipmaps())
153         return;
154     if (!m_isComplete) {
155         for (size_t ii = 0; ii < m_info.size(); ++ii) {
156             const LevelInfo& info0 = m_info[ii][0];
157             int width = info0.width;
158             int height = info0.height;
159             int levelCount = computeLevelCount(width, height);
160             for (int level = 1; level < levelCount; ++level) {
161                 width = std::max(1, width >> 1);
162                 height = std::max(1, height >> 1);
163                 LevelInfo& info = m_info[ii][level];
164                 info.setInfo(info0.internalFormat, width, height, info0.type);
165             }
166         }
167         m_isComplete = true;
168     }
169     m_needToUseBlackTexture = false;
170 }
171
172 unsigned long WebGLTexture::getInternalFormat(unsigned long target, int level) const
173 {
174     const LevelInfo* info = getLevelInfo(target, level);
175     if (!info)
176         return 0;
177     return info->internalFormat;
178 }
179
180 unsigned long WebGLTexture::getType(unsigned long target, int level) const
181 {
182     const LevelInfo* info = getLevelInfo(target, level);
183     if (!info)
184         return 0;
185     return info->type;
186 }
187
188 int WebGLTexture::getWidth(unsigned long target, int level) const
189 {
190     const LevelInfo* info = getLevelInfo(target, level);
191     if (!info)
192         return 0;
193     return info->width;
194 }
195
196 int WebGLTexture::getHeight(unsigned long target, int level) const
197 {
198     const LevelInfo* info = getLevelInfo(target, level);
199     if (!info)
200         return 0;
201     return info->height;
202 }
203
204 bool WebGLTexture::isNPOT(unsigned width, unsigned height)
205 {
206     if (!width || !height)
207         return false;
208     if ((width & (width - 1)) || (height & (height - 1)))
209         return true;
210     return false;
211 }
212
213 bool WebGLTexture::isNPOT() const
214 {
215     if (!object())
216         return false;
217     return m_isNPOT;
218 }
219
220 bool WebGLTexture::needToUseBlackTexture() const
221 {
222     if (!object())
223         return false;
224     return m_needToUseBlackTexture;
225 }
226
227 void WebGLTexture::deleteObjectImpl(Platform3DObject object)
228 {
229     context()->graphicsContext3D()->deleteTexture(object);
230 }
231
232 int WebGLTexture::mapTargetToIndex(unsigned long target) const
233 {
234     if (m_target == GraphicsContext3D::TEXTURE_2D) {
235         if (target == GraphicsContext3D::TEXTURE_2D)
236             return 0;
237     } else if (m_target == GraphicsContext3D::TEXTURE_CUBE_MAP) {
238         switch (target) {
239         case GraphicsContext3D::TEXTURE_CUBE_MAP_POSITIVE_X:
240             return 0;
241         case GraphicsContext3D::TEXTURE_CUBE_MAP_NEGATIVE_X:
242             return 1;
243         case GraphicsContext3D::TEXTURE_CUBE_MAP_POSITIVE_Y:
244             return 2;
245         case GraphicsContext3D::TEXTURE_CUBE_MAP_NEGATIVE_Y:
246             return 3;
247         case GraphicsContext3D::TEXTURE_CUBE_MAP_POSITIVE_Z:
248             return 4;
249         case GraphicsContext3D::TEXTURE_CUBE_MAP_NEGATIVE_Z:
250             return 5;
251         }
252     }
253     return -1;
254 }
255
256 bool WebGLTexture::canGenerateMipmaps()
257 {
258     if (isNPOT())
259         return false;
260     const LevelInfo& first = m_info[0][0];
261     for (size_t ii = 0; ii < m_info.size(); ++ii) {
262         const LevelInfo& info = m_info[ii][0];
263         if (!info.valid
264             || info.width != first.width || info.height != first.height
265             || info.internalFormat != first.internalFormat || info.type != first.type)
266             return false;
267     }
268     return true;
269 }
270
271 int WebGLTexture::computeLevelCount(int width, int height)
272 {
273     // return 1 + log2Floor(std::max(width, height));
274     int n = std::max(width, height);
275     if (n <= 0)
276         return 0;
277     int log = 0;
278     int value = n;
279     for (int ii = 4; ii >= 0; --ii) {
280         int shift = (1 << ii);
281         int x = (value >> shift);
282         if (x) {
283             value = x;
284             log += shift;
285         }
286     }
287     ASSERT(value == 1);
288     return log + 1;
289 }
290
291 void WebGLTexture::update()
292 {
293     m_isNPOT = false;
294     for (size_t ii = 0; ii < m_info.size(); ++ii) {
295         if (isNPOT(m_info[ii][0].width, m_info[ii][0].height)) {
296             m_isNPOT = true;
297             break;
298         }
299     }
300     m_isComplete = true;
301     const LevelInfo& first = m_info[0][0];
302     int levelCount = computeLevelCount(first.width, first.height);
303     if (levelCount < 1)
304         m_isComplete = false;
305     else {
306         for (size_t ii = 0; ii < m_info.size() && m_isComplete; ++ii) {
307             const LevelInfo& info0 = m_info[ii][0];
308             if (!info0.valid
309                 || info0.width != first.width || info0.height != first.height
310                 || info0.internalFormat != first.internalFormat || info0.type != first.type) {
311                 m_isComplete = false;
312                 break;
313             }
314             int width = info0.width;
315             int height = info0.height;
316             for (int level = 1; level < levelCount; ++level) {
317                 width = std::max(1, width >> 1);
318                 height = std::max(1, height >> 1);
319                 const LevelInfo& info = m_info[ii][level];
320                 if (!info.valid
321                     || info.width != width || info.height != height
322                     || info.internalFormat != info0.internalFormat || info.type != info0.type) {
323                     m_isComplete = false;
324                     break;
325                 }
326
327             }
328         }
329     }
330
331     m_needToUseBlackTexture = false;
332     // NPOT
333     if (m_isNPOT && ((m_minFilter != GraphicsContext3D::NEAREST && m_minFilter != GraphicsContext3D::LINEAR)
334                      || m_wrapS != GraphicsContext3D::CLAMP_TO_EDGE || m_wrapT != GraphicsContext3D::CLAMP_TO_EDGE))
335         m_needToUseBlackTexture = true;
336     // Completeness
337     if (!m_isComplete && m_minFilter != GraphicsContext3D::NEAREST && m_minFilter != GraphicsContext3D::LINEAR)
338         m_needToUseBlackTexture = true;
339 }
340
341 const WebGLTexture::LevelInfo* WebGLTexture::getLevelInfo(unsigned long target, int level) const
342 {
343     if (!object() || !m_target)
344         return 0;
345     int targetIndex = mapTargetToIndex(target);
346     if (targetIndex < 0 || targetIndex >= static_cast<int>(m_info.size()))
347         return 0;
348     if (level < 0 || level >= static_cast<int>(m_info[targetIndex].size()))
349         return 0;
350     return &(m_info[targetIndex][level]);
351 }
352
353 }
354
355 #endif // ENABLE(3D_CANVAS)