RE_Texture2DMap.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.
 *
 * NAME:        Render Library (C++)
 *
 * COMMENTS:
 *      Handle to a 2D texture map stored in the texture cache. This class is
 *      primarily responsible for fetching images from various 2D sources and
 *      creating the texture for them.
 */

#ifndef __RE_Texture2DMap_h__
#define __RE_Texture2DMap_h__

#include "RE_API.h"
#include "RE_TextureMap.h"
#include <UT/UT_StringHolder.h>
#include <UT/UT_UniquePtr.h>

class PXL_Raster;

class RE_API RE_Texture2DMap : public RE_TextureMap
{ 
public:
             RE_Texture2DMap();
            ~RE_Texture2DMap() override;

    /// Returns the amount of main memory (NOT graphics memory!)
    /// owned by this RE_Texture2DMap.
    int64               getMemoryUsage(bool inclusive) const override;

    RE_TextureDimension getMapType() override { return RE_TEXTURE_2D; }
    RE_TextureMap       *clone() const override;

    int                 getSourceOpID() const override { return myOpID; }

    void                setSourcePlane(const UT_StringRef &plane)
                            { mySourcePlane = plane; }
    
    // Public interface is in RE_TextureMap
    
    static UT_UniquePtr<PXL_Raster>
                        loadMap(IMG_File *file, int w=-1, int h=-1);
    
private:
    bool                buildTexture(RE_Render *r, RE_Texture *tex,
                                     void *data) override;
    bool                getNodeSource(const char *map, const char *rel,
                                      void **mapptr,
                                      RE_TextureDimension &textype,
                                      RE_GPUType &datatype,
                                      int &vectorsize,
                                      int &w, int &h, int &d) override;
    bool                getFileSource(const char *map,
                                      void **mapptr,
                                      RE_TextureDimension &textype,
                                      RE_GPUType &datatype,
                                      int &vectorsize,
                                      int &w, int &h, int &d,
                                      bool preload) override;
    void                buildTextureName(UT_String &, const char *map,
                                         const char *rel) override;

    void                cachedTextureFound(RE_Texture *tex) override;
    
   
    fpreal      myOpTime;
    size_t      myOpVersion;
    int         myOpID;
    TIL_Raster *myCop2Raster;
    UT_StringHolder mySourcePlane;
};

#endif