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 WebGLObject_h
     27 #define WebGLObject_h
     28 
     29 #include "platform/graphics/GraphicsTypes3D.h"
     30 #include "platform/heap/Handle.h"
     31 #include "wtf/RefCounted.h"
     32 
     33 namespace blink {
     34 class WebGraphicsContext3D;
     35 }
     36 
     37 namespace blink {
     38 
     39 class WebGLContextGroup;
     40 class WebGLRenderingContextBase;
     41 
     42 class WebGLObject : public RefCountedWillBeGarbageCollectedFinalized<WebGLObject> {
     43 public:
     44     virtual ~WebGLObject();
     45 
     46     Platform3DObject object() const { return m_object; }
     47 
     48     // deleteObject may not always delete the OpenGL resource.  For programs and
     49     // shaders, deletion is delayed until they are no longer attached.
     50     // FIXME: revisit this when resource sharing between contexts are implemented.
     51     void deleteObject(blink::WebGraphicsContext3D*);
     52 
     53     void onAttached() { ++m_attachmentCount; }
     54     void onDetached(blink::WebGraphicsContext3D*);
     55 
     56     // This indicates whether the client side issue a delete call already, not
     57     // whether the OpenGL resource is deleted.
     58     // object()==0 indicates the OpenGL resource is deleted.
     59     bool isDeleted() { return m_deleted; }
     60 
     61     // True if this object belongs to the group or context.
     62     virtual bool validate(const WebGLContextGroup*, const WebGLRenderingContextBase*) const = 0;
     63 
     64     virtual void trace(Visitor*) { }
     65 
     66 protected:
     67     explicit WebGLObject(WebGLRenderingContextBase*);
     68 
     69     // setObject should be only called once right after creating a WebGLObject.
     70     void setObject(Platform3DObject);
     71 
     72     // deleteObjectImpl should be only called once to delete the OpenGL resource.
     73     virtual void deleteObjectImpl(blink::WebGraphicsContext3D*, Platform3DObject) = 0;
     74 
     75     virtual bool hasGroupOrContext() const = 0;
     76 
     77     void detach();
     78     void detachAndDeleteObject();
     79 
     80     virtual blink::WebGraphicsContext3D* getAWebGraphicsContext3D() const = 0;
     81 
     82 private:
     83     Platform3DObject m_object;
     84     unsigned m_attachmentCount;
     85     bool m_deleted;
     86 };
     87 
     88 } // namespace blink
     89 
     90 #endif // WebGLObject_h
     91