iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TextureManager.H
Go to the documentation of this file.
1 /*! @file
2  @author Laurent Itti
3  @copyright GNU Public License (GPL v3)
4  @section License
5  @verbatim
6  // ////////////////////////////////////////////////////////////////////////
7  // The iLab Neuromorphic Robotics Toolkit (NRT) //
8  // Copyright 2010-2012 by the University of Southern California (USC) //
9  // and the iLab at USC. //
10  // //
11  // iLab - University of Southern California //
12  // Hedco Neurociences Building, Room HNB-10 //
13  // Los Angeles, Ca 90089-2520 - USA //
14  // //
15  // See http://ilab.usc.edu for information about this project. //
16  // ////////////////////////////////////////////////////////////////////////
17  // This file is part of The iLab Neuromorphic Robotics Toolkit. //
18  // //
19  // The iLab Neuromorphic Robotics Toolkit is free software: you can //
20  // redistribute it and/or modify it under the terms of the GNU General //
21  // Public License as published by the Free Software Foundation, either //
22  // version 3 of the License, or (at your option) any later version. //
23  // //
24  // The iLab Neuromorphic Robotics Toolkit is distributed in the hope //
25  // that it will be useful, but WITHOUT ANY WARRANTY; without even the //
26  // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR //
27  // PURPOSE. See the GNU General Public License for more details. //
28  // //
29  // You should have received a copy of the GNU General Public License //
30  // along with The iLab Neuromorphic Robotics Toolkit. If not, see //
31  // <http://www.gnu.org/licenses/>. //
32  // ////////////////////////////////////////////////////////////////////////
33  @endverbatim */
34 
35 #ifndef INCLUDE_NRT_GRAPHICS_TEXTUREMANAGER_H
36 #define INCLUDE_NRT_GRAPHICS_TEXTUREMANAGER_H
37 
39 #include <thread>
40 #include <map>
41 #include <vector>
42 #include <mutex>
43 
44 namespace nrt
45 {
46  namespace graphics
47  {
48  //! Simple manager to create/delete OpenGL textures and give them a name
49  /* \ingroup graphics */
51  {
52  public:
53  //! Constructor
54  TextureManager() = default;
55 
56  //! Destructor
57  ~TextureManager() = default;
58 
59  //! Create a number of textures by providing a unique name
60  /*! Will throw if name already exists. The returned texture indices are not guaranteed to be contiguous. */
61  std::vector<unsigned int> const & create(std::string const & name, size_t const num = 1);
62 
63  //! Delete an existing block of lists, by name
64  /*! Will throw if name does not exist */
65  void remove(std::string const & name);
66 
67  //! Return true if we have created some lists for the given name
68  bool has(std::string const & name) const;
69 
70  //! Get the first OpenGL list index and the number of allocated lists, by name
71  /*! Will throw if name does not exist */
72  std::vector<unsigned int> const & get(std::string const & name) const;
73 
74  //! Clear the entire list
75  void clear();
76 
77  private:
78  std::map<std::string, std::vector<unsigned int> > itsT;
79  mutable std::mutex itsMtx;
80  };
81 
82  } // namespace graphics
83 
84  namespace exception
85  {
86  //! Exception that gets thrown if anything goes wrong with TextureManager
87  /* \relates TextureManager */
89  {
90  public:
91  //! Constructor with a default non-specific error message
92  TextureManagerException() throw();
93 
94  //! Constructor with a given error message
95  TextureManagerException(char const * msg) throw();
96 
97  //! Virtual destructor
98  virtual ~TextureManagerException() throw();
99  };
100  }
101 }
102 
103 #endif // INCLUDE_NRT_GRAPHICS_TEXTUREMANAGER_H