WebCore/html/canvas/WebGLFramebuffer.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 WebGLFramebuffer_h
  27 #define WebGLFramebuffer_h
  28
  29 #include "WebGLObject.h"
  30
  31 #include <wtf/PassRefPtr.h>
  32 #include <wtf/RefCounted.h>
  33
  34 namespace WebCore {
  35
  36 class WebGLFramebuffer : public WebGLObject {
  37 public:
  38     virtual ~WebGLFramebuffer() { deleteObject(); }
  39
  40     static PassRefPtr<WebGLFramebuffer> create(WebGLRenderingContext*);
  41
  42     void setAttachment(unsigned long, WebGLObject*);
  43     // If an object is attached to the framebuffer, remove it.
  44     void removeAttachment(WebGLObject*);
  45     WebGLObject* getAttachment(unsigned long) const;
  46
  47     unsigned long getColorBufferFormat() const;
  48
  49     // This should always be called before drawArray, drawElements, clear,
  50     // readPixels, copyTexImage2D, copyTexSubImage2D if this framebuffer is
  51     // currently bound.
  52     // Return false if the framebuffer is incomplete; otherwise initialize
  53     // the buffers if they haven't been initialized.
  54     bool onAccess();
  55
  56     // Return false does not mean COMPLETE, might still be INCOMPLETE.
  57     bool isIncomplete(bool checkInternalFormat) const;
  58
  59     bool hasEverBeenBound() const { return object() && m_hasEverBeenBound; }
  60
  61     void setHasEverBeenBound() { m_hasEverBeenBound = true; }
  62
  63 protected:
  64     WebGLFramebuffer(WebGLRenderingContext*);
  65
  66     virtual void deleteObjectImpl(Platform3DObject);
  67
  68 private:
  69     virtual bool isFramebuffer() const { return true; }
  70
  71     // Return false if framebuffer is incomplete.
  72     bool initializeRenderbuffers();
  73
  74     bool isColorAttached() const { return (m_colorAttachment && m_colorAttachment->object()); }
  75     bool isDepthAttached() const { return (m_depthAttachment && m_depthAttachment->object()); }
  76     bool isStencilAttached() const { return (m_stencilAttachment && m_stencilAttachment->object()); }
  77     bool isDepthStencilAttached() const { return (m_depthStencilAttachment && m_depthStencilAttachment->object()); }
  78
  79     RefPtr<WebGLObject> m_colorAttachment;
  80     RefPtr<WebGLObject> m_depthAttachment;
  81     RefPtr<WebGLObject> m_stencilAttachment;
  82     RefPtr<WebGLObject> m_depthStencilAttachment;
  83
  84     bool m_hasEverBeenBound;
  85 };
  86
  87 } // namespace WebCore
  88
  89 #endif // WebGLFramebuffer_h