IFontImage.h

Go to the documentation of this file.

/*! \file
  \brief IFontImage
 
  \par Copyright Information
 
  Copyright (c) 2017 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 DISTI_IFontImage_H_INCLUDED
#define DISTI_IFontImage_H_INCLUDED
 
namespace disti
{
/** \interface IFontImage.
  * \details This acts as a common interface class for ITexture2D (Lumen) and Image (GLS Standard), which
  * is why it is placed in the disti namespace.  It cannot be moved to core however, since 
  * it is also needed by the runtime_glyph_generation static lib.
  */
class IFontImage
{
public:
    /** Destructor for polymorphic deletion */
    virtual ~IFontImage() {}
 
    /** Binds the texture. */
    virtual void BindTexture() = 0;
 
#ifdef GLES
    /** Returns a handle used by the OpenGL ES state manager to quickly find a texture
      * \return the handle
      */
    virtual unsigned int StateManagerHandle() const = 0;
 
    /** Sets a handle used by the OpenGL ES state manager to quickly find a texture
      * \param handle the handle
      */
    virtual void StateManagerHandle( unsigned int handle ) = 0;
 
    /** \return the OpenGL texture handle of a texture instance */
    virtual unsigned int TextureHandle() const = 0;
 
    /// \return true if this image should use a mipmap.
    virtual bool MipMap() = 0;
#endif
 
    /** Sets mip mapping for this texture.
      * \param[in] mipMap True if mip mapping is enabled, else false.
      */
    virtual void MipMap( bool mipMap ) = 0;
 
    /** Gets the pixel format for this texture.
      * \return The pixel format for this texture.
      */
    virtual int PixelFormat() = 0;
};
 
} // end namespace disti
 
#endif // DISTI_IFontImage_H_INCLUDED