From b27581c3d9657a4a05191e47eed78d00ec0a46cd Mon Sep 17 00:00:00 2001 From: chai Date: Thu, 18 Oct 2018 07:58:07 +0800 Subject: =?UTF-8?q?*=E6=B3=A8=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/libjin/Graphics/Image.h | 34 ++++++++++++++++++++++++++++++---- 1 file changed, 30 insertions(+), 4 deletions(-) (limited to 'src/libjin/Graphics/Image.h') diff --git a/src/libjin/Graphics/Image.h b/src/libjin/Graphics/Image.h index bed1986..53eb0d7 100644 --- a/src/libjin/Graphics/Image.h +++ b/src/libjin/Graphics/Image.h @@ -8,18 +8,44 @@ namespace jin namespace graphics { - /* just like bitmap but only from image file*/ - /* readonly bitmap */ + /// + /// A readonly bitmap. + /// + /// Just like bitmap but only from image file. The pixels data + /// is readonly. + /// class Image : public Bitmap { public: + /// + /// Create image from image file. + /// + /// @param path Image path. + /// @return Image if created successfully, otherwise return null. + /// static Image* createImage(const char* path); + + /// + /// Create image from image data. + /// + /// @param imgData Image data to create image. + /// @param size Size of image data. + /// @return Image if created successfully, otherwise return null. + /// static Image* createImage(const void* imgData, size_t size); + + /// + /// Image destructor. + /// ~Image(); private: + /// + /// Image constructor. + /// Image(); + // Disable setters inherited from Bitmap. void bind(Color* pixels, int w, int h); void resetPixels(const Color* pixels, int w, int h); void resetPixels(const Color& pixels, int w, int h); @@ -29,7 +55,7 @@ namespace jin }; - } -} + } // namespace graphics +} // namespace jin #endif \ No newline at end of file -- cgit v1.1-26-g67d0