Framebuffer.h

/*

Copyright (c) 2018, Johnathan Corkery. (jcorkery@umich.edu)
All rights reserved.

This file is part of the Dynacoe project (https://github.com/jcorks/Dynacoe)
Dynacoe was released under the MIT License, as detailed below.



Permission is hereby granted, free of charge, to any person obtaining a copy 
of this software and associated documentation files (the "Software"), to deal 
in the Software without restriction, including without limitation the rights 
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
copies of the Software, and to permit persons to whom the Software is furnished 
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall
be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
DEALINGS IN THE SOFTWARE.



*/

#ifndef H_DC_FRAMEBUFFER_INCLUDED
#define H_DC_FRAMEBUFFER_INCLUDED

#include <Dynacoe/Backends/Backend.h>
namespace Dynacoe {


class Framebuffer : public Backend {
  public:

    enum class Type {
        RGBA_PixelArray, 
        GLFBPacket,      
        Unknown,         
    };


    bool Resize(int newW, int newH) {
        if (!OnResize(data, newW, newH))
            return false;

        w = newW;
        h = newH;
        return true;
    }

    void * GetHandle() {return data;}

    int Width() {return w;}

    int Height() {return h;}

    Type GetHandleType() {return type;}

    virtual bool GetRawData(uint8_t *) = 0;

    void SetFilteredHint(bool filter) {if (filtered!=filter) {filtered=filter; OnFilterChange(filter);}}

    bool GetFilteredHint() {return filtered;}

  protected:
    // can only create new framebuffers from a direct constructor
    Framebuffer(Type type_, int w_, int h_, void * data_ ) :
        type(type_),
        w(w_),
        h(w_),
        data(data_),
        filtered(true)
            {}

    // called on resize event to actually perform the resize action
    // on the data.
    virtual bool OnResize(void * source, int newW, int newH) = 0;

    // Called when SetFilteredHint  is called
    virtual void OnFilterChange(bool) = 0;
  private:
    int w;
    int h;
    void * data;
    Type type;
    bool filtered;
};
}

#endif