laTexture.h

/*

Jump'n'Run Engine
http://www.atanaslaskov.com/jnr/

BSD LICENSE
Copyright (c) 2007-2013, Atanas Laskov
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL ATANAS LASKOV BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/
#ifndef M_TEXTURE_H
#define M_TEXTURE_H




// Texture functionality
//
class laTexture
{
    // Map all loaded texute files
    // in order to avoid memory redundancies
    //
    static std::map<std::string, laTexture> _vLoadedTextures;

    //Postopne loading; This is useful when trying to load textures from a thread
    //and the graphical implementation is not thread-safe (e.g. OpenGL)
    //
    static M_BOOL _bLazyLoad;

    std::string         _strFile;
    laTextureParams _params;

    //Texture identifier used by the active laRenderer
    M_TEXTURE _id;
    static M_TEXTURE _id_active;    // currently binded texture

public:

    //Metrics
    unsigned w, h;

    // Get/set ID and metrics
    //
    M_TEXTURE id() { return _id;}

    inline void set(M_TEXTURE id, unsigned nw, unsigned nh) {
        _id = id;
        w = nw;
        h = nh;
    }

    // Constructor
    //
    laTexture(){
        _strFile = "unknown.bmp";
        //_nType = M_TEX_SIMPLE;

        _id = 0;    //NOTE: Must be 0 in order for the tex to be interpreted as non-loaded;
        w = h = 10; //NOTE: If this is 0 it could cause some issues when lazy-loading stuff
    };

    // Load texture; These functions provide checks to ensure that
    // each texture is loaded only once, even if it is requiested
    // multiple times
    //
    void load(std::string strFile, laTextureParams params);
    void load(std::string strFile) { load(strFile, laTextureParams()); };

    // Discard texture
    //
    void discard(laTexture *ptex);

    // Use texture
    //
    inline void laTexture::use() {
        loadForce();                                                        //< force load in case not already loaded

        if( _id_active != _id )                                             //< bind if not already bound
            ::laSystemIntegrator::getRenderer()->texUse(this);
        _id_active = _id;
    }

    // Lazy-loading
    //
    static void toggleLazyLoad(M_BOOL bOn){
        _bLazyLoad = bOn;
    }

    void loadForce();
    static void loadForceAll();
};
#endif