ddsfile.h

Go to the documentation of this file.

/*! \file
  \brief DDS file loading functions

  \par Copyright Information

  Copyright (c) 2015 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

 The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America. Use, distribution,
duplication, or disclosure by the U. S. Government is subject to
"Restricted Rights" as set forth in DFARS 252.227-7014(c)(1)(ii).

*/
#ifndef INCLUDED_DISTI_DDSFILE_H
#define INCLUDED_DISTI_DDSFILE_H

#include "gls_gl.h"

#if defined(WIN32) && _MSC_VER > 1600 // Greater than VS 2010
// GLS-3204: Remove this #define
#define BOOST_HAS_TR1_SHARED_PTR
#endif
#include <boost/tr1/memory.hpp>
#include <vector>

#ifndef GL_COMPRESSED_RED_RGTC1
#define GL_COMPRESSED_RED_RGTC1         0x8DBB
#define GL_COMPRESSED_SIGNED_RED_RGTC1  0x8DBC
#define GL_COMPRESSED_RG_RGTC2          0x8DBD
#define GL_COMPRESSED_SIGNED_RG_RGTC2   0x8DBE
#endif

#ifndef GL_COMPRESSED_LUMINANCE_LATC1_EXT
#define GL_COMPRESSED_LUMINANCE_LATC1_EXT               0x8C70
#define GL_COMPRESSED_SIGNED_LUMINANCE_LATC1_EXT        0x8C71
#define GL_COMPRESSED_LUMINANCE_ALPHA_LATC2_EXT         0x8C72
#define GL_COMPRESSED_SIGNED_LUMINANCE_ALPHA_LATC2_EXT  0x8C73
#endif

namespace disti
{

struct DDSTextureInfo
{
    GLsizei  _width;
    GLsizei  _height;
    GLenum   _pixelFormat;
    GLenum   _pixelType;
    GLenum   _internalFormat;
    GLuint   _textureID;
    GLuint   _numMipmaps;

    // Under protest: this shouldn't be a vector, but should instead be either a unique_ptr or
    // boost::scoped_array. However, the former is only available in C++11 (can't use in VC8), and
    // the latter is declared off-limits (avoid boost unless it's tr1).
    std::vector<GLubyte> _texels;

    DDSTextureInfo() : _width(0),
                       _height(0),
                       _pixelFormat(0),
                       _pixelType(0),
                       _internalFormat(0),
                       _textureID(0),
                       _numMipmaps(0),
                       _texels()
    {
    }
};

void DDSInitExtensions();

std::tr1::shared_ptr<DDSTextureInfo> ReadDDSFile(const char *filename, bool loadTexels);

GLuint BindDDSTexture(DDSTextureInfo *texInfo, unsigned int skipLevels=0);

} // namespace disti

#endif // INCLUDED_DISTI_DDSFILE_H