home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / resource / resource.h
Encoding:
C/C++ Source or Header  |  2008-11-07  |  1.7 KB  |  56 lines
  1. #ifndef K3DSDK_RESOURCE_RESOURCE_H
  2. #define K3DSDK_RESOURCE_RESOURCE_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2008, Timothy M. Shead
  6. //
  7. // Contact: tshead@k-3d.com
  8. //
  9. // This program is free software; you can redistribute it and/or
  10. // modify it under the terms of the GNU General Public
  11. // License as published by the Free Software Foundation; either
  12. // version 2 of the License, or (at your option) any later version.
  13. //
  14. // This program is distributed in the hope that it will be useful,
  15. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17. // General Public License for more details.
  18. //
  19. // You should have received a copy of the GNU General Public
  20. // License along with this program; if not, write to the Free Software
  21. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22.  
  23. /** \file
  24.     \author Tim Shead (tshead@k-3d.com)
  25. */
  26.  
  27. #include <k3dsdk/types.h>
  28. #include <vector>
  29.  
  30. namespace k3d
  31. {
  32.  
  33. /// Provides functionality for working with "resources" - binary data
  34. /// that is compiled into executables for easy access.
  35. namespace resource
  36. {
  37.  
  38. /// Initializes a resource, associating a string key (the Path) with the given data.
  39. const bool_t initialize(const string_t& Path, unsigned char* Data, const uint64_t ByteCount);
  40.  
  41. /// Defines storage for a list of resource keys
  42. typedef std::vector<string_t> keys_t;
  43. /// Returns the current list of resource keys
  44. const keys_t keys();
  45.  
  46. /// Returns a resource as a string (note: it is up to the caller to decide whether this is safe).
  47. /// Returns empty string if the resource does not exist.
  48. const string_t get_string(const string_t& Path);
  49.  
  50. } // namespace resource
  51.  
  52. } // namespace k3d
  53.  
  54. #endif // !K3DSDK_RESOURCE_RESOURCE_H
  55.  
  56.