Display.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 DC_DISPLAY_H_INCLUDED
#define DC_DISPLAY_H_INCLUDED

/* Display 

   An interface for displaying rendered data

*/
#include <string>
#include <Dynacoe/Backends/Backend.h>
#include <Dynacoe/Backends/Framebuffer/Framebuffer.h>

namespace Dynacoe {



class Display : public Backend {
  public:

    class ResizeCallback {
        public:
        virtual void operator()(int newWidth, int newHeight) = 0;
    };

    class CloseCallback {
        public:

        virtual void operator()(void) = 0;
    };

    virtual ~Display(){}




    enum class Capability {
        CanResize,      
        CanMove,        
        CanFullscreen,  
        CanHide,        
        CanLockSize     
    };

    enum class ViewPolicy {
        NoPolicy,       
        MatchSize,      
    };



    
    enum class DisplayHandleType {
        X11Display,     
        WINAPIHandle,   
        Unknown         
    };

    enum class DisplayEventType {
        X11Event,      
        WINAPIMsg,     
        Unknown        
        
    };
    
    virtual void Resize(int w, int h) = 0;

    virtual void SetPosition(int x, int y) = 0;

    virtual void Fullscreen(bool) = 0;

    virtual void Hide(bool) = 0;

    virtual bool HasInputFocus() = 0; 

    virtual void LockClientResize(bool) = 0;

    virtual void LockClientPosition(bool) = 0;

    virtual void SetViewPolicy(ViewPolicy) = 0;

    virtual int Width() = 0;

    virtual int Height() = 0;
    
    virtual int X() = 0;

    virtual int Y() = 0;


   
    virtual void SetName(const std::string &) = 0;

    virtual void AddResizeCallback(ResizeCallback *) = 0;

    virtual void RemoveResizeCallback(ResizeCallback *) = 0;

    virtual void AddCloseCallback(CloseCallback *) = 0;
    virtual void RemoveCloseCallback(CloseCallback *) = 0;



    virtual bool IsCapable(Capability) = 0; 



    // Interfacing with others


    virtual void AttachSource(Framebuffer *) = 0;
    
    virtual Framebuffer * GetSource() = 0;

    virtual void Update() = 0;    

    // Returns the framebuffer types that this renderer supports.
    // Should the framebuffer not match one of the given types, the framebuffer 
    // attachment will fail
    virtual std::vector<Dynacoe::Framebuffer::Type> SupportedFramebuffers() = 0;

    virtual DisplayHandleType GetSystemHandleType() = 0;

    virtual void * GetSystemHandle() = 0;
    
    virtual DisplayEventType GetSystemEventType() = 0;

    virtual void * GetLastSystemEvent() = 0;
    
    

};






}

#endif