Display.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef MACHINE_DISPLAY_H
#define MACHINE_DISPLAY_H

#include "pedigree/kernel/compiler.h"
#include "pedigree/kernel/graphics/Graphics.h"
#include "pedigree/kernel/machine/Device.h"
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/List.h"

class String;

class EXPORTED_PUBLIC Display : public Device
{
  public:
    struct rgb_t
    {
        uint8_t r, g, b, a;
    } PACKED;

    struct PixelFormat
    {
        uint8_t mRed;     
        uint8_t pRed;     
        uint8_t mGreen;   
        uint8_t pGreen;   
        uint8_t mBlue;    
        uint8_t pBlue;    
        uint8_t mAlpha;   
        uint8_t pAlpha;   
        uint8_t nBpp;     
        uint32_t nPitch;  
    };

    struct ScreenMode
    {
        ScreenMode();

        uint32_t id;
        uint32_t width;
        uint32_t height;
        uint32_t refresh;
        uintptr_t framebuffer;
        PixelFormat pf;

        Graphics::PixelFormat pf2;
        uint32_t bytesPerLine;
        uint32_t bytesPerPixel;

        bool textMode;  // is a text mode, not a graphics mode
    };

    Display();
    Display(Device *p);
    virtual ~Display();

    virtual Type getType();

    virtual void getName(String &str);

    virtual void dump(String &str);

    virtual void *getFramebuffer();

    virtual rgb_t *newBuffer();

    virtual void setCurrentBuffer(rgb_t *pBuffer);

    virtual void updateBuffer(
        rgb_t *pBuffer, size_t x1 = ~0UL, size_t y1 = ~0UL, size_t x2 = ~0UL,
        size_t y2 = ~0UL);

    virtual void killBuffer(rgb_t *pBuffer);

    virtual void bitBlit(
        rgb_t *pBuffer, size_t fromX, size_t fromY, size_t toX, size_t toY,
        size_t width, size_t height);

    virtual void fillRectangle(
        rgb_t *pBuffer, size_t x, size_t y, size_t width, size_t height,
        rgb_t colour);

    virtual bool getPixelFormat(PixelFormat &pf);

    virtual bool getCurrentScreenMode(ScreenMode &sm);

    virtual bool getScreenModes(List<ScreenMode *> &sms);

    virtual bool setScreenMode(ScreenMode sm);

    virtual bool setScreenMode(size_t modeId);

    virtual bool setScreenMode(size_t nWidth, size_t nHeight, size_t nBpp);
};

#endif