| GL Studio C++ Runtime API

IFontImage.h
Go to the documentation of this file.
1/*! \file
2 \brief IFontImage
3
4 \par Copyright Information
5
6 Copyright (c) 2017 by The DiSTI Corporation.<br>
7 11301 Corporate Blvd; Suite 100<br>
8 Orlando, Florida 32817<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. Use, distribution,
38 duplication, or disclosure by the U. S. Government is subject to
39"Restricted Rights" as set forth in DFARS 252.227-7014(c)(1)(ii).
40
41*/
42
43#ifndef DISTI_IFontImage_H_INCLUDED
44#define DISTI_IFontImage_H_INCLUDED
45
46 namespace disti
47{
48/** \interface IFontImage.
49 * \details This acts as a common interface class for ITexture2D (Lumen) and Image (GLS Standard), which
50 * is why it is placed in the disti namespace. It cannot be moved to core however, since
51 * it is also needed by the runtime_glyph_generation static lib.
52 */
53 class IFontImage
54{
55 public:
56 /** Destructor for polymorphic deletion */
57 virtual ~IFontImage() {}
58
59 /** Binds the texture. */
60 virtual void BindTexture() = 0;
61
62#ifdef GLES
63 /** Returns a handle used by the OpenGL ES state manager to quickly find a texture
64 * \return the handle
65 */
66 virtual unsigned int StateManagerHandle() const = 0;
67
68 /** Sets a handle used by the OpenGL ES state manager to quickly find a texture
69 * \param handle the handle
70 */
71 virtual void StateManagerHandle( unsigned int handle ) = 0;
72
73 /** \return the OpenGL texture handle of a texture instance */
74 virtual unsigned int TextureHandle() const = 0;
75
76 /// \return true if this image should use a mipmap.
77 virtual bool MipMap() = 0;
78#endif
79
80 /** Sets mip mapping for this texture.
81 * \param[in] mipMap True if mip mapping is enabled, else false.
82 */
83 virtual void MipMap( bool mipMap ) = 0;
84
85 /** Gets the pixel format for this texture.
86 * \return The pixel format for this texture.
87 */
88 virtual int PixelFormat() = 0;
89};
90
91} // end namespace disti
92
93#endif // DISTI_IFontImage_H_INCLUDED
disti::IFontImage
Definition: IFontImage.h:54
disti::IFontImage::~IFontImage
virtual ~IFontImage()
Definition: IFontImage.h:57
disti::IFontImage::StateManagerHandle
virtual unsigned int StateManagerHandle() const =0
disti::IFontImage::TextureHandle
virtual unsigned int TextureHandle() const =0
disti::IFontImage::StateManagerHandle
virtual void StateManagerHandle(unsigned int handle)=0
disti::IFontImage::PixelFormat
virtual int PixelFormat()=0
disti::IFontImage::MipMap
virtual void MipMap(bool mipMap)=0
disti::IFontImage::BindTexture
virtual void BindTexture()=0
disti::IFontImage::MipMap
virtual bool MipMap()=0
disti
Definition: bmpimage.h:47