| GL Studio C++ Runtime API

bmpimage.h
Go to the documentation of this file.
1/*! \file
2 \brief The BmpImage class. Implements loading BMP image files.
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.
38
39*/
40#ifndef INCLUDED_DISTI_BMPIMAGE_H
41#define INCLUDED_DISTI_BMPIMAGE_H
42
43#include "gls_include.h"
44#include "texture_loader.h"
45
46 namespace disti
47{
48/**
49 * The BmpImage class. Implements loading Bmp image files.
50 */
51 class BmpImageLoader : public TextureLoader
52{
53 public:
54 // TextureLoader implementation
55 GLS_EXPORT const char* Description() DISTI_METHOD_OVERRIDE;
56 GLS_EXPORT const char* Version() DISTI_METHOD_OVERRIDE;
57 GLS_EXPORT const char* FilterString() DISTI_METHOD_OVERRIDE;
58 GLS_EXPORT const char* FilterDescription() DISTI_METHOD_OVERRIDE;
59 GLS_EXPORT const char* GenerateHeader() DISTI_METHOD_OVERRIDE;
60 GLS_EXPORT const char* GenerateDeclaration() DISTI_METHOD_OVERRIDE;
61 GLS_EXPORT bool SupportsExtension( const char* ext ) DISTI_METHOD_OVERRIDE;
62 GLS_EXPORT bool IsFileType( const char* filename ) DISTI_METHOD_OVERRIDE;
63 GLS_EXPORT virtual Image* LoadTexture( const char* filename, const Image::LoadOptions& options, bool allowNPOT = true ) DISTI_METHOD_OVERRIDE;
64
65 GLS_EXPORT BmpImageLoader();
66
67 /// \return A pointer to the BmpImageLoader singleton instance.
68 static GLS_EXPORT BmpImageLoader* Instance();
69
70 /// Do nothing since this is a singleton.
71 GLS_EXPORT virtual void Destroy() DISTI_METHOD_OVERRIDE {}
72};
73
74} // namespace disti
75
76#endif
disti::BmpImageLoader
Definition: bmpimage.h:52
disti::BmpImageLoader::IsFileType
bool IsFileType(const char *filename) override
disti::BmpImageLoader::Description
const char * Description() override
disti::BmpImageLoader::Destroy
virtual void Destroy() override
Do nothing since this is a singleton.
Definition: bmpimage.h:71
disti::BmpImageLoader::FilterDescription
const char * FilterDescription() override
disti::BmpImageLoader::GenerateHeader
const char * GenerateHeader() override
disti::BmpImageLoader::SupportsExtension
bool SupportsExtension(const char *ext) override
disti::BmpImageLoader::FilterString
const char * FilterString() override
disti::BmpImageLoader::GenerateDeclaration
const char * GenerateDeclaration() override
disti::BmpImageLoader::Instance
static BmpImageLoader * Instance()
disti::BmpImageLoader::Version
const char * Version() override
disti::BmpImageLoader::LoadTexture
virtual Image * LoadTexture(const char *filename, const Image::LoadOptions &options, bool allowNPOT=true) override
disti::Image
Definition: image.h:178
disti::TextureLoader
Definition: texture_loader.h:133
DISTI_METHOD_OVERRIDE
#define DISTI_METHOD_OVERRIDE
Macro to wrap the override keyword, removed on compilers that don't support it.
Definition: gls_cpp_lang_support.h:222
gls_include.h
A file for all GL Studio files to include.
GLS_EXPORT
#define GLS_EXPORT
Macro denoting which functions should be visible from the runtime library.
Definition: gls_include.h:52
disti
Definition: bmpimage.h:47
texture_loader.h
The TextureLoader and TextureLoaderList classes.