canvas.h

Go to the documentation of this file.

/*
  Created by Fabrizio Di Vittorio (fdivitto2013@gmail.com) - <http://www.fabgl.com>
  Copyright (c) 2019-2022 Fabrizio Di Vittorio.
  All rights reserved.
 
 
* Please contact fdivitto2013@gmail.com if you need a commercial license.
 
 
* This library and related software is available under GPL v3.
 
  FabGL is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  FabGL is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with FabGL.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#pragma once
 
 
 
#include <stdint.h>
#include <stddef.h>
 
#include "displaycontroller.h"
 
 
namespace fabgl {
 
 
 
class Canvas {
 
public:
 
  Canvas(BitmappedDisplayController * displayController);
 
  int getWidth() { return m_displayController->getViewPortWidth(); }
 
  int getHeight() { return m_displayController->getViewPortHeight(); }
 
  void waitCompletion(bool waitVSync = true);
 
  void beginUpdate();
 
  void endUpdate();
 
  void swapBuffers();
 
  void setOrigin(int X, int Y);
 
  void setOrigin(Point const & origin);
 
  Point getOrigin() { return m_origin; }
 
  void setClippingRect(Rect const & rect);
 
  Rect getClippingRect();
 
 
  void clear();
 
  void reset();
 
  void setScrollingRegion(int X1, int Y1, int X2, int Y2);
 
  void scroll(int offsetX, int offsetY);
 
  void moveTo(int X, int Y);
 
  void setPenColor(uint8_t red, uint8_t green, uint8_t blue);
 
  void setPenColor(Color color);
 
  void setPenColor(RGB888 const & color);
 
  void setBrushColor(uint8_t red, uint8_t green, uint8_t blue);
 
  void setBrushColor(Color color);
 
  void setBrushColor(RGB888 const & color);
 
  void setPenWidth(int value);
 
  void setLineEnds(LineEnds value);
 
  void setPixel(int X, int Y);
 
  void setPixel(int X, int Y, RGB888 const & color);
 
  void setPixel(Point const & pos, RGB888 const & color);
 
  void lineTo(int X, int Y);
 
  void drawLine(int X1, int Y1, int X2, int Y2);
 
  void drawRectangle(int X1, int Y1, int X2, int Y2);
 
  void drawRectangle(Rect const & rect);
 
  void fillRectangle(int X1, int Y1, int X2, int Y2);
 
  void fillRectangle(Rect const & rect);
 
  void invertRectangle(int X1, int Y1, int X2, int Y2);
 
  void invertRectangle(Rect const & rect);
 
  void swapRectangle(int X1, int Y1, int X2, int Y2);
 
  void drawEllipse(int X, int Y, int width, int height);
 
  void fillEllipse(int X, int Y, int width, int height);
 
  void drawGlyph(int X, int Y, int width, int height, uint8_t const * data, int index = 0);
 
  void setGlyphOptions(GlyphOptions options);
 
  void resetGlyphOptions();
 
  void renderGlyphsBuffer(int itemX, int itemY, GlyphsBuffer const * glyphsBuffer);
 
  void setPaintOptions(PaintOptions options);
 
  void resetPaintOptions();
 
  FontInfo const * getFontInfo() { return m_fontInfo; }
 
  void selectFont(FontInfo const * fontInfo);
 
  void drawChar(int X, int Y, char c);
 
  void drawText(int X, int Y, char const * text, bool wrap = false);
 
  void drawText(FontInfo const * fontInfo, int X, int Y, char const * text, bool wrap = false);
 
  void drawTextWithEllipsis(FontInfo const * fontInfo, int X, int Y, char const * text, int maxX);
 
  int textExtent(FontInfo const * fontInfo, char const * text);
 
  int textExtent(char const * text);
 
  void drawTextFmt(int X, int Y, const char *format, ...);
 
  void copyRect(int sourceX, int sourceY, int destX, int destY, int width, int height);
 
  void drawBitmap(int X, int Y, Bitmap const * bitmap);
 
  void drawPath(Point const * points, int pointsCount);
 
  void fillPath(Point const * points, int pointsCount);
 
  RGB888 getPixel(int X, int Y);
 
private:
 
  BitmappedDisplayController * m_displayController;
 
  FontInfo const *    m_fontInfo;
  uint8_t             m_textHorizRate; // specify character size: 1 = m_fontInfo.width, 2 = m_fontInfo.width * 2, etc...
 
  Point               m_origin;
  Rect                m_clippingRect;
};
 
 
} // end of namespace