RE_TextureCubeMap.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 cube 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_TextureCubeMap_h__
#define __RE_TextureCubeMap_h__

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

class IMG_File;
class PXL_Raster;

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

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

    RE_TextureDimension getMapType() override { return RE_TEXTURE_CUBE; }
    RE_TextureMap       *clone() const override;
        
    // Public interface is in RE_TextureMap
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;

    bool                loadCubeMap(IMG_File *fp, int w, int h,
                                    RE_GPUType dt, int vs, void **mapptr);
    bool                loadSphereMap(IMG_File *fp,int w, int h, int sw, int sh,
                                      RE_GPUType dt, int vs, void **mapptr);
    void                generateMipMaps(RE_Render *r, RE_Texture *tex);
    void                scalePolarFromRaster(PXL_Raster *dest,
                                             const PXL_Raster *src,
                                             bool wrap_y);
        
    float               myOpTime;

    UT_UniquePtr<PXL_Raster> myPolarMap;
    enum PolarType
    {
        LatLongStyle, // aspect 2:1
        MatCapStyle   // aspect 1:1
    };
    PolarType           myPolarType;
};

#endif