ScummVM API documentation
resource.h
1 /* ScummVM - Graphic Adventure Engine
2  *
3  * ScummVM is the legal property of its developers, whose names
4  * are too numerous to list here. Please refer to the COPYRIGHT
5  * file distributed with this source distribution.
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  *
20  */
21 
22 /*
23  * This code is based on Broken Sword 2.5 engine
24  *
25  * Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
26  *
27  * Licensed under GNU GPL v2
28  *
29  */
30 
31 #ifndef SWORD25_RESOURCE_H
32 #define SWORD25_RESOURCE_H
33 
34 #include "common/list.h"
35 #include "common/str.h"
36 #include "sword25/kernel/common.h"
37 
38 namespace Sword25 {
39 
40 class Kernel;
41 class ResourceManager;
42 
43 class Resource {
44  friend class ResourceManager;
45 
46 public:
47  enum RESOURCE_TYPES {
48  TYPE_UNKNOWN,
49  TYPE_BITMAP,
50  TYPE_ANIMATION,
51  TYPE_SOUND,
52  TYPE_FONT
53  };
54 
55  Resource(const Common::String &uniqueFileName, RESOURCE_TYPES type);
56 
61  void addReference() {
62  ++_refCount;
63  }
64 
70  void release();
71 
76  int getLockCount() const {
77  return _refCount;
78  }
79 
83  const Common::String &getFileName() const {
84  return _fileName;
85  }
86 
90  uint getType() const {
91  return _type;
92  }
93 
94 protected:
95  virtual ~Resource() {}
96 
97 private:
98  Common::String _fileName;
99  uint _refCount;
100  uint _type;
102 };
103 
104 } // End of namespace Sword25
105 
106 #endif
const Common::String & getFileName() const
Definition: resource.h:83
Definition: str.h:59
uint getType() const
Definition: resource.h:90
Definition: resource.h:43
Definition: console.h:27
Definition: resmanager.h:48
void addReference()
Definition: resource.h:61
Definition: list_intern.h:51
int getLockCount() const
Definition: resource.h:76