Berkelium in Ogre screenshot

Introduction

In this article we will present an example how the Berkelium library can be integrated in Ogre with a minimal amount of code. This will allow you to show a webpage or create a user interface using HTML, javascript and flash on a texture. The rendered Berkelium image can be shown on any scene object on which a texture can be applied (movableObjects, overlays, compositors, ...).

Prerequisites

This sample works with Ogre 1.7 and 1.8 and has been tested with the Berkelium 8.0.552.23 library build.

Setting it up

First you have to download the berkelium library from the website or get the source and compile it yourself. Include the header files in your project and add the library in the lib/ folder to your linker paths. Make sure that the contents of the berkelium bin/ folder are in the same path as your compiled Ogre application.

The sample

This sample shows a simple wrapper that allows you to easily use Berkelium in your Ogre application. These two files need to be included in your project.

OgreBrowserWindow.h
#ifndef OGREBROWSERWINDOW_H
#define OGREBROWSERWINDOW_H

#include <berkelium/WindowDelegate.hpp>
#include <Ogre.h>

/**
  * Berkelium browser window that renders to a texture.
  **/
class BrowserWindow : public Berkelium::WindowDelegate
{
public:
    /**
      * Construct a new Berkelium browser window, which will render to a texture
      * with specified name (the name should not exist yet, as new texture will be created).
      * Width and height specify browser window size.
      * Only invoke this constructor after initializing Berkelium (Berkelium::init())!
      **/
    BrowserWindow(Ogre::String textureName, uint width=1024, uint height=1024);
    virtual ~BrowserWindow();

    /**
      * The name of getMaterial()
      **/
    virtual Ogre::String getMaterialName(void);
    /**
      * The name of getTexture()
      **/
    virtual Ogre::String getTextureName(void);
    /**
      * Standard material that contains the texture to which
      * this browser window is rendering.
      * Use it on a MovableObject or in an overlay to show it in the scene.
      **/
    virtual Ogre::MaterialPtr getMaterial(void);
    /**
      * The texture to which this browser window is rendering.
      **/
    virtual Ogre::TexturePtr getTexture(void);
    /**
      * Show the webpage with specified url in this browser window.
      **/
    virtual void browseToPage(Ogre::String url);
    /**
      * The URL of the page currently shown in this browser window.
      **/
    virtual Ogre::String getCurrentPage(void);
    /**
      * Sets the transparency flag for this Window.
      * Note that the buffer will be ARGB regardless of transparency, but if the window is not set as transparent,
      * the alpha channel should always be 1. Transparency defaults to false and must be enabled on each Window.
      * istrans determines whether to enable a transparent background.
      *
      * This applies to the window background (background of the body).
      * You can set other html elements to transparent by setting their alpha value to 0 using the CSS line:
      * background: rgba(255, 255, 255, 0);
      **/
    virtual void setTransparent(bool isTransparent);
    /**
      * Conversion between Berkelium rectangles and Ogre boxes.
      **/
    static inline Ogre::Box rectToBox(Berkelium::Rect rect);
    /**
      * Callback for Berkelium to update this browser window.
      **/
    virtual void onPaint(
        Berkelium::Window *win,
        const unsigned char *sourceBuffer,
        const Berkelium::Rect &sourceBufferRect,
        size_t numCopyRects,
        const Berkelium::Rect *copyRects,
        int dx, int dy,
        const Berkelium::Rect &scrollRect);

protected:
    Ogre::String mTextureName;
    Ogre::String mMaterialName;
    Ogre::TexturePtr mTexture;
    Ogre::String mUrl;
    uint mWidth;
    uint mHeight;

    Berkelium::Window *mWindow;
};

/**
  * Ogre framelistener you can register for easily updating
  * Berkelium in your render loop.
  **/
class BerkeliumUpdater : public Ogre::FrameListener
{
public:
    virtual bool frameRenderingQueued(const Ogre::FrameEvent& evt);
};

#endif // OGREBROWSERWINDOW_H

OgreBrowserWindow.cpp
#include "OgreBrowserWindow.h"
#include "berkelium/Context.hpp"
#include "berkelium/Berkelium.hpp"

BrowserWindow::BrowserWindow(Ogre::String materialName, uint width, uint height)
{
    mMaterialName = materialName;
    mTextureName = materialName.append("_texture");
    // TODO assert size > 0
    mWidth = width;
    mHeight = height;

    // Create texture to render to
    mTexture = Ogre::TextureManager::getSingleton().createManual(
            mTextureName,
            Ogre::ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME,
            Ogre::TEX_TYPE_2D,
            width,
            height,
            0,  // no mipmaps
            Ogre::PF_BYTE_BGRA,
            Ogre::TU_DYNAMIC);

    // Prefill the RTT texture with initial pixel values (some graphics drivers leave uninitialized garbage in them)
    // Texture will remain like this until the web browser renders new pixels onto it (can usually take a few seconds)
    Ogre::HardwarePixelBufferSharedPtr buffer = mTexture->getBuffer(0,0);
    buffer->lock(Ogre::HardwareBuffer::HBL_DISCARD);    // lock buffer for writing
    const Ogre::PixelBox &pb = buffer->getCurrentLock();

    // Update the contents of pb
    // Image data starts at pb.data and has BYTE_BGRA (4 byte) format
    unsigned char *data = static_cast<unsigned char*>(pb.data);
    size_t length = pb.getHeight() * pb.getWidth() * 4;
    for(size_t i=0; i<length; i+=4)
    {
        // fill the buffer with white pixels and fully transparent alpha channel
        data[i]   = 255;    // Blue
        data[i+1] = 255;    // Green
        data[i+2] = 255;    // Red
        data[i+3] = 0;      // Alpha
    }

    buffer->unlock();   // Unlock the buffer again (frees it for use by the GPU)

    // Create a material using the texture
    Ogre::MaterialPtr mMaterial = Ogre::MaterialManager::getSingleton().create(mMaterialName, Ogre::ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME);
    mMaterial->getTechnique(0)->getPass(0)->createTextureUnitState(mTextureName);

    // Create new browser window in Berkelium
    Berkelium::Context * context = Berkelium::Context::create();
    mWindow = Berkelium::Window::create(context);
    delete context;
    mWindow->resize(width, height);

    // Listen to updates of the browser window to render them to the texture
    mWindow->setDelegate(this);

    // Browse to webpage
    browseToPage("http://www.google.com");
}

BrowserWindow::~BrowserWindow()
{
    mWindow->destroy();
}


void BrowserWindow::onPaint(
        Berkelium::Window *win,
        const unsigned char *sourceBuffer,
        const Berkelium::Rect &sourceBufferRect,
        size_t numCopyRects,
        const Berkelium::Rect *copyRects,
        int dx,
        int dy,
        const Berkelium::Rect &scrollRect)
{
    // Pixels to be written to texture
    const Ogre::PixelBox srcBox = Ogre::PixelBox(
           // Box that defines position of src buffer within complete browser window
       rectToBox(sourceBufferRect),
       Ogre::PF_BYTE_BGRA,
       const_cast<unsigned char*>(sourceBuffer)
    );

    // Update texture
    Ogre::HardwarePixelBufferSharedPtr pixelBuffer = mTexture->getBuffer();
    // There might be multiple areas of the texture to update
    for( int i =0; i<numCopyRects; i++) {
        // Box that defines area of texture that has to be updated)
        const Ogre::Box destBox = rectToBox(copyRects[i]);

        // Copy updated browser surface to texture (note: Don't lock the buffer yourself!! blitFromMemory does this)
        pixelBuffer->blitFromMemory(srcBox.getSubVolume(destBox), destBox);
    }

}

inline Ogre::Box BrowserWindow::rectToBox(Berkelium::Rect rect)
{
    return Ogre::Box(
            rect.left(),
            rect.top(),
            0,
            rect.right(),
            rect.bottom(),
            1);
}

Ogre::String BrowserWindow::getMaterialName()
{
    return mMaterialName;
}

Ogre::String BrowserWindow::getTextureName()
{
    return mTextureName;
}

Ogre::MaterialPtr BrowserWindow::getMaterial()
{
    return Ogre::MaterialManager::getSingletonPtr()->getByName(getMaterialName());
}

Ogre::TexturePtr BrowserWindow::getTexture()
{
    return Ogre::TextureManager::getSingletonPtr()->getByName(getTextureName());
}

void BrowserWindow::browseToPage(Ogre::String url)
{
    mUrl = url;
    mWindow->navigateTo(url.data(), url.length());
}

Ogre::String BrowserWindow::getCurrentPage()
{
    return mUrl;
}

void BrowserWindow::setTransparent(bool isTransparent)
{
    mWindow->setTransparent(isTransparent);

    if(isTransparent) {
        // This is the equivalent of setting "scene_blend alpha_blend" in a material file
        getMaterial()->getTechnique(0)->setSceneBlending(Ogre::SBT_TRANSPARENT_ALPHA);
        // Alternative method: this might be faster if you don't need blending (only transparency for alpha=0)
        //getMaterial()->getTechnique(0)->getPass(0)->setAlphaRejectSettings(Ogre::CMPF_GREATER,0);
    } else {
        // Disable alpha blending for material
        getMaterial()->getTechnique(0)->setSceneBlending(Ogre::SBT_REPLACE);
        // Equivalent for the alternative method
        //getMaterial()->getTechnique(0)->getPass(0)->setAlphaRejectSettings(Ogre::CMPF_ALWAYS_PASS,0);
    }
}


bool BerkeliumUpdater::frameRenderingQueued(const Ogre::FrameEvent &evt)
{
    Berkelium::update();
    return true;
}

Using it

Now that we have the wrapper, we can create Berkelium browser windows and render them in our scene.
This is an example of how the wrapper can be used.

Usage example
// Initialise the global Berkelium browser manager
Berkelium::init(Berkelium::FileString::empty());

// Create a browser instance
BrowserWindow *browserWindow = new BrowserWindow("BerkeliumMaterial");
// Set a webpage to show (defaults to google.com)
browserWindow->browseToPage("http://www.ogre3d.org");

// Create plane for testing browser component on
Ogre::MeshManager::getSingletonPtr()->createPlane("BerkeliumPlane", Ogre::ResourceGroupManager::DEFAULT_RESOURCE_GROUP_NAME,
             Ogre::Plane(Ogre::Vector3::UNIT_Z, 0), 3, 3);
Ogre::Entity *browserPlaneEnt = mSceneMgr->createEntity("BrowserPlane", "BerkeliumPlane");
Ogre::SceneNode *sceneNode = mSceneMgr->getRootSceneNode()->createChildSceneNode();
sceneNode->attachObject(browserPlaneEnt);

// Assign it the material with the browser texture
browserPlaneEnt->setMaterial(browserWindow->getMaterial());

// Update berkelium every frame
BerkeliumUpdater *bu = new BerkeliumUpdater();
Ogre::Root::getSingletonPtr()->addFrameListener(bu);


Note that the Berkelium manager singleton class (not every browserWindow individually!) needs to be updated regularly in the render loop. I provided a BerkeliumUpdater class to make it easier to do this (as illustrated in the example above). It's also possible to update berkelium manually in your renderloop by including the following code in your frameRenderingQueued callback:

Alternative method of updating Berkelium
bool frameRenderingQueued(const Ogre::FrameEvent &evt)
{
    Berkelium::update();
    // Other things to update in your renderloop ...
    return true;
}

Do not use both at the same time, or you will update Berkelium twice every frame.

<HR>
Creative Commons Copyright -- Some rights reserved.


THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

  • "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
  • "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
  • "Licensor" means the individual or entity that offers the Work under the terms of this License.
  • "Original Author" means the individual or entity who created the Work.
  • "Work" means the copyrightable work of authorship offered under the terms of this License.
  • "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
  • "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.

2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

  • to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
  • to create and reproduce Derivative Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
  • For the avoidance of doubt, where the work is a musical composition:
    • Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
    • Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
    • Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).


The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

  • You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
  • You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
  • If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

  • This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
  • Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

  • Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
  • Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
  • If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
  • No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
  • This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.