Add documentation on placing tiles.
[Tsunagari.git] / src / image.h
blob1fe9c8d5d791d3e16ff921b61bff51ba24e10d4a
1 /****************************
2 ** Tsunagari Tile Engine **
3 ** image.h **
4 ** Copyright 2012 OmegaSDG **
5 ****************************/
7 // **********
8 // Permission is hereby granted, free of charge, to any person obtaining a copy
9 // of this software and associated documentation files (the "Software"), to
10 // deal in the Software without restriction, including without limitation the
11 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
12 // sell copies of the Software, and to permit persons to whom the Software is
13 // furnished to do so, subject to the following conditions:
15 // The above copyright notice and this permission notice shall be included in
16 // all copies or substantial portions of the Software.
18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 // IN THE SOFTWARE.
25 // **********
27 #ifndef IMAGE_H
28 #define IMAGE_H
30 #include <cstring> // for size_t
32 #include <boost/shared_ptr.hpp>
34 class Image
36 public:
37 static Image* create(void* data, size_t length);
38 virtual ~Image() = 0;
40 virtual void draw(double dstX, double dstY, double z) const = 0;
41 virtual void drawSubrect(double dstX, double dstY, double z,
42 double srcX, double srcY,
43 double srcW, double srcH) = 0;
45 virtual unsigned width() const = 0;
46 virtual unsigned height() const = 0;
48 private:
49 Image();
51 friend class ImageImpl;
54 typedef boost::shared_ptr<Image> ImageRef;
56 #endif