src/third_party/WebKit/Source/core/html/canvas/WebGLObject.h

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