gecko/dom/canvas/WebGLRenderbuffer.h

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef WEBGL_RENDERBUFFER_H_
#define WEBGL_RENDERBUFFER_H_

#include "mozilla/LinkedList.h"
#include "nsWrapperCache.h"

#include "WebGLFramebufferAttachable.h"
#include "WebGLObjectModel.h"
#include "WebGLStrongTypes.h"

namespace mozilla {
namespace webgl {
struct FormatUsageInfo;
}

class WebGLRenderbuffer final
    : public nsWrapperCache
    , public WebGLRefCountedObject<WebGLRenderbuffer>
    , public LinkedListElement<WebGLRenderbuffer>
    , public WebGLRectangleObject
    , public WebGLContextBoundObject
    , public WebGLFramebufferAttachable
{
public:
    explicit WebGLRenderbuffer(WebGLContext* webgl);

    void Delete();

    bool HasUninitializedImageData() const {
        MOZ_ASSERT(mImageDataStatus != WebGLImageDataStatus::NoImageData);
        return mImageDataStatus == WebGLImageDataStatus::UninitializedImageData;
    }

    bool IsDefined() const {
        if (!mFormat) {
            MOZ_ASSERT(!mWidth && !mHeight);
            return false;
        }
        return true;
    }

    GLsizei Samples() const { return mSamples; }

    GLuint PrimaryGLName() const { return mPrimaryRB; }

    const webgl::FormatUsageInfo* Format() const { return mFormat; }

    int64_t MemoryUsage() const;

    WebGLContext* GetParentObject() const {
        return mContext;
    }

    void BindRenderbuffer() const;
    void RenderbufferStorage(GLsizei samples, const webgl::FormatUsageInfo* format,
                             GLsizei width, GLsizei height);
    void FramebufferRenderbuffer(GLenum attachment) const;
    // Only handles a subset of `pname`s.
    GLint GetRenderbufferParameter(RBTarget target, RBParam pname) const;

    virtual JSObject* WrapObject(JSContext* cx, JS::Handle<JSObject*> givenProto) override;

    NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(WebGLRenderbuffer)
    NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_NATIVE_CLASS(WebGLRenderbuffer)

protected:
    ~WebGLRenderbuffer() {
        DeleteOnce();
    }

    GLuint mPrimaryRB;
    GLuint mSecondaryRB;
    const webgl::FormatUsageInfo* mFormat;
    WebGLImageDataStatus mImageDataStatus;
    GLsizei mSamples;
    bool mIsUsingSecondary;
#ifdef ANDROID
    // Bug 1140459: Some drivers (including our test slaves!) don't
    // give reasonable answers for IsRenderbuffer, maybe others.
    // This shows up on Android 2.3 emulator.
    //
    // So we track the `is a Renderbuffer` state ourselves.
    bool mIsRB;
#endif

    friend class WebGLContext;
    friend class WebGLFramebuffer;
    friend class WebGLFBAttachPoint;
};

} // namespace mozilla

#endif // WEBGL_RENDERBUFFER_H_