pixel_buffer_set.h

/*
**  UICore
**  Copyright (c) 1997-2015 The UICore 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 UICore may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/

#pragma once

#include <memory>
#include "../../Core/Math/rect.h"
#include "UICore/Display/Render/texture.h"
#include "texture_format.h"

namespace uicore
{
    class PixelBuffer;
    typedef std::shared_ptr<PixelBuffer> PixelBufferPtr;

    class PixelBufferSet
    {
    public:
        static std::shared_ptr<PixelBufferSet> create(TextureDimensions dimensions, TextureFormat format, int width, int height = 1, int slices = 1);

        static std::shared_ptr<PixelBufferSet> create(const PixelBufferPtr &image);

        virtual TextureDimensions dimensions() const = 0;

        virtual TextureFormat format() const = 0;

        virtual int width() const = 0;

        virtual int height() const = 0;

        virtual int slice_count() const = 0;

        virtual int base_level() const = 0;

        virtual int max_level() const = 0;

        virtual PixelBufferPtr image(int slice, int level) = 0;

        virtual void set_image(int slice, int level, const PixelBufferPtr &image) = 0;
    };

    typedef std::shared_ptr<PixelBufferSet> PixelBufferSetPtr;
}