ImageToolsFwd.h

Go to the documentation of this file.

/*
   Copyright (c) 2018 DIVIDE-Studio
   Copyright (c) 2009 Ionut Cava
 
   This file is part of DIVIDE Framework.
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software
   and associated documentation files (the "Software"), to deal in the Software
   without restriction,
   including without limitation the rights to use, copy, modify, merge, publish,
   distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so,
   subject to the following conditions:
 
   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.
 
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED,
   INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
   PARTICULAR PURPOSE AND NONINFRINGEMENT.
   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
   DAMAGES OR OTHER LIABILITY,
   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
   IN CONNECTION WITH THE SOFTWARE
   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 */
 
#pragma once
#ifndef DVD_UTILITY_IMAGETOOLS_FWD_H
#define DVD_UTILITY_IMAGETOOLS_FWD_H
 
namespace Divide {
    namespace ImageTools {
 
        void OnStartup(bool upperLeftOrigin);
        void OnShutdown();
 
        [[nodiscard]] bool UseUpperLeftOrigin() noexcept;
 
        enum class MipMapFilter : U8 {
            BOX,
            TRIANGLE,
            KAISER,
            COUNT
        };
 
        enum class ImageOutputFormat : U8 {
            BC1, //Will be BC1n for normal maps
            BC1a,
            BC2,
            BC3,//Will be BC3n for normal maps
            BC4,
            BC5,
            BC6,
            BC7,
            //BC3_RGBM, //Not supported
            AUTO,  // BC7 for textures, BC5 for normal maps, BC4 single channel images
            COUNT
        };
 
        struct ImportOptions {
            bool _useDDSCache = true;
            bool _waitForDDSConversion = false; 
            bool _skipMipMaps = false;
            bool _isNormalMap = false;
            bool _fastCompression = false;
            bool _outputSRGB = false;
            bool _alphaChannelTransparency = true; 
            MipMapFilter _mipFilter = MipMapFilter::KAISER;
            ImageOutputFormat _outputFormat = ImageOutputFormat::AUTO;
        };
 
        FWD_DECLARE_MANAGED_STRUCT(LayerData);
 
 
        enum class SaveImageFormat : U8 {
            PNG,
            BMP,
            TGA,
            //HDR, /// Use special function for this!
            JPG,
            COUNT
        };
 
        bool SaveImage(const ResourcePath& filename, U16 width, U16 height, U8 numberOfComponents, U8 bytesPerPixel, const bool sourceIsBGR, const Byte* imageData, SaveImageFormat format);
        bool SaveImageHDR(const ResourcePath& filename, U16 width, U16 height, U8 numberOfComponents, U8 bytesPerPixel, const bool sourceIsBGR, const F32* imageData);
 
    } //namespace ImageTools
} //namespace Divide
 
#endif //DVD_UTILITY_IMAGETOOLS_FWD_H