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