GL Studio C++ Runtime API
IFontImage.h
Go to the documentation of this file.
1/// \file IFontImage.h
2/// \brief IFontImage
3///
4/// \par Copyright Information
5///
6/// Copyright (c) 2017 by The DiSTI Corporation.<br>
7/// 12249 Science Drive; Suite 300<br>
8/// Orlando, Florida 32826<br>
9/// USA<br>
10/// <br>
11/// All rights reserved.<br>
12///
13/// This Software contains proprietary trade secrets of DiSTI and may not be
14/// reproduced, in whole or part, in any form, or by any means of electronic,
15/// mechanical, or otherwise, without the written permission of DiSTI. Said
16/// permission may be derived through the purchase of applicable DiSTI product
17/// licenses which detail the distribution rights of this content and any
18/// Derivative Works based on this or other copyrighted DiSTI Software.
19///
20/// NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
21/// AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
22/// PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
23/// AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
24/// IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
25/// PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
26///
27/// LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
28/// IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
29/// INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
30/// DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
31/// INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
32/// INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
33/// OF SUCH DAMAGES. DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
34/// EXCEED FIVE DOLLARS (US$5.00).
35///
36/// The aforementioned terms and restrictions are governed by the laws of the
37/// State of Florida and the United States of America.
38
39#ifndef DISTI_IFontImage_H_INCLUDED
40#define DISTI_IFontImage_H_INCLUDED
41
42namespace disti
43{
44/** \interface IFontImage.
45 * \details This acts as a common interface class for ITexture2D (Lumen) and Image (GLS Standard), which
46 * is why it is placed in the disti namespace. It cannot be moved to core however, since
47 * it is also needed by the runtime_glyph_generation static lib.
48 */
50{
51public:
52 /** Destructor for polymorphic deletion */
53 virtual ~IFontImage() {}
54
55 /** Binds the texture. */
56 virtual void BindTexture() = 0;
57
58#ifdef GLES
59 /** Returns a handle used by the OpenGL ES state manager to quickly find a texture
60 * \return the handle
61 */
62 virtual unsigned int StateManagerHandle() const = 0;
63
64 /** Sets a handle used by the OpenGL ES state manager to quickly find a texture
65 * \param handle the handle
66 */
67 virtual void StateManagerHandle( unsigned int handle ) = 0;
68
69 /** \return the OpenGL texture handle of a texture instance */
70 virtual unsigned int TextureHandle() const = 0;
71
72 /// \return true if this image should use a mipmap.
73 virtual bool MipMap() = 0;
74#endif
75
76 /** Sets mip mapping for this texture.
77 * \param[in] mipMap True if mip mapping is enabled, else false.
78 */
79 virtual void MipMap( bool mipMap ) = 0;
80
81 /** Gets the pixel format for this texture.
82 * \return The pixel format for this texture.
83 */
84 virtual int PixelFormat() = 0;
85};
86
87} // end namespace disti
88
89#endif // DISTI_IFontImage_H_INCLUDED
Definition: IFontImage.h:50
virtual ~IFontImage()
Definition: IFontImage.h:53
virtual int PixelFormat()=0
virtual void MipMap(bool mipMap)=0
virtual void BindTexture()=0
Definition: bmpimage.h:46