RE/RE_OGLTextureCache.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Joe Drew
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        RE_OGLTextureCache.h (RE Library, C++)
 *
 * COMMENTS:
 */

#ifndef __RE_OGLTextureCache__
#define __RE_OGLTextureCache__

#include "RE_API.h"

#include <SYS/SYS_Math.h>
#include <SYS/SYS_Types.h>
#include <UT/UT_IntArray.h>
#include <UT/UT_PtrArray.h>
#include <UT/UT_RefArray.h>

#include <boost/shared_array.hpp>

class RE_Render;
class PXL_Raster;
class re_DeferTexDraw;

enum RE_OGLTextureType
{
    RE_TEXTURE_FIXED,
    RE_TEXTURE_MIPMAP
};

struct RE_OGLTextureInfo
{
    RE_OGLTextureInfo()
    {}

    RE_OGLTextureInfo(RE_OGLTextureType t, uint w, uint h)
     : myTextureType(t),
       myWidth(w),
       myHeight(h),
       myS(double(myWidth) / SYSmakePow2(w)),
       myT(double(myHeight) / SYSmakePow2(h))
    {}

    RE_OGLTextureType myTextureType;
    int myWidth;
    int myHeight;

    // The texture coordinates to use when rendering the texture. This allows
    // for non-power-of-two textures to be represented; we use texture
    // coordinates less than 1, and simply pad the texture.
    double myS;
    double myT;
};

typedef UT_RefArray<RE_OGLTextureInfo> RE_OGLTextureInfoArray;

class RE_API RE_OGLTextureCache
{
public:
    RE_OGLTextureCache();
    ~RE_OGLTextureCache();

    /// Add a regular texture from a raster and return its unique ID.
    int addTexture(RE_Render *r, PXL_Raster *texture);

    /// Add a mip-mapped texture, with many levels defined by the rasters passed
    /// as levels, and return its unique ID. The levels must all be powers of
    /// two in size, and must follow the progression from 2^Nx2^N,
    /// 2^(N-1)x2^(N-1), ..., 1x1.
    int addMipMapTexture(RE_Render *r, UT_PtrArray<PXL_Raster *> levels);

    /// Remove a texture from the cache.
    void removeTexture(int id);

    /// Free all textures.
    void clearTextureCache();

    /// Returns a version # for the cache; every time it is cleared, this
    /// number is bumped;
    int  getTextureVersion() const { return myVersion; }

    /// Render a given texture at (x, y) with width and height w, h.
    void renderTexture(RE_Render *r, int x, int y, int w, int h, int id,
                       fpreal alpha = 1.0f);

    /// Helper methods. You can use this to draw non-square textures. These
    /// bind the current texture to be the one specified. Drawing polygons
    /// with texture coordinates (i.e., uv coordinates) will use this texture.
    bool startTexture(RE_Render *r, int id, int &cacheindex);

    /// Stop drawing using the given texture.
    void endTexture(RE_Render *r, int id);


    /// These methods record the textures to be drawn, and draws them all at
    /// once when endTextureDefer() is called.
    void beginTextureDefer(RE_Render *r);
    void endTextureDefer(RE_Render *r);
    
    /// Checks if the given texture ID is valid.
    static bool isTexture(int id);

private: // methods

    boost::shared_array<int8> makePow2Texture(int8 *imgdata, uint w, uint h);

    void createTextureImage(int level, PXL_Raster *texture, bool mipmap);

private:

    /// An array of OpenGL texture IDs.
    UT_IntArray myTextures;

    /// Information about each of the above textures.
    RE_OGLTextureInfoArray myTextureInfo;

    /// Cache Version #; bumped at every cache clear.
    int         myVersion;
    bool        myTextureEnabled;

    /// Data for the texture defer system, which batches icon rendering together
    /// for improved GL performance.
    int         myTextureDefer;
    UT_PtrArray<re_DeferTexDraw *>      myDeferTexDraw;
    UT_IntArray myTextureDeferStart;
};

/// Get the one and only texture cache.
RE_API extern RE_OGLTextureCache *REgetOGLTextureCache();

#endif

---