pixel_buffer.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    Harry Storbacka
*/


#pragma once

#include "../api_display.h"
#include "../../Core/System/sharedptr.h"
#include "pixel_format.h"
#include "../../Core/Math/rect.h"

class CL_Size;
class CL_Rect;
class CL_PixelFormat;
class CL_Palette;
class CL_Color;
class CL_Colorf;
class CL_PixelBuffer;
class CL_PixelBuffer_Impl;
class CL_ResourceManager;
class CL_VirtualDirectory;
class CL_IODevice;

class CL_API_DISPLAY CL_PixelBufferRef
{

public:
        CL_PixelBufferRef();

        CL_PixelBufferRef(const CL_PixelBuffer &buffer);

        CL_PixelBufferRef(int width, int height, int pitch, const CL_PixelFormat &format, const void *data);

        CL_PixelBufferRef(int width, int height, int pitch, const CL_PixelFormat &format, const CL_Palette *palette, const void *data);


public:
        const CL_PixelFormat &get_format() const { return format; }

        const CL_Palette *get_palette() const { return palette; }

        int get_width() const { return width; }

        int get_height() const { return height; }

        CL_Size get_size() const { return CL_Size(width, height); }

        unsigned int get_pitch() const { return pitch; }

        void *get_data() { return data; }

        const void *get_data() const { return data; }


public:

        CL_PixelBufferRef get_subimage(const CL_Rect &rect) const;

        CL_PixelBuffer copy() const;

        void convert(CL_PixelBuffer target) const;

        void convert(void *buffer, const CL_PixelFormat &format, int dest_pitch,
                const CL_Rect &dest_rect, const CL_Rect &src_rect = CL_Rect(0,0,0,0)) const;

        void convert_line(void *buffer, const CL_PixelFormat &format, int y) const;

        CL_PixelBuffer to_format(const CL_PixelFormat &format) const;

private:
        CL_PixelFormat format;
        CL_Palette *palette;
        int width;
        int height;
        unsigned int pitch;
        void *data;
};

class CL_API_DISPLAY CL_PixelBuffer
{

public:
        CL_PixelBuffer();

        CL_PixelBuffer(const CL_PixelBufferRef &other);

        CL_PixelBuffer(int width, int height, int pitch, const CL_PixelFormat &format, const void *data = 0);

        CL_PixelBuffer(int width, int height, int pitch, const CL_PixelFormat &format, const CL_Palette &palette, const void *data = 0);

        CL_PixelBuffer(const CL_PixelBuffer &copy);

        CL_PixelBuffer(const CL_StringRef &fullname);

        CL_PixelBuffer(const CL_StringRef &filename, const CL_VirtualDirectory &dir);

        CL_PixelBuffer(CL_IODevice &file, const CL_String &image_type);

        virtual ~CL_PixelBuffer();


public:
        bool is_null() const;

        CL_PixelBuffer copy() const;

        const CL_PixelFormat &get_format() const;

        const CL_Palette *get_palette() const;

        int get_width() const;

        int get_height() const;

        CL_Size get_size() const;

        unsigned int get_pitch() const;

        void *get_data();

        const void *get_data() const;

        CL_Color get_pixel(int x, int y);

        CL_PixelBufferRef get_subimage(const CL_Rect &rect) const;


public:
        CL_PixelBuffer &operator =(const CL_PixelBuffer &copy);

        operator bool () const;

        void convert(CL_PixelBuffer target) const;

        void convert(void *buffer, const CL_PixelFormat &format, int dest_pitch,
                const CL_Rect &dest_rect, const CL_Rect &src_rect = CL_Rect(0,0,0,0)) const;

        void convert_line(void *buffer, const CL_PixelFormat &format, int y) const;

        CL_PixelBuffer to_format(const CL_PixelFormat &format) const;

        void set_colorkey(bool enabled, unsigned int colorkey);

        void draw_pixel(int x, int y, const CL_Colorf &color);

        void flip_vertical();


private:
        CL_SharedPtr<CL_PixelBuffer_Impl> impl;
};

---