squish.h

Go to the documentation of this file.

/* -----------------------------------------------------------------------------
 
    Copyright (c) 2006 Simon Brown                          si@sjbrown.co.uk
 
    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.
 
   -------------------------------------------------------------------------- */
 
#ifndef SQUISH_H
#define SQUISH_H
 
#include "squish/squish_export.h"
 
namespace squish {
 
// -----------------------------------------------------------------------------
 
typedef unsigned char u8;
 
// -----------------------------------------------------------------------------
 
enum
{
    kDxt1 = ( 1 << 0 ),
 
    kDxt3 = ( 1 << 1 ),
 
    kDxt5 = ( 1 << 2 ),
 
    kBc4 = ( 1 << 3 ),
 
    kBc5 = ( 1 << 4 ),
 
    kColourClusterFit = ( 1 << 5 ),
 
    kColourRangeFit = ( 1 << 6 ),
 
    kWeightColourByAlpha = ( 1 << 7 ),
 
    kColourIterativeClusterFit = ( 1 << 8 ),
 
    kSourceBGRA = ( 1 << 9 )
};
 
// -----------------------------------------------------------------------------
 
SQUISH_EXPORT void CompressMasked( u8 const* rgba, int mask, void* block, int flags, float* metric = 0 );
 
// -----------------------------------------------------------------------------
 
inline void Compress( u8 const* rgba, void* block, int flags, float* metric = 0 )
{
    CompressMasked( rgba, 0xffff, block, flags, metric );
}
 
// -----------------------------------------------------------------------------
 
SQUISH_EXPORT void Decompress( u8* rgba, void const* block, int flags );
 
// -----------------------------------------------------------------------------
 
SQUISH_EXPORT int GetStorageRequirements( int width, int height, int flags );
 
// -----------------------------------------------------------------------------
 
SQUISH_EXPORT void CompressImage( u8 const* rgba, int width, int height, int pitch, void* blocks, int flags, float* metric = 0 );
 
SQUISH_EXPORT void CompressImage( u8 const* rgba, int width, int height, void* blocks, int flags, float* metric = 0 );
 
// -----------------------------------------------------------------------------
 
SQUISH_EXPORT void DecompressImage( u8* rgba, int width, int height, int pitch, void const* blocks, int flags );
 
SQUISH_EXPORT void DecompressImage( u8* rgba, int width, int height, void const* blocks, int flags );
 
// -----------------------------------------------------------------------------
 
SQUISH_EXPORT void ComputeMSE(u8 const *rgba, int width, int height, int pitch, u8 const *dxt, int flags, double &colourMSE, double &alphaMSE);
 
SQUISH_EXPORT void ComputeMSE(u8 const *rgba, int width, int height, u8 const *dxt, int flags, double &colourMSE, double &alphaMSE);
 
// -----------------------------------------------------------------------------
 
} // namespace squish
 
#endif // ndef SQUISH_H