Home | History | Annotate | Download | only in canvas
      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 #ifndef WebGLBuffer_h
     27 #define WebGLBuffer_h
     28 
     29 #include "CanvasObject.h"
     30 #include "WebGLArrayBuffer.h"
     31 
     32 #include <wtf/PassRefPtr.h>
     33 #include <wtf/RefCounted.h>
     34 
     35 namespace WebCore {
     36 
     37     class WebGLBuffer : public CanvasObject {
     38     public:
     39         virtual ~WebGLBuffer() { deleteObject(); }
     40 
     41         static PassRefPtr<WebGLBuffer> create(WebGLRenderingContext*);
     42 
     43         // For querying previously created objects via e.g. getFramebufferAttachmentParameter
     44         // FIXME: should consider canonicalizing these objects
     45         static PassRefPtr<WebGLBuffer> create(WebGLRenderingContext*, Platform3DObject);
     46 
     47         bool associateBufferData(unsigned long target, int size);
     48         bool associateBufferData(unsigned long target, WebGLArray* array);
     49         bool associateBufferSubData(unsigned long target, long offset, WebGLArray* array);
     50 
     51         unsigned byteLength(unsigned long target) const;
     52         const WebGLArrayBuffer* elementArrayBuffer() const { return m_elementArrayBuffer.get(); }
     53 
     54         // Gets the cached max index for the given type. Returns -1 if
     55         // none has been set.
     56         long getCachedMaxIndex(unsigned long type);
     57         // Sets the cached max index for the given type.
     58         void setCachedMaxIndex(unsigned long type, long value);
     59 
     60     protected:
     61         WebGLBuffer(WebGLRenderingContext*);
     62         WebGLBuffer(WebGLRenderingContext*, Platform3DObject obj);
     63 
     64         virtual void _deleteObject(Platform3DObject o);
     65 
     66     private:
     67         RefPtr<WebGLArrayBuffer> m_elementArrayBuffer;
     68         unsigned m_elementArrayBufferByteLength;
     69         unsigned m_arrayBufferByteLength;
     70 
     71         // Optimization for index validation. For each type of index
     72         // (i.e., UNSIGNED_SHORT), cache the maximum index in the
     73         // entire buffer.
     74         //
     75         // This is sufficient to eliminate a lot of work upon each
     76         // draw call as long as all bound array buffers are at least
     77         // that size.
     78         struct MaxIndexCacheEntry {
     79             unsigned long type;
     80             long maxIndex;
     81         };
     82         // OpenGL ES 2.0 only has two valid index types (UNSIGNED_BYTE
     83         // and UNSIGNED_SHORT), but might as well leave open the
     84         // possibility of adding others.
     85         MaxIndexCacheEntry m_maxIndexCache[4];
     86         unsigned m_nextAvailableCacheEntry;
     87 
     88         // Clears all of the cached max indices.
     89         void clearCachedMaxIndices();
     90     };
     91 
     92 } // namespace WebCore
     93 
     94 #endif // WebGLBuffer_h
     95